FlutterプロジェクトでMQTT
Zhiwei Yu
目次
Flutterは、GoogleのUIツールキットで、1つのコードベースからモバイル、Web、デスクトップの美しいネイティブコンパイルアプリケーションを構築できます。Flutterは豊富なコンポーネントとインターフェースを提供し、開発者はFlutterのネイティブ拡張をすぐに追加できます。同時に、Flutterはネイティブエンジンも使用してビューをレンダリングします。ユーザー体験を良好に提供できることは間違いありません。
MQTTは、パブリッシュ/サブスクライブモデルに基づく軽量IoT通信プロトコルです。厳しく制限されたデバイスハードウェアと高レイテンシー/低帯域幅ネットワークでも安定した転送が可能です。シンプルで実装が容易で、QoSをサポートし、パケットサイズが小さいため、IoTプロトコル市場の半分を占めています。
この記事では、主にFlutterプロジェクトでMQTTを使用して、クライアントとMQTTブローカーの接続、サブスクライブ、アンサブスクライブ、メッセージの送受信などの機能の実装方法を紹介します。
プロジェクトの初期化
プロジェクトの作成
新しいプロジェクトを作成することができます。以下のリンクを参照してください。
依存関係のインストール
pubspec.yamlファイルに依存関係を追加します。
dependencies:
mqtt_client: ^7.2.1
依存関係をインストール:
flutter pub get
インポート
import 'package:mqtt_client/mqtt_client.dart';
MQTTの使用
MQTTブローカーへの接続
この記事では、EMQX Cloudによって運用・管理されているMQTTブローカーを使用します。 EMQX Cloudは、EMQによってリリースされたMQTT IoTクラウドサービスプラットフォームで、オールインワンの運用・保守とユニークな分離環境でのMQTT 5.0へのアクセスサービスを提供します。
- ブローカー:
broker.emqx.io - TCPポート: 1883
- Websocketポート: 8083
接続の例
Future<MqttServerClient> connect() async {
MqttServerClient client =
MqttServerClient.withPort('broker.emqx.io', 'flutter_client', 1883);
client.logging(on: true);
client.onConnected = onConnected;
client.onDisconnected = onDisconnected;
client.onUnsubscribed = onUnsubscribed;
client.onSubscribed = onSubscribed;
client.onSubscribeFail = onSubscribeFail;
client.pongCallback = pong;
final connMessage = MqttConnectMessage()
.authenticateAs('username', 'password')
.keepAliveFor(60)
.withWillTopic('willtopic')
.withWillMessage('Will message')
.startClean()
.withWillQos(MqttQos.atLeastOnce);
client.connectionMessage = connMessage;
try {
await client.connect();
} catch (e) {
print('Exception: $e');
client.disconnect();
}
client.updates.listen((List<MqttReceivedMessage<MqttMessage>> c) {
final MqttPublishMessage message = c[0].payload;
final payload =
MqttPublishPayload.bytesToStringAsString(message.payload.message);
print('Received message:$payload from topic: ${c[0].topic}>');
});
return client;
}
コールバックメソッドの説明
// connection succeeded
void onConnected() {
print('Connected');
}
// unconnected
void onDisconnected() {
print('Disconnected');
}
// subscribe to topic succeeded
void onSubscribed(String topic) {
print('Subscribed topic: $topic');
}
// subscribe to topic failed
void onSubscribeFail(String topic) {
print('Failed to subscribe $topic');
}
// unsubscribe succeeded
void onUnsubscribed(String topic) {
print('Unsubscribed topic: $topic');
}
// PING response received
void pong() {
print('Ping response client callback invoked');
}
MqttConnectMessage: タイムアウトの設定、認証、ラストウィルメッセージなど、接続オプションを設定します。
client.updates.listen: サブスクライブしたトピックのメッセージの到着を監視するために使用されます。
証明書接続の例
/// Security context
SecurityContext context = new SecurityContext()
..useCertificateChain('path/to/my_cert.pem')
..usePrivateKey('path/to/my_key.pem', password: 'key_password')
..setClientAuthorities('path/to/client.crt', password: 'password');
client.secure = true;
client.securityContext = context;
その他のMQTT操作
トピックのサブスクライブ
client.subscribe("topic/test", MqttQos.atLeastOnce)
メッセージのパブリッシュ
const pubTopic = 'topic/test';
final builder = MqttClientPayloadBuilder();
builder.addString('Hello MQTT');
client.publishMessage(pubTopic, MqttQos.atLeastOnce, builder.payload);
アンサブスクライブ
client.unsubscribe('topic/test');
切断
client.disconnect();
テスト
このプロジェクトのために、シンプルなUIインターフェースを記述し、MQTT 5.0クライアントツール - MQTTXを使用して、以下のテストを行います。
- 接続
- サブスクライブ
- パブリッシュ
- アンサブスクライブ
- 切断
アプリケーションのインターフェース:
MQTTXを別のクライアントとして使用して、メッセージの送受信を行う:
プロセス全体のログが表示されているのがわかります。
まとめ
これまで、Flutterを使用してAndroidプラットフォームでMQTTアプリケーションを構築し、クライアントとMQTTブローカーの接続、サブスクライブ、アンサブスクライブ、パブリッシュ、メッセージの受信などを実装してきました。
Flutterは、統一されたプログラミング言語とクロスプラットフォームの機能により、強力なモバイルアプリケーションを簡単に開発できるようにします。これは、モバイルアプリケーションを開発するための最適なソリューションになる可能性があります。 Flutter、MQTTプロトコル、MQTTクラウドサービスを使用することで、より面白いアプリケーションを開発できます。
次に、EMQXが提供するMQTTプロトコルのわかりやすいガイドの記事シリーズをチェックして、MQTTプロトコルの機能を学習し、MQTTのさらに高度なアプリケーションを探求し、MQTTアプリケーションとサービスの開発を開始してください。