NewLife.MQTT 2.0.2024.1013-beta0757

This is a prerelease version of NewLife.MQTT.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package NewLife.MQTT --version 2.0.2024.1013-beta0757                
NuGet\Install-Package NewLife.MQTT -Version 2.0.2024.1013-beta0757                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NewLife.MQTT" Version="2.0.2024.1013-beta0757" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NewLife.MQTT --version 2.0.2024.1013-beta0757                
#r "nuget: NewLife.MQTT, 2.0.2024.1013-beta0757"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install NewLife.MQTT as a Cake Addin
#addin nuget:?package=NewLife.MQTT&version=2.0.2024.1013-beta0757&prerelease

// Install NewLife.MQTT as a Cake Tool
#tool nuget:?package=NewLife.MQTT&version=2.0.2024.1013-beta0757&prerelease                

NewLife.MQTT - MQTT协议

GitHub top language GitHub License Nuget Downloads Nuget Nuget (with prereleases)

MQTT协议是物联网领域最流行的通信协议!
NewLife.MQTT包含了MQTT的完整实现,并实现了客户端MqttClient,以及服务端MqttServer
其中MqttServer仅实现基本网络框架,支持消息收发,完整的消息交换功能位于商用版IoT平台FIoT中。

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。
Demo

服务端

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();

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

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

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

自定义服务端

需要在服务端处理客户端连接和消息交互逻辑时,就需要自定义服务端。例如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次。
每个节点根据最后活跃时间,定时剔除超时节点。

新生命项目矩阵

各项目默认支持net8.0/net7.0/netstandard2.1/netstandard2.0/net4.61,旧版(2022.1225)支持net4.5/net4.0/net2.0

项目 年份 说明
基础组件 支撑其它中间件以及产品项目
NewLife.Core 2002 核心库,日志、配置、缓存、网络、序列化、APM性能追踪
NewLife.XCode 2005 大数据中间件,单表百亿级,MySql/SQLite/SqlServer/Oracle/TDengine/达梦,自动分表
NewLife.Net 2005 网络库,单机千万级吞吐率(2266万tps),单机百万级连接(400万Tcp)
NewLife.Remoting 2011 RPC通信框架,内网高吞吐或物联网硬件设备场景
NewLife.Cube 2010 魔方快速开发平台,集成了用户权限、SSO登录、OAuth服务端等,单表100亿级项目验证
NewLife.Agent 2008 服务管理组件,把应用安装成为操作系统守护进程,Windows服务、Linux的Systemd
NewLife.Zero 2020 Zero零代脚手架,基于NewLife组件生态的项目模板,Web、WebApi、Service
中间件 对接知名中间件平台
NewLife.Redis 2017 Redis客户端,微秒级延迟,百万级吞吐,丰富的消息队列,百亿级数据量项目验证
NewLife.RocketMQ 2018 RocketMQ纯托管客户端,支持Apache RocketMQ和阿里云消息队列,十亿级项目验
NewLife.MQTT 2019 物联网消息协议,MqttClient/MqttServer,客户端支持阿里云物联网
NewLife.IoT 2022 IoT标准库,定义物联网领域的各种通信协议标准规范
NewLife.Modbus 2022 ModbusTcp/ModbusRTU/ModbusASCII,基于IoT标准库实现,支持IoT平台和IoTEdge
NewLife.Siemens 2022 西门子PLC协议,基于IoT标准库实现,支持IoT平台和IoTEdge
NewLife.Map 2022 地图组件库,封装百度地图、高德地图和腾讯地图
NewLife.IP 2022 IP地址库,IP地址转物理地址
产品平台 产品平台级,编译部署即用,个性化自定义
AntJob 2019 蚂蚁调度,分布式大数据计算平台(实时/离线),蚂蚁搬家分片思想,万亿级数据量项目验证
Stardust 2018 星尘,分布式服务平台,节点管理、APM监控中心、配置中心、注册中心、发布中心
NewLife.ERP 2021 企业ERP,产品管理、客户管理、销售管理、供应商管理
CrazyCoder 2006 码神工具,众多开发者工具,网络、串口、加解密、正则表达式、Modbus
XProxy 2005 产品级反向代理,NAT代理、Http代理
HttpMeter 2022 Http压力测试工具
GitCandy 2015 Git源代码管理系统
SmartOS 2014 嵌入式操作系统,完全独立自主,支持ARM Cortex-M芯片架构
SmartA2 2019 嵌入式工业计算机,物联网边缘网关,高性能.NET6主机,应用于工业、农业、交通、医疗
菲凡物联FIoT 2020 物联网整体解决方案,建筑、环保、农业,软硬件及大数据分析一体化,单机十万级点位项目验证
NewLife.UWB 2020 厘米级(10~20cm)高精度室内定位,软硬件一体化,与其它系统联动,大型展厅项目验证

新生命开发团队

XCode

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

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

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

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 is compatible.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on NewLife.MQTT:

Package Downloads
SimpleMQTT

MQTT客户端组件.NET Core版本,基于新生命团队NewLife.MQTT的单例模式封装

Shiny.Mqtt

Mqtt客户端 教程:https://www.cnblogs.com/huguodong/p/16400340.html

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on NewLife.MQTT:

Repository Stars
NewLifeX/XCoder
新生命码神工具,代码生成、网络工具、API工具、串口工具、正则工具、图标工具、加解密工具、地图接口。
Version Downloads Last updated
2.0.2024.1105-beta0152 56 11/5/2024
2.0.2024.1103-beta1212 68 11/3/2024
2.0.2024.1103-beta0750 55 11/3/2024
2.0.2024.1102-beta0140 66 11/2/2024
2.0.2024.1013-beta0757 94 10/13/2024
2.0.2024.1011-beta1037 80 10/11/2024
2.0.2024.902-beta0617 84 9/2/2024
2.0.2024.822-beta1012 118 8/22/2024
2.0.2024.802-beta0630 76 8/2/2024
2.0.2024.708 3,667 7/8/2024
2.0.2024.708-beta1554 58 7/8/2024
2.0.2024.630-beta0605 91 6/30/2024
2.0.2024.516 610 5/16/2024
2.0.2024.516-beta0321 88 5/16/2024
2.0.2024.407 308 4/7/2024
2.0.2024.407-beta1337 76 4/7/2024
1.4.2024.326-beta0009 120 3/26/2024
1.4.2024.319-beta0027 112 3/19/2024
1.4.2024.223-beta1348 127 2/23/2024
1.4.2024.218 305 2/18/2024
1.4.2024.218-beta1603 97 2/18/2024
1.4.2024.126-beta0924 126 1/26/2024
1.4.2024.126-beta0918 93 1/26/2024
1.4.2024.101 464 1/1/2024
1.4.2024.101-beta0526 98 1/1/2024
1.4.2023.1226-beta0005 117 12/26/2023
1.4.2023.1214-beta1117 136 12/14/2023
1.4.2023.1102-beta0008 196 11/2/2023
1.4.2023.1001 841 10/1/2023
1.4.2023.1001-beta1454 104 10/1/2023
1.4.2023.806 460 8/6/2023
1.4.2023.806-beta1209 156 8/6/2023
1.4.2023.707-beta0326 208 7/7/2023
1.4.2023.701-beta0247 146 7/1/2023
1.4.2023.620-beta1039 218 6/20/2023
1.3.2023.401 3,163 4/1/2023
1.3.2023.401-beta2357 165 4/1/2023
1.3.2023.301 1,649 3/1/2023
1.3.2023.301-beta0451 144 3/1/2023
1.2.2023.225-beta0130 157 2/25/2023
1.2.2023.203 461 2/3/2023
1.2.2023.203-beta1428 167 2/3/2023
1.2.2023.101-beta0330 184 1/1/2023
1.2.2022.1201 8,826 12/1/2022
1.2.2022.1201-beta1436 147 12/1/2022
1.1.2022.1126-beta1201 175 11/26/2022
1.1.2022.1126-beta0203 147 11/26/2022
1.1.2022.1101 869 11/1/2022
1.1.2022.1101-beta1415 137 11/1/2022
1.1.2022.1016-beta0137 215 10/16/2022
1.1.2022.901 1,357 9/1/2022
1.1.2022.901-beta0542 133 9/1/2022
1.0.2022.815-beta2337 200 8/15/2022
1.0.2022.801 545 8/1/2022
1.0.2022.801-beta0133 161 8/1/2022
1.0.2022.724-beta0914 170 7/24/2022
1.0.2022.617-beta0320 174 6/17/2022
1.0.2022.605-beta1311 185 6/5/2022
1.0.2022.501 2,009 5/1/2022
1.0.2022.501-beta0245 196 5/1/2022
1.0.2022.429-beta0254 208 4/29/2022
1.0.2022.401 657 4/1/2022
1.0.2022.101 595 1/1/2022
1.0.2021.1204 582 12/4/2021
1.0.2021.1001 520 10/1/2021
1.0.2021.709 625 7/9/2021
1.0.2021.427-beta1 291 4/27/2021
1.0.2021.204 1,274 2/4/2021
1.0.2020.1002 517 10/2/2020
1.0.2020.918-beta3 380 9/18/2020
1.0.2020.601 570 5/31/2020
1.0.2020.305 592 3/5/2020

支持MQTT集群