Flutter MQTT代理插件dart_mqtt_broker的使用

MQTT代理插件dart_mqtt_broker简介

本项目使用Dart实现了一个支持可选SSL/TLS加密的MQTT代理。该代理轻量级、可定制，并符合MQTT协议规范。

特性

• MQTT协议支持：实现了核心MQTT协议功能。
• TLS/SSL支持：使用自签名或CA签名证书提供安全连接。
• 动态事件处理：为常见MQTT动作（如onConnect、onPublish、onSubscribe等）提供了可定制的钩子。
• 保留消息：支持主题的保留消息。
• 服务质量级别：实现服务质量等级0、1和2。
• 遗嘱和宣告：确保客户端断开连接的消息得到处理。
• 通配符主题：支持包含+和#通配符的主题过滤器。

未来功能

以下功能可以考虑在未来进行开发：

• MQTT版本5.0支持：

  • 用户属性：允许自定义MQTT消息的元数据。
  • 会话过期：处理会话过期间隔。
  • 原因码：在确认中包含原因码。

• 集群部署：

  • 支持水平扩展，使用多个节点。
  • 分布式会话和主题管理。

• 增强认证：

  • 支持基于用户名/密码的认证。
  • 集成OAuth2、JWT或其他外部认证提供商。

• WebSocket支持：

  • 允许Web客户端通过WebSocket连接MQTT。

• 消息持久化：

  • 将发布的消息存储到数据库以提高可靠性。
  • 支持向新订阅者重播消息。

• 监控和指标：

  • 实时监控连接的客户端和主题。
  • 消息吞吐量、延迟和资源使用的指标。

• 高级访问控制：

  • 客户端基于主题的访问权限。
  • 与ACL（访问控制列表）系统集成。

• 管理HTTP API：

  • RESTful API用于管理客户端、主题和代理设置。

系统需求

• Dart SDK (>=2.12)

安装

1. 克隆仓库：

   git clone https://github.com/mskayali/dart_mqtt_broker.git
   cd mqtt-broker-dart
   

2. 安装依赖：

   dart pub get
   

使用

启动代理

代理可以在不安全（TLS）模式或安全模式下运行。

不安全模式

void main() {
  final broker = MQTTBroker(host: '0.0.0.0', port: 1883);
  broker.start();
}

安全模式

void main() {
  final broker = MQTTBroker(
    host: '0.0.0.0',
    port: 8883,
    certificatePath: 'path/to/certificate.pem',
    privateKeyPath: 'path/to/private.key',
  );
  broker.start();
}

事件钩子

代理为常见的MQTT操作提供了事件钩子：

void main() {
  final broker = MQTTBroker(port: 1883);

  // 注册事件处理器
  broker.events.onConnect((client) => print('Client connected: $client'));
  broker.events.onPublish((client, data) => print('Publish received: $data'));
  broker.events.onSubscribe((client, data) => print('Subscription: $data'));
  broker.events.onUnsubscribe((client, data) => print('Unsubscription: $data'));
  broker.events.onPing((client) => print('Ping received'));
  broker.events.onDisconnect((client) => print('Client disconnected: $client'));
  broker.events.onWill((client, topic, message) {
    print('Last Will from $client: $topic -> $message');
  });

  broker.start();
}

证书设置

生成自签名证书

1. 生成私钥：

   openssl genrsa -out private.key 2048
   

2. 生成自签名证书：

   openssl req -new -x509 -key private.key -out certificate.pem -days 365
   

使用证书

• 将certificate.pem和private.key放置在你的项目目录中。
• 在初始化代理时提供它们的路径。

测试

运行单元测试

dart test

使用MQTT客户端连接

使用任何MQTT客户端连接到代理：

不安全连接

mosquitto_pub -h localhost -p 1883 -t test/topic -m "Hello World"

安全连接

mosquitto_pub --cafile certificate.pem -h localhost -p 8883 -t test/topic -m "Hello Secure World"

文件结构

├── handlers/          # 包含连接、发布等包处理器
├── models/            # 核心模型（客户端、主题、事件广播器）
├── test/              # 单元测试
├── main.dart          # 示例入口点
├── broker.dart        # 主代理实现
└── README.md          # 项目文档