NewLife.MQTT 3.1.2026.602

NewLife.MQTT — 纯国产 MQTT 协议完整实现

NewLife.MQTT 是一款纯国产自主研发、零第三方依赖、MIT 开源的 MQTT 完整协议实现，以单一 NuGet 包同时提供功能完整的 MqttClient 客户端和高性能 MqttServer 服务端（Broker），覆盖 .NET Framework 4.5 至 .NET 10 全部主流运行时。

核心特性

差异化优势

MQTT over QUIC（业界罕见）

目前仅 EMQX 和 NewLife.MQTT 支持此传输方式：

• 低延迟、无队头阻塞，适合弱网和移动场景
• .NET 7/8 需启用预览特性，.NET 9+ 稳定可用
• 默认端口 14567，ALPN 标识 "mqtt"

MQTT over 可靠 UDP（业界独创）

全球独创，无需操作系统 msquic 支持，全平台可用：

• 自研 4 字节帧头 + 序列号 + ACK 确认 + 超时重发
• 覆盖 ARM Linux 4.x 等不支持 msquic 的嵌入式平台

断线后自动重订阅

MQTTnet / Eclipse Paho 断线重连后需要用户手动重新订阅，NewLife.MQTT 自动完成：

await client.SubscribeAsync("/device/+/data", e =>
    XTrace.WriteLine($"{e.Topic}: {e.Payload.ToStr()}"));
// 重连后无需任何额外代码，订阅自动恢复

企业功能内置免费

• 消息桥接：In / Out / Both 三种方向，主题前缀映射，QoS 上限控制
• 规则引擎：5 种动作（Republish / WebHook / Bridge / Drop / Custom）
• WebHook：6 种事件异步推送，失败自动重试
• 集群：跨节点订阅同步与消息转发，独立 RPC 端口（2883）
• $SYS 系统主题：14 种标准主题，实时运行统计
• ProxyProtocol v1/v2：nginx/HAProxy 透传真实客户端 IP

快速开始

安装

dotnet add package NewLife.MQTT

启动服务端

var services = ObjectContainer.Current;
services.AddSingleton<ILog>(XTrace.Log);
services.AddTransient<IMqttHandler, MqttHandler>();
services.AddSingleton<MqttExchange, MqttExchange>();

var server = new MqttServer
{
    Port = 1883,
    ServiceProvider = services.BuildServiceProvider(),
    Log = XTrace.Log,
};
server.Start();

连接客户端

var client = new MqttClient
{
    Log = XTrace.Log,
    Server = "tcp://127.0.0.1:1883",
    ClientId = Guid.NewGuid().ToString(),
};
await client.ConnectAsync();

// 订阅（重连后自动重订阅）
await client.SubscribeAsync("/test/#", e =>
    XTrace.WriteLine($"{e.Topic}: {e.Payload.ToStr()}"));

// 发布
await client.PublishAsync("/test/hello", "Hello MQTT");

连接字符串初始化

var client = new MqttClient();
client.Init("Server=tcp://127.0.0.1:1883;UserName=admin;Password=secret;ClientId=myDevice");
await client.ConnectAsync();

客户端详细用法

指定协议版本

var client = new MqttClient
{
    Server = "tcp://127.0.0.1:1883",
    ClientId = "myDevice",
    Version = MqttVersion.V500,   // V310 / V311（默认）/ V500
};

QoS 发布

await client.PublishAsync("/sensor/temp", "25.6");                                 // QoS 0
await client.PublishAsync("/sensor/temp", "25.6", QualityOfService.AtLeastOnce);  // QoS 1
await client.PublishAsync("/sensor/temp", "25.6", QualityOfService.ExactlyOnce);  // QoS 2

QoS 服务质量说明

发布 QoS 和订阅 QoS 取较小值作为消费 QoS：

通配符订阅

await client.SubscribeAsync("/device/+/data", handler);   // + 匹配单层
await client.SubscribeAsync("/device/#", handler);        // # 匹配多层

共享订阅（负载均衡）

格式 $share/{group}/{topic}，同组多消费者轮询分发：

await client.SubscribeAsync("$share/workers/orders/new", e =>
    XTrace.WriteLine($"收到: {e.Payload.ToStr()}"));

TLS / WebSocket / QUIC

new MqttClient { Server = "ssl://broker.example.com:8883" };           // TLS
new MqttClient { Server = "ws://broker.example.com:8083" };            // WebSocket
new MqttClient { Server = "wss://broker.example.com:8084" };           // WSS
new MqttClient { Server = "quic://broker.example.com:14567" };         // QUIC (.NET 7+)

服务端详细用法

自定义处理器

继承 MqttHandler 拦截各类消息，适合 IoT 平台直接落库：

public class MyHandler : MqttHandler
{
    private readonly ILog _log;

    public MyHandler(ILog log) => _log = log;

    protected override ConnAck OnConnect(ConnectMessage message)
    {
        _log.Info("连接[{0}] user={1} clientId={2}",
            Session.Remote.EndPoint, message.Username, message.ClientId);
        return base.OnConnect(message);
    }

    protected override MqttMessage OnDisconnect(DisconnectMessage message)
    {
        _log.Info("断开[{0}]", Session.Remote);
        return base.OnDisconnect(message);
    }

    protected override MqttIdMessage OnPublish(PublishMessage message)
    {
        _log.Info("[{0} QoS={1}] {2}", message.Topic, (Int32)message.QoS, message.Payload.ToStr());
        return base.OnPublish(message);
    }
}

services.AddTransient<IMqttHandler, MyHandler>();

自定义认证（ACL）

public class MyAuthenticator : IMqttAuthenticator
{
    public Boolean Authenticate(String clientId, String username, String password)
        => username == "admin" && password == "secret";

    public Boolean AuthorizePublish(String clientId, String topic)
        => !topic.StartsWith("$SYS/");

    public Boolean AuthorizeSubscribe(String clientId, String topic) => true;
}

services.AddSingleton<IMqttAuthenticator, MyAuthenticator>();

企业功能

消息桥接

var bridge = new MqttBridge
{
    Name = "to-cloud",
    Server = "tcp://cloud-broker.example.com:1883",
    Direction = BridgeDirection.Both,
    TopicPrefix = "edge/factory1/",
    MaxQoS = QualityOfService.AtLeastOnce,
};
bridge.Start();

规则引擎

var engine = new MqttRuleEngine();
engine.AddRule(new MqttRule
{
    TopicFilter = "/sensor/+/temperature",
    Action = RuleAction.Republish,
    TargetTopic = "/analytics/temperature",
});
engine.AddRule(new MqttRule
{
    TopicFilter = "/alarm/#",
    Action = RuleAction.WebHook,
    WebHookUrl = "https://api.example.com/alarm",
});

集群部署

三节点集群配置（每节点配置其他节点地址）：

var cluster = new ClusterServer
{
    Nodes = new[] { "192.168.1.11:2883", "192.168.1.12:2883" },
    ClusterPort = 2883,
};
cluster.Start();
services.AddSingleton<IMqttExchange, ClusterExchange>();

集群操作：Join 加入（启动时）→ Ping 保活（15 秒）→ Lease 离开（停止时），超时节点（5 分钟）自动剔除。

阿里云 IoT 适配

var client = new AliyunMqttClient
{
    ProductKey = "a1xxxxxxxx",
    DeviceName = "myDevice",
    DeviceSecret = "xxxxxxxx",
};
await client.ConnectAsync();
await client.PublishPropertyAsync(new { temperature = 25.6 });

快速体验

打开源码，将 Test 设为启动项目，即同时运行 Server 和 Client：

核心特点

差异化优势

1. MQTT over QUIC（业界罕见）

• 仅 EMQX 和 NewLife.MQTT 支持
• 低延迟、无队头阻塞
• .NET 7+ 平台可用（.NET 7/8 需启用预览特性，.NET 9+ 为稳定版本）

2. MQTT over 可靠 UDP（独创自研）

• 业界独有
• 4字节帧头 + 序列号 + Ack确认 + 超时重发
• 无需操作系统 QUIC/msquic 支持，全平台可用

3. 企业功能内置免费

• 消息桥接（双向）： 支持 In/Out/Both 三种方向，主题前缀映射，QoS 上限控制
• 规则引擎（5种动作）： Republish / WebHook / Bridge / Drop / Custom
• WebHook 事件推送： 6种事件，异步非阻塞，支持重试
• 集群支持： 手动配置节点，跨节点订阅同步与消息转发
• ProxyProtocol： 支持 nginx/HAProxy 代理协议 v1/v2，透传真实客户端 IP
• $SYS 系统主题： 14种标准主题，实时运行统计

4. 重连后自动重订阅

竞品（MQTTnet / Eclipse Paho）断线重连后需要用户手动重新订阅，NewLife.MQTT 自动完成。

5. 阿里云 IoT 内置适配

AliyunMqttClient 开箱即用，HMAC 签名认证 + 属性上报 + 时钟同步。

MQTT 协议

最流行的物联网通信协议MQTT，包括客户端、服务端和Web管理平台。

提供订阅/发布模式，更为简约、轻量，易于使用，针对受限环境（带宽低、网络延迟高、网络通信不稳定），可以简单概括为物联网打造，官方总结特点如下：

1. 使用发布/订阅消息模式，提供一对多的消息发布，解除应用程序耦合。
2. 对负载内容屏蔽的消息传输。
3. 使用 TCP/IP 提供网络连接。
4. 有三种消息发布服务质量：
   “至多一次”，消息发布完全依赖底层 TCP/IP 网络。会发生消息丢失或重复。这一级别可用于如下情况，环境传感器数据，丢失一次读记录无所谓，因为不久后还会有第二次发送。
   “至少一次”，确保消息到达，但消息重复可能会发生。
   “只有一次”，确保消息到达一次。这一级别可用于如下情况，在计费系统中，消息重复或丢失会导致不正确的结果。
5. 小型传输，开销很小（固定长度的头部是 2 字节），协议交换最小化，以降低网络流量。
6. 使用 Last Will 和 Testament 特性通知有关各方客户端异常中断的机制。

MQTT 发布与订阅

发布时，指定消息Qos，broker保存的消息包含了Qos；
订阅时，指定这次订阅要求的Qos，broker回复授权使用的Qos，一般就是申请那个；
消费时，消息的Qos取发布订阅中较小者！

详细场景：

• 订阅Qos=0，不管发布什么消息，消费到的消息Qos都是0；
• 订阅Qos=1，发布消息Qos=0时，消费得到Qos=0，发布消息Qos=1或2时，消费得到Qos=1；
• 订阅Qos=2，消费得到的消息Qos，就是发布时的Qos；
• 发布Qos=0，broker不做任何答复，理论上中途丢了都不知道，但是因为Tcp，如果网络异常客户端能发现；
• 发布Qos=1，broker答复PubAck，表示已经收到消息；
• 发布Qos=2，broker答复PubRec，客户端再次发送PubRel，broker答复PubComp，消息才算发布完成；
• 订阅Qos=2，broker推送Qos=2消息，客户端先回PubRec，broker再次发送PubRel，客户端答复PubComp，消息才算消费完成；
• 发布Qos=2消息时，双重确认流程不需要等消费端在线，仅限于发布者与broker之间即可完成。

快速尝鲜

打开源码解决方案，把Test设为启动项目，启动即可。
默认先后启动TestServer和TestClient。

服务端

Nuget引用NewLife.MQTT，使用以下代码启动服务端：

var services = ObjectContainer.Current;
services.AddSingleton<ILog>(XTrace.Log);
services.AddTransient<IMqttHandler, MqttHandler>();
services.AddSingleton<MqttExchange, MqttExchange>();

var server = new MqttServer
{
    Port = 1883,
    ServiceProvider = services.BuildServiceProvider(),

    Log = XTrace.Log,
    SessionLog = XTrace.Log,
};
server.Start();

通过指定端口1883，默认处理器MqttHandler，默认交换机MqttExchange，启动服务端。

客户端

Nuget引用NewLife.MQTT，使用以下代码连接服务端：

var client = new MqttClient
{
    Log = XTrace.Log,
    Server = "tcp://127.0.0.1:1883",
    //UserName = "admin",
    //Password = "admin",
    ClientId = Guid.NewGuid() + "",
};

await client.ConnectAsync().ConfigureAwait(false);

// 订阅“/test”主题
var rt = await client.SubscribeAsync("/test", (e) =>
{
    XTrace.WriteLine("收到消息:" + "/test/# =>" + e.Topic + ":" + e.Payload.ToStr());
}).ConfigureAwait(false);

// 每2秒向“/test”主题发布一条消息
while (true)
{
    try
    {
        var msg = "学无先后达者为师" + Rand.NextString(8);
        await client.PublishAsync("/test", msg).ConfigureAwait(false);
    }
    catch (Exception ex)
    {
        XTrace.WriteException(ex);
    }
    await Task.Delay(2000).ConfigureAwait(false);
}

客户端连接服务端有几个要素：服务端地址、用户名、密码、客户端标识，然后通过ConnectAsync连接服务端。
客户端可以是消费者角色，通过SubscribeAsync订阅指定Topic。
客户端也可以是生产者角色，通过PublishAsync发布消息到指定Topic。

共享订阅（EMQX）

支持EMQX共享订阅功能，多个客户端可以订阅同一个共享主题，MQTT代理会将消息负载均衡地分发给订阅者。
共享订阅的格式为：$share/{group}/{topic}，其中{group}是共享组名，{topic}是实际的主题过滤器。

// 订阅共享主题，多个客户端订阅同一个共享组，消息会被负载均衡
await client.SubscribeAsync("$share/group1/Yh/Drive/+/OrderLock", (e) =>
{
    XTrace.WriteLine($"收到共享订阅消息: {e.Topic} => {e.Payload.ToStr()}");
}).ConfigureAwait(false);

// 发布消息到实际主题（不包含$share前缀）
await client.PublishAsync("Yh/Drive/1111/OrderLock", "订单锁定").ConfigureAwait(false);

共享订阅的优势：

• 负载均衡：同一共享组内的多个订阅者会均衡接收消息
• 水平扩展：可以通过增加订阅者来提高消息处理能力
• 高可用性：某个订阅者故障时， 其他订阅者仍可继续处理消息

指定MQTT协议版本

从2.3.2025.0212版本开始，客户端支持指定MQTT协议版本。可以通过Version属性设置协议版本，支持MQTT 3.1、3.1.1和5.0：

var client = new MqttClient
{
    Log = XTrace.Log,
    Server = "tcp://127.0.0.1:1883",
    ClientId = Guid.NewGuid() + "",
    Version = MqttVersion.V500, // 指定MQTT 5.0版本
};

支持的版本有：

• MqttVersion.V310 - MQTT 3.1
• MqttVersion.V311 - MQTT 3.1.1（默认）
• MqttVersion.V500 - MQTT 5.0

注意：如果不显式设置Version属性，客户端默认使用MQTT 3.1.1版本，保持向后兼容。

自定义服务端

需要在服务端处理客户端连接和消息交互逻辑时，就需要自定义服务端。例如IoT平台，在收到设备上报MQTT数据以后，直接接收落库，而不需要再次消费。
自定义处理器示例如下：

private class MyHandler : MqttHandler
{
    private readonly ILog _log;

    public MyHandler(ILog log) => _log = log;

    protected override ConnAck OnConnect(ConnectMessage message)
    {
        _log.Info("客户端[{0}]连接 user={1} pass={2} clientId={3}", Session.Remote.EndPoint, message.Username, message.Password, message.ClientId);

        return base.OnConnect(message);
    }

    protected override MqttMessage OnDisconnect(DisconnectMessage message)
    {
        _log.Info("客户端[{0}]断开", Session.Remote);

        return base.OnDisconnect(message);
    }

    protected override MqttIdMessage OnPublish(PublishMessage message)
    {
        _log.Info("客户端[{0}]发布[{1}:qos={2}]: {3}", Session.Remote, message.Topic, (Int32)message.QoS, message.Payload.ToStr());

        return base.OnPublish(message);
    }
}

稍微修改一下服务端注入处理器的代码即可使用自定义处理器：

var services = ObjectContainer.Current;
services.AddSingleton<ILog>(XTrace.Log);
services.AddTransient<IMqttHandler, MyHandler>();
services.AddSingleton<MqttExchange, MqttExchange>();

var server = new MqttServer
{
    Port = 1883,
    ServiceProvider = services.BuildServiceProvider(),

    Log = XTrace.Log,
    SessionLog = XTrace.Log,
};
server.Start();

集群

集群管理，Join、Ping、Lease。
Join加入集群，告诉对方我是集群节点之一，启动时调用N-1次。
每15秒Ping一次所有节点，更新活跃时间。
Lease离开集群，调用N-1次。
每个节点根据最后活跃时间，定时剔除超时节点。

新生命项目矩阵

各项目默认支持net9.0/netstandard2.1/netstandard2.0/net4.62/net4.5，旧版（2024.0801）支持net4.0/net2.0

新生命开发团队

新生命团队（NewLife）成立于2002年，是新时代物联网行业解决方案提供者，致力于提供软硬件应用方案咨询、系统架构规划与开发服务。
团队主导的80多个开源项目已被广泛应用于各行业，Nuget累计下载量高达400余万次。
团队开发的大数据中间件NewLife.XCode、蚂蚁调度计算平台AntJob、星尘分布式平台Stardust、缓存队列组件NewLife.Redis以及物联网平台FIoT，均成功应用于电力、高校、互联网、电信、交通、物流、工控、医疗、文博等行业，为客户提供了大量先进、可靠、安全、高质量、易扩展的产品和系统集成服务。

我们将不断通过服务的持续改进，成为客户长期信赖的合作伙伴，通过不断的创新和发展，成为国内优秀的IoT服务供应商。

新生命团队始于2002年，部分开源项目具有20年以上漫长历史，源码库保留有2010年以来所有修改记录
网站：https://newlifex.com
开源：https://github.com/newlifex
QQ群：1600800/1600838
微信公众号：