Unity实现MQTT服务器

已于 2023-10-31 11:07:56 修改
阅读量1.7k 收藏 12
点赞数 4
文章标签： unity 服务器 游戏引擎
于 2023-09-01 11:30:48 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42720695/article/details/132620460
版权

首先下载MqttNet：MqttNet4.1.2.350

解压好后使用vs打开，并生成.dll文件（我这里下载的是4.1.2.350版本）

请注意最好下载4.1.2.350版本的，否则其他版本生成的Dll可能与我所用版本存在差异，导致我下面的代码出现错误，若链接失效，可自行百度MqttNet，选择

点击进入后找到图中圈出来的部分

点击“+”，然后翻找历史版本，选择4.1.2.350版本下载。

然后再/Source/MQTTnet/bin/Debug/net452 文件夹中找到生成的文件

新建unity工程，创建Plugins文件夹，将文件复制到该文件夹内

然后新建脚本MyMqttServer，代码内带有注释

using MQTTnet.Adapter;
using MQTTnet.Server;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using MQTTnet;
using System.Threading.Tasks;
using System;
using System.Diagnostics.Tracing;
using System.Net;
using MQTTnet.Diagnostics;
using System.Text;
using MQTTnet.Protocol;
using static UnityEditor.ObjectChangeEventStream;

namespace MQTT.Server
{
    /// <summary>
    /// 客户端信息
    /// </summary>
    public class MqttClientObject
    {
        public MqttClientObject(string clientID, string userName = "", string password = "")
        {
            this.ClientID = clientID;
            this.UserName = userName;
            this.PassWord = password;
        }

        public string ClientID { get; set; }
        public string UserName { get; set; }
        public string PassWord { get; set; }
    }

    /// <summary>
    /// MQTT服务
    /// </summary>
    public class MyMqttServer
    {
        /// <summary>
        /// 服务器对象
        /// </summary>
        private MqttServer m_MqttServer = null;

        /// <summary>
        /// Mqtt服务器选项生成器
        /// </summary>
        MqttServerOptionsBuilder optionbuilder = null;

        /// <summary>
        /// 连接的客户端
        /// </summary>
        private List<MqttClientObject> m_MqttClientObject = new List<MqttClientObject>();

        /// <summary>
        /// 开启服务器
        /// </summary>
        /// <param name="port"></param>
        public void StartMqttServer(int port = 1883)
        {
            //1.创建服务器对象
            if (m_MqttServer == null)
            {
                //创建Mqtt服务器选项生成器
                optionbuilder = new MqttFactory().CreateServerOptionsBuilder();
                //设置带有默认终端
                optionbuilder.WithDefaultEndpoint();
                //设置终端端口号
                optionbuilder.WithDefaultEndpointPort(port);
                //设置具有持续会话
                optionbuilder.WithPersistentSessions(true);
                //设置无默认通信超时
                optionbuilder.WithDefaultCommunicationTimeout(TimeSpan.FromMilliseconds(60000));

                m_MqttServer = new MqttFactory().CreateMqttServer(optionbuilder.Build());
            }

            //监测服务器 开启/关闭
            m_MqttServer.StartedAsync += ServerStarted;
            m_MqttServer.StoppedAsync += ServerStoped;
            //监测客户端 连接/断开连接
            m_MqttServer.ClientConnectedAsync += ClientConnected;
            m_MqttServer.ClientDisconnectedAsync += ClientDisconnected;
            //监测客户端 订阅/取消订阅
            m_MqttServer.ClientSubscribedTopicAsync += ClientSubscribedTopic;
            m_MqttServer.ClientUnsubscribedTopicAsync += ClientUnSubscribedTopic;
            //客户端连接信息验证
            m_MqttServer.ValidatingConnectionAsync += ValidatingConnection;

            //获取客户端发送的消息
            m_MqttServer.InterceptingPublishAsync += InterceptingPublish;

            //开启服务器
            m_MqttServer.StartAsync();
        }

        /// <summary>
        /// 关闭服务
        /// </summary>
        public void StopMqttServer()
        {
            if (m_MqttServer != null)
            {
                m_MqttServer.StopAsync();
            }
        }

        /// <summary>
        /// 获取服务器状态--开启/关闭
        /// </summary>
        /// <returns></returns>
        public bool GetMqttServerState()
        {
            if (m_MqttServer == null)
            {
                return false;
            }

            return m_MqttServer.IsStarted;
        }

        /// <summary>
        /// 服务器完成开启
        /// </summary>
        /// <param name="eventArgs"></param>
        /// <returns></returns>
        /// <exception cref="NotImplementedException"></exception>
        private Task ServerStarted(EventArgs eventArgs)
        {
            Debug.Log("服务： started!");
            return Task.CompletedTask;
        }

        /// <summary>
        /// 服务器完成关闭
        /// </summary>
        /// <param name="eventArgs"></param>
        /// <returns></returns>
        /// <exception cref="NotImplementedException"></exception>
        private Task ServerStoped(EventArgs eventArgs)
        {
            Debug.Log("服务： stoped!");
            return Task.CompletedTask;

        }

        /// <summary>
        /// 客户端连接完成
        /// </summary>
        /// <param name="eventArgs"></param>
        /// <returns></returns>
        /// <exception cref="NotImplementedException"></exception>
        private Task ClientConnected(ClientConnectedEventArgs eventArgs)
        {
            Debug.Log($"服务：client Connected ClientId:{eventArgs.ClientId}");



            m_MqttClientObject.Add(new MqttClientObject(eventArgs.ClientId, eventArgs.UserName));
            return Task.CompletedTask;
        }

        /// <summary>
        /// 客户端订阅主题完成
        /// </summary>
        /// <param name="eventArgs"></param>
        /// <returns></returns>
        /// <exception cref="NotImplementedException"></exception>
        private Task ClientSubscribedTopic(ClientSubscribedTopicEventArgs eventArgs)
        {
            Debug.Log($"Client:{eventArgs.ClientId} -- Subscribed -- Topic:{eventArgs.TopicFilter.Topic}");

            ServerPublich(eventArgs.TopicFilter.Topic, $"Client:{eventArgs.ClientId} Subscribed this Topic");

            return Task.CompletedTask;
        }

        /// <summary>
        /// 客户端取消订阅主题完成
        /// </summary>
        /// <param name="eventArgs"></param>
        /// <returns></returns>
        /// <exception cref="NotImplementedException"></exception>
        private Task ClientUnSubscribedTopic(ClientUnsubscribedTopicEventArgs eventArgs)
        {
            Debug.Log($"Client:{eventArgs.ClientId} -- Subscribed -- Topic:{eventArgs.TopicFilter}");

            return Task.CompletedTask;
        }

        /// <summary>
        /// 客户端断开连接完成
        /// </summary>
        /// <param name="eventArgs"></param>
        /// <returns></returns>
        /// <exception cref="NotImplementedException"></exception>
        private Task ClientDisconnected(ClientDisconnectedEventArgs eventArgs)
        {
            Debug.Log($"Client：client DisConnected ClientId:{eventArgs.ClientId}");
            return Task.CompletedTask;
        }

        /// <summary>
        /// 客户端连接信息验证
        /// </summary>
        /// <param name="args"></param>
        /// <returns></returns>
        private Task ValidatingConnection(ValidatingConnectionEventArgs args)
        {
            Debug.Log($"UserName:{args.UserName},PassWord:{args.Password}");
            
            return Task.CompletedTask;
        }

        /// <summary>
        /// 获取客户端发送的消息
        /// </summary>
        /// <param name="args"></param>
        /// <returns></returns>
        private Task InterceptingPublish(InterceptingPublishEventArgs args)
        {
            Debug.Log($"Client:{args.ClientId} send Message : {Encoding.UTF8.GetString(args.ApplicationMessage.Payload)} -- Topic:{args.ApplicationMessage.Topic}");

            return Task.CompletedTask;
        }

        /// <summary>
        /// 服务器广播消息
        /// </summary>
        /// <param name="topic">主题</param>
        /// <param name="message">信息</param>
        public void ServerPublich(string topic, string message, bool isRetain = false, MqttQualityOfServiceLevel level = MqttQualityOfServiceLevel.ExactlyOnce)
        {
            var builder = new MqttApplicationMessageBuilder().WithTopic(topic).WithPayload(message).WithRetainFlag(isRetain).WithQualityOfServiceLevel(level).Build();
            var data = new InjectedMqttApplicationMessage(builder);
            data.SenderClientId = "1";
            m_MqttServer.InjectApplicationMessage(data);
        }

    }
}

创建脚本MyMqttClient，代码内带有注释

using MQTTnet;
using MQTTnet.Client;
using MQTTnet.Diagnostics;
using MQTTnet.Protocol;
using MQTTnet.Server;
using System;
using System.Collections;
using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;
using UnityEngine;

/// <summary>
/// MQTT客户端
/// </summary>
public class MyMqttClient
{
    private IMqttClient m_MqttClient = null;
    private string m_ClientID;

    /// <summary>
    /// 创建客户端并连接服务器
    /// </summary>
    /// <param name="clientID"></param>
    /// <param name="ip"></param>
    /// <param name="port"></param>
    public MyMqttClient(string clientID, string ip = "127.0.0.1", int port = 1883)
    {
        m_ClientID = clientID;
        //客户端选项生成器
        var options = new MqttClientOptionsBuilder()
        .WithClientId(m_ClientID)
        .WithTcpServer(ip, port)
        .Build();
        //创建客户端
        m_MqttClient = new MqttFactory().CreateMqttClient();
        //监测客户端 连接/断开连接 完成
        m_MqttClient.ConnectedAsync += ClientConnected;
        m_MqttClient.DisconnectedAsync += ClientDisConnected;
        //客户端接收到消息
        m_MqttClient.ApplicationMessageReceivedAsync += ReceiveMsg;
        //连接服务器
        m_MqttClient.ConnectAsync(options);
    }

    /// <summary>
    /// 接收到消息
    /// </summary>
    /// <param name="args"></param>
    /// <returns></returns>
    private Task ReceiveMsg(MqttApplicationMessageReceivedEventArgs args)
    {
        Debug.Log($"Receive Message From Client:{args.ClientId} msg:{Encoding.UTF8.GetString(args.ApplicationMessage.Payload)}");

        return Task.CompletedTask;
    }

    /// <summary>
    /// 断开连接完成
    /// </summary>
    /// <param name="args"></param>
    /// <returns></returns>
    private Task ClientDisConnected(MqttClientDisconnectedEventArgs args)
    {
        Debug.Log("disConnected");
        return Task.CompletedTask;
    }

    /// <summary>
    /// 连接完成
    /// </summary>
    /// <param name="args"></param>
    /// <returns></returns>
    private Task ClientConnected(MqttClientConnectedEventArgs args)
    {
        Debug.Log("connected");

        return Task.CompletedTask;
    }

    /// <summary>
    /// 发布消息
    /// </summary>
    public void PublishMsg(string topic, string message, MqttQualityOfServiceLevel level = MqttQualityOfServiceLevel.ExactlyOnce, bool isRetain = false)
    {
        m_MqttClient.PublishStringAsync(topic, message, level, isRetain);
    }

    /// <summary>
    /// 订阅主题
    /// </summary>
    public void Subscribe(string topic)
    {
        m_MqttClient.SubscribeAsync(new MqttTopicFilterBuilder().WithTopic(topic).Build());
    }
}

到这服务器与客户端脚本完成，接下来只需要写一些测试脚本，调用上面脚本的接口，即可完成服务器的开启/关闭，客户端连接，收发消息等功能。

测试上述功能的脚本如下，只需要加个ui，托一些按钮就可以。

using MQTT.Server;
using MQTTnet.Server;
using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;

public class Test : MonoBehaviour
{
    public Button StartBtn;
    public Button StopBtn;
    public Button ClientConnectBtn;
    public Button PublichBtn;
    public Button SubBtn;

    public Button SendBtn;
    MyMqttServer mqttServer = null;
    MyMqttClient client = null;
    private void Awake()
    {
        StartBtn?.onClick.AddListener(OnStartBtnClick);
        StopBtn?.onClick.AddListener(OnStopBtnClick);
        ClientConnectBtn?.onClick.AddListener(OnConnectBtnClick);
        PublichBtn?.onClick.AddListener(OnSendBtnClick);
        SubBtn?.onClick.AddListener(OnSubBtnClick);

        SendBtn?.onClick.AddListener(OndBtnClick);
    }

    private void OndBtnClick()
    {
        mqttServer.ServerPublich("2", "Message Test");
    }

    private void OnSubBtnClick()
    {
        client.Subscribe("2");
    }

    private void OnSendBtnClick()
    {
        client.PublishMsg("2", "Message Test!");
    }
     
    private void OnConnectBtnClick()
    {
        client = new MyMqttClient(Guid.NewGuid().ToString());
    }

    private void OnStopBtnClick()
    {
        if (mqttServer != null)
        {
            mqttServer.StopMqttServer();
        }
    }

    private void OnStartBtnClick()
    {
        if (mqttServer == null)
        {
            mqttServer = new MyMqttServer();
        }

        mqttServer.StartMqttServer();
    }
}

|十一|
关注
在Unity中开发MQTT客户端
R3333355726856的博客
08-13 1402
在Unity中开发MQTT客户端
c# 使用MQTT进行数据传输
c_hao的博客
05-07 6331
1.引入MQTTnet.dll 本例引用版本为3.0.15.0，如版本不一致，请参考最新官方文档：https://github.com/chkr1011/MQTTnet/wiki/Server
Unity 实现MQTT通讯
最新发布
weixin_44439733的博客
10-03 840
Unity实现MQTT通讯
Mqtt for Unity 完整工程包
11-17
工程中包含 测试工具 和 unity完整工程 unitypackge 包 功能完成正常可用 工程中包含 测试工具 和 unity完整工程 unitypackge 包 功能完成正常可用 工程中包含 测试工具 和 unity完整工程 unitypackge 包 功能完成正常可用
Unity MQTT
淡定九号的博客
06-01 2744
MQTT（消息队列遥测传输） 是一种轻量级的消息传输协议，它可以用于连接 IoT 设备和应用程序。MQTT 由 IBM 在 1999 年首次开发，现在已成为一个开放的 OASIS 标准。MQTT 的设计目标是提供一个简单、可靠、低功耗、易于实现的消息传输协议，适用于各种网络环境和设备。
Unity3D与MQTT的完美联姻 —— 引领物联网实时交互新时代
gitblog_00004的博客
06-15 661
Unity3D与MQTT的完美联姻 —— 引领物联网实时交互新时代 去发现同类优质开源项目:https://gitcode.com/ 一、项目介绍 在当今万物互联的时代背景下，Unity3D与MQTT的结合无疑为物联网（IoT）领域注入了新的活力。Unity3d MQTT，一个专注于展示如何在Unity3D平台上实现MQTT协议的小型项目，正引领着实时数据交互的新风向。该项目基于M2Mqtt，一款...
Unity中使用Mqtt协议进行通信-附件资源
03-05
Unity中使用Mqtt协议进行通信-附件资源
unity连接mqtt服务器测试，订阅主题，获取实时消息
07-31
unity连接mqtt服务器测试，支持导出pc端exe,web端没试过，支持订阅主题，获取实时消息。
unity制作的客户端，连接公网mqtt服务器的测试
08-09
在这个特定的场景中，我们关注的是Unity客户端与公网MQTT服务器的交互。MQTT（Message Queuing Telemetry Transport）是一种轻量级的发布/订阅消息协议，常用于物联网(IoT)设备之间的通信，因其低带宽、低功耗和可靠...
Unity程序使用MQTT进行通讯
zjp223的博客
06-13 1212
本文是一篇开发过程中的真实代码段，文中有详细的MQTT连接，MQTT接收消息、模拟向MQTT发送消息的，一些具体的代码块，具体配置文件大家看自己写的格式就好。
M2Mqtt_Unity3D
01-20
Unity3D可用的C#编程MQTT客户端库文件，在unity项目目录下的Assets目录下新建 Plugins 文件夹，并将 M2Mqtt.dll 和 M2Mqtt.pdb 两个文件放入其中即可完成导入
Unity HoloLens 状态下MQTT通讯解决方案
04-18
有文档阐述具体解决方案，以及相关的DLL库文件
[Unity3D]FTP与MQTT服务器搭建
qq_34593985的博客
04-27 1628
【Unity3D】 FTP与MQTT服务器搭建前言项目准备1.Unity3D2.云服务器3.远程连接4.端口扫描FTP服务器搭建与连接1.FTP服务器——vsftpd2.Unity3d连接FTP服务器MQTT服务器搭建与连接MQTT服务器——ActiveMQMQTT服务器——ApolloUnity3d连接MQTT服务器 前言 前些时间项目需要使用Unity3d做一套能够和FTP服务器与MQTT服务...
Unity实现MQTT
03-10
我可以回答这个问题。Unity可以通过使用MQTT库来实现MQTT协议的通信。可以使用Unity的C#脚本编写代码来连接MQTT服务器，发布和订阅主题，以及处理接收到的消息。同时，也可以使用Unity的UI组件来显示MQTT消息。
Unity中使用Mqtt协议进行通信
Benny Shader
02-15 6919
常见游戏后端 BackEnd支持协议越来越多，比如HTTP、TCP、UDP、MQTT等。各协议各有优点。 mqant框架 可以使用Module对Beego进行封装。 注意：使用_ "cpvrtapp/routers”进行初始化，不然是不能行的，没有调用Init MQTTNet https://github.com/landbroken/MQTTLearning 做为最基础的协议支持吧...
unity接入mqtt自救指南
CoderH 技术博客
06-27 1428
mqtt 客户端与服务端的使用
Unity 3D 使 用 MQTT 实 现 数 据 通 信
weixin_57716672的博客
10-13 3921
通过MQTTX软件测试Unity的MQTT通信
评论 25
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值