C# 使用MQTT學習之Mqttnet庫（轉）
1 什麼是 MQTT ？
MQTT(Message Queuing Telemetry Transport，訊息佇列遙測傳輸)是 IBM 開發的一個即時通訊協議，有可能成為物聯網的重要組成部分。MQTT 是基於二進位制訊息的釋出/訂閱程式設計模式的訊息協議，如今已經成為 OASIS 規範，由於規範很簡單，非常適合需要低功耗和網路頻寬有限的 IoT 場景。MQTT官網
2 MQTTnet
MQTTnet 是一個基於 MQTT 通訊的高效能 .NET 開源庫，它同時支援 MQTT 伺服器端和客戶端。而且作者也保持更新，目前支援新版的.NET core，這也是選擇 MQTTnet 的原因。 MQTTnet 在 Github 並不是下載最多的 .NET 的 MQTT 開源庫，其他的還 MqttDotNet、nMQTT、M2MQTT 等
MQTTnet is a high performance .NET library for MQTT based communication. It provides a MQTT client and a MQTT server (broker). The implementation is based on the documentation from http://mqtt.org/.
3 建立專案並匯入類庫
這裡我們使用 Visual Studio 2017 建立一個空解決方案，並在其中新增兩個專案，即一個服務端和一個客戶端，服務端專案模板選擇最新的 .NET Core 控制檯應用，客戶端專案選擇傳統的 WinForm 窗體應用程式。.NET Core 專案模板如下圖所示：
在解決方案在右鍵單擊-選擇“管理解決方案的 NuGet 程式包”-在“瀏覽”選項卡下面搜尋 MQTTnet，為服務端專案和客戶端專案都安裝上 MQTTnet 庫，當前最新穩定版為 2.4.0。專案結構如下圖所示：
4 服務端
MQTT 服務端主要用於與多個客戶端保持連線，並處理客戶端的釋出和訂閱等邏輯。一般很少直接從服務端傳送訊息給客戶端(可以使用 mqttServer.Publish(appMsg); 直接傳送訊息)，多數情況下服務端都是轉發主題匹配的客戶端訊息，在系統中起到一箇中介的作用。
4.1 建立服務端並啟動
建立服務端最簡單的方式是採用 MqttServerFactory 物件的 CreateMqttServer 方法來實現，該方法需要一個MqttServerOptions 引數。
var options = new MqttServerOptions();
var mqttServer = new MqttServerFactory().CreateMqttServer(options);
通過上述方式建立了一個 IMqttServer 物件後，呼叫其 StartAsync 方法即可啟動 MQTT 服務。值得注意的是：之前版本採用的是 Start 方法，作者也是緊跟 C# 語言新特性，能使用非同步的地方也都改為非同步方式。
await mqttServer.StartAsync();
4.2 驗證客戶端
在 MqttServerOptions 選項中，你可以使用 ConnectionValidator 來對客戶端連線進行驗證。比如客戶端ID標識 ClientId，使用者名稱 Username 和密碼 Password 等。
var options = new MqttServerOptions
{
ConnectionValidator = c =>
{
if (c.ClientId.Length < 10)
{
return MqttConnectReturnCode.ConnectionRefusedIdentifierRejected;
}
if (c.Username != "xxx" || c.Password != "xxx")
{
return MqttConnectReturnCode.ConnectionRefusedBadUsernameOrPassword;
}
return MqttConnectReturnCode.ConnectionAccepted;
}
};
4.3 相關事件
服務端支援 ClientConnected、ClientDisconnected 和 ApplicationMessageReceived 事件，分別用來檢查客戶端連線、客戶端斷開以及接收客戶端發來的訊息。
其中 ClientConnected 和 ClientDisconnected 事件的事件引數一個客戶端連線物件 ConnectedMqttClient，通過該物件可以獲取客戶端ID標識 ClientId 和 MQTT 版本 ProtocolVersion。
ApplicationMessageReceived 的事件引數包含了客戶端ID標識 ClientId 和 MQTT 應用訊息 MqttApplicationMessage 物件，通過該物件可以獲取主題 Topic、QoS QualityOfServiceLevel 和訊息內容 Payload 等資訊。
5 客戶端
MQTT 與 HTTP 不同，後者是基於請求/響應方式的，伺服器端無法直接傳送資料給客戶端。而 MQTT 是基於釋出/訂閱模式的,所有的客戶端均與服務端保持連線狀態。
那麼客戶端之間是如何通訊的呢？
具體邏輯是：某些客戶端向服務端訂閱它感興趣(主題)的訊息，另一些客戶端向服務端釋出(主題)訊息，服務端將訂閱和釋出的主題進行匹配，並將訊息轉發給匹配通過的客戶端。
5.1 建立客戶端並連線
使用 MQTTnet 建立 MQTT 也非常簡單，只需要使用 MqttClientFactory 物件的 CreateMqttClient 方法即可。
var mqttClient = new MqttClientFactory().CreateMqttClient();
建立客戶端物件後，呼叫其非同步方法 ConnectAsync 來連線到服務端。
await mqttClient.ConnectAsync(options);
呼叫該方法時需要傳遞一個 MqttClientTcpOptions 物件(之前的版本是在建立物件時使用該選項)，該選項包含了客戶端ID標識 ClientId、服務端地址(可以使用IP地址或域名)Server、埠號 Port、使用者名稱 UserName、密碼 Password 等資訊。
var options = new MqttClientTcpOptions
{
Server = "127.0.0.1",
ClientId = "c001",
UserName = "u001",
Password = "p001",
CleanSession = true
};
5.2 相關事件
客戶端支援 Connected、Disconnected 和 ApplicationMessageReceived 事件，用來處理客戶端與服務端連線、客戶端從服務端斷開以及客戶端收到訊息的事情。
5.2 訂閱訊息
客戶端連線到服務端之後，可以使用 SubscribeAsync 非同步方法訂閱訊息，該方法可以傳入一個可列舉或可變引數的主題過濾器 TopicFilter 引數，主題過濾器包含主題名和 QoS 等級。
mqttClient.SubscribeAsync(new List {
new TopicFilter("家/客廳/空調/#", MqttQualityOfServiceLevel.AtMostOnce)
});
5.3 釋出訊息
釋出訊息前需要先構建一個訊息物件 MqttApplicationMessage，最直接的方法是使用其實建構函式，傳入主題、內容、Qos 等引數。
mqttClient.SubscribeAsync(new List {
new TopicFilter("家/客廳/空調/#", MqttQualityOfServiceLevel.AtMostOnce)
});
得到 MqttApplicationMessage 訊息物件後，通過客戶端物件呼叫其 PublishAsync 非同步方法進行訊息釋出。
mqttClient.PublishAsync(appMsg);
6 跟蹤訊息
MQTTnet 提供了一個靜態類 MqttNetTrace 來對訊息進行跟蹤，該類可用於服務端和客戶端。MqttNetTrace 的事件TraceMessagePublished 用於跟蹤服務端和客戶端應用的日誌訊息，比如啟動、停止、心跳、訊息訂閱和釋出等。事件引數MqttNetTraceMessagePublishedEventArgs 包含了執行緒ID ThreadId、來源 Source、日誌級別 Level、日誌訊息 Message、異常資訊 Exception 等。
MqttNetTrace.TraceMessagePublished += MqttNetTrace_TraceMessagePublished;
private static void MqttNetTrace_TraceMessagePublished(object sender, MqttNetTraceMessagePublishedEventArgs e)
{
Console.WriteLine($">> 執行緒ID：{e.ThreadId} 來源：{e.Source} 跟蹤級別：{e.Level} 訊息: {e.Message}");
if (e.Exception != null)
{
Console.WriteLine(e.Exception);
}
}
同時 MqttNetTrace 類還提供了4個不同訊息等級的靜態方法，Verbose、Information、Warning 和 Error，用於給出不同級別的日誌訊息，該訊息將會在 TraceMessagePublished 事件中輸出，你可以使用 e.Level 進行過慮。
7 執行效果
以下分別是服務端、客戶端1和客戶端2的執行效果，其中客戶端1和客戶端2只是同一個專案運行了兩個例項。客戶端1用於訂閱感測器的“溫度”資料，並模擬上位機(如 APP 等)傳送開關控制命令；客戶端2訂閱上位機傳來的“開關”控制命令，並模擬溫度感測器上報溫度資料。
7.1 服務端
7.2 客戶端1
7.2 客戶端2
8 Demo程式碼
8.1 服務端程式碼
using MQTTnet;
using MQTTnet.Core.Adapter;
using MQTTnet.Core.Diagnostics;
using MQTTnet.Core.Protocol;
using MQTTnet.Core.Server;
using System;
using System.Text;
using System.Threading;
namespace MqttServerTest
{
class Program
{
private static MqttServer mqttServer = null;
static void Main(string[] args)
{
MqttNetTrace.TraceMessagePublished += MqttNetTrace_TraceMessagePublished;
new Thread(StartMqttServer).Start();
while (true)
{
var inputString = Console.ReadLine().ToLower().Trim();
if (inputString == "exit")
{
mqttServer?.StopAsync();
Console.WriteLine("MQTT服務已停止！");
break;
}
else if (inputString == "clients")
{
foreach (var item in mqttServer.GetConnectedClients())
{
Console.WriteLine($"客戶端標識：{item.ClientId}，協議版本：{item.ProtocolVersion}");
}
}
else
{
Console.WriteLine($"命令[{inputString}]無效！");
}
}
}
private static void StartMqttServer()
{
if (mqttServer == null)
{
try
{
var options = new MqttServerOptions
{
ConnectionValidator = p =>
{
if (p.ClientId == "c001")
{
if (p.Username != "u001" || p.Password != "p001")
{
return MqttConnectReturnCode.ConnectionRefusedBadUsernameOrPassword;
}
}
return MqttConnectReturnCode.ConnectionAccepted;
}
};
mqttServer = new MqttServerFactory().CreateMqttServer(options) as MqttServer;
mqttServer.ApplicationMessageReceived += MqttServer_ApplicationMessageReceived;
mqttServer.ClientConnected += MqttServer_ClientConnected;
mqttServer.ClientDisconnected += MqttServer_ClientDisconnected;
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
return;
}
}
mqttServer.StartAsync();
Console.WriteLine("MQTT服務啟動成功！");
}
private static void MqttServer_ClientConnected(object sender, MqttClientConnectedEventArgs e)
{
Console.WriteLine($"客戶端[{e.Client.ClientId}]已連線，協議版本：{e.Client.ProtocolVersion}");
}
private static void MqttServer_ClientDisconnected(object sender, MqttClientDisconnectedEventArgs e)
{
Console.WriteLine($"客戶端[{e.Client.ClientId}]已斷開連線！");
}
private static void MqttServer_ApplicationMessageReceived(object sender, MqttApplicationMessageReceivedEventArgs e)
{
Console.WriteLine($"客戶端[{e.ClientId}]>> 主題：{e.ApplicationMessage.Topic} 負荷：{Encoding.UTF8.GetString(e.ApplicationMessage.Payload)} Qos：{e.ApplicationMessage.QualityOfServiceLevel} 保留：{e.ApplicationMessage.Retain}");
}
private static void MqttNetTrace_TraceMessagePublished(object sender, MqttNetTraceMessagePublishedEventArgs e)
{
/*Console.WriteLine($">> 執行緒ID：{e.ThreadId} 來源：{e.Source} 跟蹤級別：{e.Level} 訊息: {e.Message}");
if (e.Exception != null)
{
Console.WriteLine(e.Exception);
}*/
}
}
}
8.2 客戶端程式碼
using MQTTnet;
using MQTTnet.Core;
using MQTTnet.Core.Client;
using MQTTnet.Core.Packets;
using MQTTnet.Core.Protocol;
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
namespace MqttClientWin
{
public partial class FmMqttClient : Form
{
private MqttClient mqttClient = null;
public FmMqttClient()
{
InitializeComponent();
Task.Run(async () => { await ConnectMqttServerAsync(); });
}
private async Task ConnectMqttServerAsync()
{
if (mqttClient == null)
{
mqttClient = new MqttClientFactory().CreateMqttClient() as MqttClient;
mqttClient.ApplicationMessageReceived += MqttClient_ApplicationMessageReceived;
mqttClient.Connected += MqttClient_Connected;
mqttClient.Disconnected += MqttClient_Disconnected;
}
try
{
var options = new MqttClientTcpOptions
{
Server = "127.0.0.1",
ClientId = Guid.NewGuid().ToString().Substring(0, 5),
UserName = "u001",
Password = "p001",
CleanSession = true
};
await mqttClient.ConnectAsync(options);
}
catch (Exception ex)
{
Invoke((new Action(() =>
{
txtReceiveMessage.AppendText($"連線到MQTT伺服器失敗！" + Environment.NewLine + ex.Message + Environment.NewLine);
})));
}
}
private void MqttClient_Connected(object sender, EventArgs e)
{
Invoke((new Action(() =>
{
txtReceiveMessage.AppendText("已連線到MQTT伺服器！" + Environment.NewLine);
})));
}
private void MqttClient_Disconnected(object sender, EventArgs e)
{
Invoke((new Action(() =>
{
txtReceiveMessage.AppendText("已斷開MQTT連線！" + Environment.NewLine);
})));
}
private void MqttClient_ApplicationMessageReceived(object sender, MqttApplicationMessageReceivedEventArgs e)
{
Invoke((new Action(() =>
{
txtReceiveMessage.AppendText($">> {Encoding.UTF8.GetString(e.ApplicationMessage.Payload)}{Environment.NewLine}");
})));
}
private void BtnSubscribe_ClickAsync(object sender, EventArgs e)
{
string topic = txtSubTopic.Text.Trim();
if (string.IsNullOrEmpty(topic))
{
MessageBox.Show("訂閱主題不能為空！");
return;
}
if (!mqttClient.IsConnected)
{
MessageBox.Show("MQTT客戶端尚未連線！");
return;
}
mqttClient.SubscribeAsync(new List {
new TopicFilter(topic, MqttQualityOfServiceLevel.AtMostOnce)
});
txtReceiveMessage.AppendText($"已訂閱[{topic}]主題" + Environment.NewLine);
txtSubTopic.Enabled = false;
btnSubscribe.Enabled = false;
}
private void BtnPublish_Click(object sender, EventArgs e)
{
string topic = txtPubTopic.Text.Trim();
if (string.IsNullOrEmpty(topic))
{
MessageBox.Show("釋出主題不能為空！");
return;
}
string inputString = txtSendMessage.Text.Trim();
var appMsg = new MqttApplicationMessage(topic, Encoding.UTF8.GetBytes(inputString), MqttQualityOfServiceLevel.AtMostOnce, false);
mqttClient.PublishAsync(appMsg);
}
}
}
原文連結：https://blog.csdn.net/weixin_39611308/article/details/111728108