在 Flutter 项目中使用 MQTT

Z时代
2024-01-10
分类：技术分享

Flutter 是 Google 推出并开源的移动应用开发框架，主打跨平台、高保真、高性能。开发者可以通过 Dart 语言开发 App，一套代码同时运行在 iOS 和 Android 平台。 Flutter 提供了丰富的组件、接口，开发者可以快速地为 Flutter 添加 native 扩展。同时 Flutter 还使用 Native 引擎渲染视图，这无疑能为用户提供良好的体验。

MQTT 是一种基于发布/订阅模式的轻量级物联网消息传输协议，可在严重受限的硬件设备和低带宽、高延迟的网络上实现稳定传输。它凭借简单易实现、支持 QoS、报文小等特点，占据了物联网协议的半壁江山。

本文主要介绍如何在 Flutter 项目中使用 MQTT，实现客户端与 MQTT 服务器的连接、订阅、取消订阅、收发消息等功能。

项目初始化

新建项目

新建一个项目，可以参考以下链接：

Set up an editor

Android Studio and IntelliJ

安装依赖

添加依赖到 pubspec.yaml 文件中

dependencies:mqtt_client: ^7.2.1

安装依赖：

flutter pub get

导入

import 'package:mqtt_client/mqtt_client.dart';

MQTT 的使用

连接 MQTT 服务器

本文将使用 EMQ X 提供的免费公共 MQTT 服务器，该服务基于 EMQ X 的 MQTT 物联网云平台创建。服务器接入信息如下：

Broker: broker.emqx.io

TCP Port: 1883

Websocket Port: 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;}

回调方法说明

// 连接成功
void onConnected() {
print('Connected');
}
// 连接断开
void onDisconnected() {
print('Disconnected');
}
// 订阅主题成功
void onSubscribed(String topic) {
print('Subscribed topic: $topic');
}
// 订阅主题失败
void onSubscribeFail(String topic) {
print('Failed to subscribe $topic');
}
// 成功取消订阅
void onUnsubscribed(String topic) {
print('Unsubscribed topic: $topic');
}
// 收到 PING 响应
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);