本章节给大家讲讲如何实现Mqtt通讯，工程主要有两个，一个是客户端，一个是服务端，功能类都已全部封装好，大家可以直接调用使用。
要实现mqtt的功能，我们需要在NuGet包管理器里面安装一个MQTTnet的功能包，版本的话，我这里安装的是最新的3.1.0，如下：
首先我们先来看下演示效果：
客户端和服务端类与窗体之间的通讯全部才委托（delegate）的方法进行，这样会便于功能类的封装。
一、服务端
首先，我们先来看下服务端的功能实现，主要类文件为MyMqttServer.cs，在服务端，当用户链接之后，有个用户信息验证的过程，该过程可以用，也可以不用，在连接验证器里面有个名称为MqttConnectReasonCode的状态信息，MqttConnectReasonCode的状态说明如下：
public enum MqttConnectReasonCode
{
Success = 0, // 成功
UnspecifiedError = 128, // 未知的错误
MalformedPacket = 129, // 数据包缺失
ProtocolError = 130, // 协议有误
ImplementationSpecificError = 131, // 实现细节有误
UnsupportedProtocolVersion = 132, // 协议版本不支持
ClientIdentifierNotValid = 133, // 客户端标识码无效
BadUserNameOrPassword = 134, // 错误的用户名或密码
NotAuthorized = 135, // 未授权
ServerUnavailable = 136, // 服务器不可用
ServerBusy = 137, // 服务器正忙
Banned = 138, // 已禁用
BadAuthenticationMethod = 140, // 验证方法有误
TopicNameInvalid = 144, // 无效的Topic名称
PacketTooLarge = 149, // 数据包过大
QuotaExceeded = 151, // 超出配额
PayloadFormatInvalid = 153, // Payload格式有误
RetainNotSupported = 154, // 不支持保留
QoSNotSupported = 155, // 不支持QoS
UseAnotherServer = 156, // 使用其他服务器
ServerMoved = 157, // 服务器移动
ConnectionRateExceeded = 159 // 连接速率超出限定
}MyMqttServer.cs 代码如下：
using MQTTnet;
using MQTTnet.Protocol;
using MQTTnet.Server;
using System;
using System.Collections.Generic;
using System.Text;
namespace Mqtt_Server
{
/// <summary>
/// 消息调用的事件
/// </summary>
/// <param name="sender"></param>
public delegate void InformHandle(object sender);
public class MyMqttServer
{
#region 消息
/// <summary>
/// 返回的消息
/// </summary>
public event InformHandle MqttMessage;
/// <summary>
/// 发送消息
/// </summary>
/// <param name="data"></param>
public virtual void ToSignal(object data)
{
if (MqttMessage != null) MqttMessage(data);
}
#endregion
#region 环境变量
/// <summary>
/// mqtt服务
/// </summary>
private MqttServer mqttServer { get; set; }
/// <summary>
/// 配置信息
/// </summary>
public MqttConfigs Config { get; set; }
#endregion
public bool StartServer()
{
try
{
var options = new MqttServerOptionsBuilder();
// 连接记录数，默认 一般为2000
options.WithConnectionBacklog(2000);
// 默认端口是1883,这里可以自己设置
options.WithDefaultEndpointPort(Config.tcpPort);
// 连接验证器
options.WithConnectionValidator((e) => ConnectionValidationHandler(e));
// 持续会话
options.WithPersistentSessions();
// 会话超时时间？
options.WithDefaultCommunicationTimeout(TimeSpan.FromMilliseconds(60000));
// 每个客户端主题存1000000条数据
options.WithMaxPendingMessagesPerClient(1000000);
var mqttFactory = new MqttFactory();
mqttServer = mqttFactory.CreateMqttServer() as MqttServer;
// 服务启动消息事件
mqttServer.StartedHandler = new MqttServerStartedHandlerDelegate(OnStartedHandler);
// 服务停止消息事件
mqttServer.StoppedHandler = new MqttServerStoppedHandlerDelegate(OnStoppedHandler);
// 客户端连接事件
mqttServer.UseClientConnectedHandler(UseClientConnected);
// 客户端断开事件
mqttServer.UseClientDisconnectedHandler(UseClientDisconnected);
// 客户端消息事件
mqttServer.UseApplicationMessageReceivedHandler(UseApplicationMessageReceived);
// 开启订阅事件
mqttServer.ClientSubscribedTopicHandler = new MqttServerClientSubscribedTopicHandlerDelegate(OnClientSubscribedTopic);
// 取消订阅事件
mqttServer.ClientUnsubscribedTopicHandler = new MqttServerClientUnsubscribedTopicHandlerDelegate(OnClientUnsubscribedTopic);
// 启动服务
mqttServer.StartAsync(options.Build());
return true;
}
catch (Exception ex)
{
ToSignal(new MqttSignal() { Type = 0, Data = $"客户端尝试连接出错：{ex.Message}" });
}
return false;
}
/// <summary>
/// 连接验证器，进行用户名和密码的验证，也可以不验证
/// </summary>
/// <returns></returns>
private void ConnectionValidationHandler(MqttConnectionValidatorContext e)
{
if (e.Username == Config.mqttUser && e.Password == Config.mqttPassword)
{
e.ReasonCode = MqttConnectReasonCode.Success;
ToSignal($"{e.ClientId} 登录成功");
return;
}
else
{
e.ReasonCode = MqttConnectReasonCode.BadUserNameOrPassword;
ToSignal($"{e.ClientId} 用户名或密码错误，登陆失败");
return;
}
}
/// <summary>
/// 服务启动消息事件
/// </summary>
/// <param name="e"></param>
private void OnStartedHandler(EventArgs e)
{
ToSignal("服务启动消息事件");
}
/// <summary>
/// 服务停止消息事件
/// </summary>
/// <param name="e"></param>
private void OnStoppedHandler(EventArgs e)
{
ToSignal("服务停止消息事件");
}
/// <summary>
/// 客户端连接事件
/// </summary>
/// <param name="e"></param>
private void UseClientConnected(MqttServerClientConnectedEventArgs e)
{
ToSignal($"客户端[{e.ClientId}]已连接");
}
/// <summary>
/// 客户端断开事件
/// </summary>
/// <param name="e"></param>
private void UseClientDisconnected(MqttServerClientDisconnectedEventArgs e)
{
ToSignal($"客户端[{e.ClientId}]断开 Type:{e.DisconnectType}");
}
/// <summary>
/// 客户端消息事件
/// </summary>
/// <param name="e"></param>
private void UseApplicationMessageReceived(MqttApplicationMessageReceivedEventArgs e)
{
var msg = e.ApplicationMessage;
var topic = msg.Topic;
var payload = msg.ConvertPayloadToString();
ToSignal($"客户端消息事件:\r\nTopic:{topic}\r\nPayload:{payload}");
}
/// <summary>
/// 开启订阅事件
/// </summary>
/// <param name="e"></param>
private void OnClientSubscribedTopic(MqttServerClientSubscribedTopicEventArgs e)
{
// 向前端汇报客户端端ID和主题
ToSignal($"开启订阅事件:{e.ClientId}\r\nTopic:{e.TopicFilter.ToString()}");
ToSignal(new MqttSignal() { Type = 3, Data = new List<string> { e.ClientId, e.TopicFilter.Topic } });
}
/// <summary>
/// 取消订阅事件
/// </summary>
/// <param name="e"></param>
private void OnClientUnsubscribedTopic(MqttServerClientUnsubscribedTopicEventArgs e)
{
// 向前端汇报客户端端ID和主题
ToSignal($"取消订阅事件:{e.ClientId} Topic:{e.TopicFilter}");
ToSignal(new MqttSignal() { Type = 4, Data = new List<string> { e.ClientId, e.TopicFilter } });
}
/// <summary>
/// 发送消息
/// </summary>
/// <param name="topic">客户端主题</param>
/// <param name="msg">消息</param>
public bool Send(string topic, object msg)
{
try
{
if (msg.GetType() == typeof(string) && msg.GetType() == typeof(byte[]))
{
ToSignal(new MqttSignal() { Type = 0, Data = "消息格式错误" });
return false;
}
var message = new MqttApplicationMessage()
{
Topic = topic, // 客户端主题
Payload = (msg.GetType() == typeof(string)) ? Encoding.UTF8.GetBytes(msg as string) : msg as byte[], // 发布的消息
QualityOfServiceLevel = (MqttQualityOfServiceLevel)0, // 消息等级
Retain = false // 是否保留
};
mqttServer.PublishAsync(message);
ToSignal(new MqttSignal() { Type = 1, Data = string.Format("服务端[{0}]发布主题[{1}]成功！", mqttServer.Options.ClientId, topic) });
return true;
}
catch (Exception ex)
{
ToSignal(new MqttSignal() { Type = 0, Data = string.Format("服务端[{0}]发布主题[{1}]异常！>{2}", mqttServer.Options.ClientId, topic, ex.Message) });
}
return false;
}
public void MqttClose()
{
if (mqttServer == null) return;
try
{
mqttServer?.StopAsync();
mqttServer = null;
ToSignal($"服务关闭成功.");
}
catch (Exception e)
{
ToSignal($"服务关闭失败：{e.Message}");
}
}
}
#region 反馈信号
/// <summary>
/// 反馈信号
/// </summary>
public class MqttSignal
{
/// <summary>
/// 类型
/// <para>0：异常消息</para>
/// <para>1：日志消息</para>
/// <para>2：接收到数据</para>
/// <para>3：链接消息</para>
/// <para>4：断开消息</para>
/// </summary>
public int Type { get; set; }
/// <summary>
/// 数据
/// </summary>
public object Data { get; set; }
}
#endregion
#region 配置信息
/// <summary>
/// 配置信息
/// </summary>
public class MqttConfigs
{
/// <summary>
/// 链接端口
/// </summary>
public int tcpPort;
/// <summary>
/// 链接用户名
/// </summary>
public string mqttUser;
/// <summary>
/// 链接密码
/// </summary>
public string mqttPassword;
};
#endregion
}Form1的代码如下：
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using System.Windows.Forms;
namespace Mqtt_Server
{
public partial class Form1 : Form
{
/// <summary>
/// Mqtt服务
/// </summary>
public MyMqttServer mqtt { get; set; }
public Form1()
{
InitializeComponent();
comboBox2.Items.Add("全部");
comboBox2.SelectedIndex = 0;
}
private void button_启动服务_Click(object sender, EventArgs e)
{
new Task(() =>
{
if (mqtt == null)
{
// 参数配置
MqttConfigs con = new MqttConfigs();
con.tcpPort = int.Parse(textBox3.Text);
con.mqttUser = textBox5.Text;
con.mqttPassword = textBox6.Text;
// 启动Mqtt服务
mqtt = new MyMqttServer();
mqtt.Config = con;
mqtt.MqttMessage += Mqtt_MqttMessage; ;// 订阅消息
mqtt.StartServer();
}
}).Start();
}
private void button_关闭服务_Click(object sender, EventArgs e)
{
mqtt.MqttClose();
mqtt = null;
}
private void button_清空日志_Click(object sender, EventArgs e)
{
textBox1.Text = "";
}
private void button_发送消息_Click(object sender, EventArgs e)
{
if (comboBox2.Text == "全部")
{
foreach (string s in comboBox2.Items)
{
mqtt.Send(s, textBox2.Text);
}
}
else
{
mqtt.Send(comboBox2.Text, textBox2.Text);
}
}
/// <summary>
/// mqtt消息回调
/// </summary>
/// <param name="sender"></param>
private void Mqtt_MqttMessage(object sender)
{
BeginInvoke(new Action(() =>
{
if (sender.GetType() == typeof(MqttSignal))
{
MqttSignal m = sender as MqttSignal;
switch (m.Type)
{
case 3:
List<string> data1 = m.Data as List<string>;
// 添加ID
if (!comboBox1.Items.Contains(data1[0]))
comboBox1.Items.Add(data1[0]);
comboBox1.SelectedIndex = comboBox1.Items.Count - 1;
// 添加主题
if (!comboBox2.Items.Contains(data1[1]))
comboBox2.Items.Add(data1[1]);
comboBox2.SelectedIndex = comboBox2.Items.Count - 1;
break;
case 4:
List<string> data2 = m.Data as List<string>;
// 删除ID
comboBox1.Items.Remove(data2[0]);
comboBox1.SelectedIndex = comboBox1.Items.Count - 1;
// 删除主题
comboBox2.Items.Remove(data2[1]);
comboBox2.SelectedIndex = comboBox2.Items.Count - 1;
break;
default:
textBox1.Text += m.Data.ToString() + "\r\n";
break;
}
}
if (sender.GetType() == typeof(string))
{
string m = sender as string;
textBox1.Text += m + "\r\n";
}
}));
}
}
}二、客户端
客户端的功能实现，主要类文件为MyMqttClient.cs，代码如下：
using MQTTnet;
using MQTTnet.Client;
using MQTTnet.Client.Connecting;
using MQTTnet.Client.Disconnecting;
using MQTTnet.Client.Options;
using MQTTnet.Client.Receiving;
using MQTTnet.Protocol;
using MQTTnet.Server;
using System;
using System.Text;
using System.Threading;
namespace Mqtt_Client
{
/// <summary>
/// 消息调用的事件
/// </summary>
/// <param name="sender"></param>
public delegate void InformHandle(object sender);
public class MyMqttClient
{
#region 消息
/// <summary>
/// 返回的消息
/// </summary>
public event InformHandle MqttMessage;
/// <summary>
/// 发送消息
/// </summary>
/// <param name="data"></param>
public virtual void ToSignal(object data)
{
if (MqttMessage != null) MqttMessage(data);
}
#endregion
#region 环境变量
/// <summary>
/// mqtt连接信息
/// </summary>
public MqttClient mqttClient { get; set; }
/// <summary>
/// 配置信息
/// </summary>
public MqttConfigs Config { get; set; }
#endregion
#region 私有方法
/// <summary>
/// 时间差计算
/// </summary>
/// <param name="tim"></param>
/// <returns></returns>
private long TimeSecondDif(DateTime tim)
{
return (DateTime.Now.Ticks - tim.Ticks) / 10000000;
}
#endregion
#region 主体功能
/// <summary>
/// 启动连接
/// </summary>
/// <param name="conf"></param>
/// <returns></returns>
public bool StartClient()
{
try
{
var options = new MqttClientOptions
{
ClientId = Config.ClientId,
ProtocolVersion = MQTTnet.Formatter.MqttProtocolVersion.V311,
ChannelOptions = new MqttClientTcpOptions { Server = Config.tcpServer, Port = Config.tcpPort },
WillDelayInterval = 10 // 延迟的事件
};
if (options.ChannelOptions == null)
{
throw new InvalidOperationException();
}
options.Credentials = new MqttClientCredentials
{
Username = Config.mqttUser,
Password = Encoding.UTF8.GetBytes(Config.mqttPassword)
};
options.CleanSession = true;
options.KeepAlivePeriod = TimeSpan.FromSeconds(120);
var mqttFactory = new MqttFactory();
mqttClient = mqttFactory.CreateMqttClient() as MqttClient;
// 连接成功回调
mqttClient.ConnectedHandler = new MqttClientConnectedHandlerDelegate(OnMqttClientConnected);
// 连接断开回调
mqttClient.DisconnectedHandler = new MqttClientDisconnectedHandlerDelegate(OnMqttClientDisConnected);
// 客户端接收回调
mqttClient.ApplicationMessageReceivedHandler = new MqttApplicationMessageReceivedHandlerDelegate(OnSubscriberMessageReceived);
mqttClient.ConnectAsync(options);
ToSignal(new MqttSignal() { Type = 1, Data = $"客户端[{options.ClientId}]尝试连接..." });
DateTime OutTime = DateTime.Now;
while (mqttClient != null && !mqttClient.IsConnected)
{
// 30秒链接超时
if (TimeSecondDif(OutTime) >= 30) return false;
Thread.Sleep(500);
}
Thread.Sleep(100);
if (mqttClient == null)
{
ToSignal(new MqttSignal() { Type = 0, Data = $"客户端连接超时..." });
return false;
}
ToSignal(new MqttSignal() { Type = 1, Data = $"订阅消息..." });
ClientSubscribeTopic(Config.topic);
return true;
}
catch (Exception ex)
{
ToSignal(new MqttSignal() { Type = 0, Data = $"客户端尝试连接出错：{ex.Message}" });
}
return false;
}
/// <summary>
/// 关闭连接
/// </summary>
/// <returns></returns>
public void ClientStop()
{
try
{
if (mqttClient == null)
{
return;
}
mqttClient.DisconnectAsync();
mqttClient = null;
}
catch (Exception ex)
{
ToSignal(new MqttSignal() { Type = 0, Data = $"客户端尝试断开Server出错：{ex.Message}" });
}
}
/// <summary>
/// 连接成功回调
/// </summary>
/// <param name="e"></param>
private void OnMqttClientConnected(MqttClientConnectedEventArgs e)
{
ToSignal(new MqttSignal() { Type = 1, Data = $"客户端连接成功." });
}
/// <summary>
/// 连接断开回调
/// </summary>
/// <param name="e"></param>
private void OnMqttClientDisConnected(MqttClientDisconnectedEventArgs e)
{
ToSignal(new MqttSignal() { Type = 1, Data = $"客户端断开连接." });
ClientStop();
}
/// <summary>
/// 订阅消息
/// </summary>
/// <param name="topic"></param>
private void ClientSubscribeTopic(string topic)
{
try
{
if (mqttClient == null) return;
mqttClient.SubscribeAsync(topic);
ToSignal(new MqttSignal() { Type = 1, Data = string.Format("客户端[{0}]订阅主题[{1}]成功！", mqttClient.Options.ClientId, topic) });
}
catch (Exception ex)
{
ToSignal(new MqttSignal() { Type = 0, Data = $"客户端订阅主题出错：{ex.Message}" });
}
}
/// <summary>
/// 取消订阅消息
/// </summary>
/// <param name="topic"></param>
public void MqttClose(string topic)
{
try
{
if (mqttClient == null) return;
mqttClient.UnsubscribeAsync(topic);
ToSignal(new MqttSignal() { Type = 1, Data = string.Format("客户端[{0}]取消主题[{1}]成功！", mqttClient.Options.ClientId, topic) });
}
catch (Exception ex)
{
ToSignal(new MqttSignal() { Type = 0, Data = $"客户端取消主题出错：{ex.Message}" });
}
}
/// <summary>
/// 客户端接收回调
/// </summary>
/// <param name="e"></param>
private void OnSubscriberMessageReceived(MqttApplicationMessageReceivedEventArgs e)
{
try
{
string json = Encoding.UTF8.GetString(e.ApplicationMessage.Payload);
string Topic = e.ApplicationMessage.Topic;
string QoS = e.ApplicationMessage.QualityOfServiceLevel.ToString();
string Retained = e.ApplicationMessage.Retain.ToString();
ToSignal(new MqttSignal() { Type = 2, Data = $"[接收] >> Topic:{Topic} QoS:{QoS} Retained:{Retained} json:{json}" });
}
catch (Exception ex)
{
ToSignal(new MqttSignal() { Type = 0, Data = $"数据接收异常：{ex.Message}" });
}
}
/// <summary>
/// 发送消息
/// </summary>
/// <param name="topic">客户端主题</param>
/// <param name="msg">消息</param>
public bool Send(string topic, object msg)
{
try
{
if (mqttClient == null) return false;
if (msg.GetType() == typeof(string) && msg.GetType() == typeof(byte[]))
{
ToSignal(new MqttSignal() { Type = 0, Data = "消息格式错误" });
return false;
}
var message = new MqttApplicationMessage()
{
Topic = topic, // 客户端主题
Payload = (msg.GetType() == typeof(string)) ? Encoding.UTF8.GetBytes(msg as string) : msg as byte[], // 发布的消息
QualityOfServiceLevel = (MqttQualityOfServiceLevel)0, // 消息等级
Retain = false // 是否保留
};
mqttClient.PublishAsync(message);
ToSignal(new MqttSignal() { Type = 1, Data = string.Format("客户端[{0}]发布主题[{1}]成功！", mqttClient.Options.ClientId, topic) });
return true;
}
catch (Exception ex)
{
ToSignal(new MqttSignal() { Type = 0, Data = string.Format("客户端[{0}]发布主题[{1}]异常！>{2}", mqttClient.Options.ClientId, topic, ex.Message) });
}
return false;
}
#endregion
}
#region 反馈信号
/// <summary>
/// 反馈信号
/// </summary>
public class MqttSignal
{
/// <summary>
/// 类型
/// <para>0：异常消息</para>
/// <para>1：日志消息</para>
/// <para>2：接收到数据</para>
/// </summary>
public int Type { get; set; }
/// <summary>
/// 数据
/// </summary>
public string Data { get; set; }
}
#endregion
#region 配置信息
// 参考配置
// tcpPort = 1883;
// tcpServer = "192.168.1.151";
// mqttUser = "rakwireless";
// mqttPassword = "rakwireless.com";
// ClientId = "MQTT_FX_Client";
// topic = "application/+/device/+/rx";
/// <summary>
/// 配置信息
/// </summary>
public class MqttConfigs
{
/// <summary>
/// 链接端口
/// </summary>
public int tcpPort;
/// <summary>
/// 目标IP
/// </summary>
public string tcpServer;
/// <summary>
/// 链接用户名
/// </summary>
public string mqttUser;
/// <summary>
/// 链接密码
/// </summary>
public string mqttPassword;
/// <summary>
/// 客户端ID
/// </summary>
public string ClientId;
/// <summary>
/// 主题
/// </summary>
public string topic;
};
#endregion
}Form1的代码如下：
using System;
using System.Threading.Tasks;
using System.Windows.Forms;
namespace Mqtt_Client
{
public partial class Form1 : Form
{
/// <summary>
/// Mqtt
/// </summary>
public MyMqttClient mqtt { get; set; }
public Form1()
{
InitializeComponent();
}
private void button_启动链接_Click(object sender, EventArgs e)
{
new Task(() =>
{
if (mqtt == null || mqtt.mqttClient == null || !mqtt.mqttClient.IsConnected)
{
// 参数配置
MqttConfigs con = new MqttConfigs();
con.tcpPort = int.Parse(textBox3.Text);
con.tcpServer = textBox4.Text;
con.mqttUser = textBox5.Text;
con.mqttPassword = textBox6.Text;
con.ClientId = textBox7.Text;
con.topic = textBox8.Text;
// 启动Mqtt
mqtt = new MyMqttClient();
mqtt.Config = con;
mqtt.MqttMessage += Mqtt_MqttMessage;// 订阅消息
mqtt.StartClient();
}
}).Start();
}
private void button_关闭链接_Click(object sender, EventArgs e)
{
mqtt.MqttClose(textBox8.Text);
mqtt = null;
}
private void button_清空消息_Click(object sender, EventArgs e)
{
textBox1.Text = "";
}
private void button_发送消息_Click(object sender, EventArgs e)
{
mqtt.Send(textBox8.Text, textBox2.Text);
}
/// <summary>
/// Mqtt消息回调
/// </summary>
/// <param name="sender"></param>
private void Mqtt_MqttMessage(object sender)
{
BeginInvoke(new Action(() =>
{
if (sender.GetType() == typeof(MqttSignal))
{
MqttSignal m = sender as MqttSignal;
textBox1.Text += m.Data + "\r\n";
}
}));
}
}
}
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
