xamarin Mqtt
1 什么是MQTT?
mqtt (Message Queuing Telemetry Transport,消息队列遥测传输)是 IBM 开发的一个即时通讯协议,有可能成为物联网的重要组成部分。MQTT 是基于二进制消息的发布/订阅编程模式的消息协议,如今已经成为 OASIS 规范,由于规范很简单,非常适合需要低功耗和网络带宽有限的 IoT 场景。
2 MQTTnet
MQTTnet 是一个基于MQTT协议高度专业的.net库,它同时提供MQTT client和MQTT server(broke),支持v3.1.0,v3.1.1和v5.0.0的标准MQTT协议.
3 MQTTnet支持范围
.Net Standard 1.3+
.Net Core 1.1+
.Net Core App 1.1+
.Net Framework 4.5.2+(x86,x64,AnyCPU)
Mono 5.2+
Universal Windows Platform(UWP) 10.0.1024+(x86,x64,ARM,AnyCPU,Windwos 10 IoT Core)
Xamarin.Android 7.5+
Xamarin.iOS 10.14+
4 创建服务器
MQTT服务器以称为"消息代理"(Broker),可以是一个应用程序或一台设备。它是位于消息发布者和订阅者之间,它可以:
(1)接受来自客户的网络连接;
(2)接受客户发布的应用信息;
(3)处理来自客户端的订阅和退订请求;
(4)向订阅的客户转发应用程序消息。
服务器创建一个控制台应用,可选>>控制台应用(.NET Core)创建新项目MqttNetServer,代码如下:
sing MQTTnet;
using MQTTnet.Protocol;
using MQTTnet.Server;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.IO;
using System.Reflection;
using System.Security.Cryptography.X509Certificates;
using System.Text;
using System.Threading.Tasks; namespace MqttServerTest
{
class Program
{
public static IMqttServer mqttServer;
static void Main(string[] args)
{
mqttServer = new MQTTnet.MqttFactory().CreateMqttServer();
mqttServer.UseClientConnectedHandler(e =>
{
Console.WriteLine("***new connect:" + e.ClientId); });
mqttServer.UseClientDisconnectedHandler(e =>
{
Console.WriteLine("*** disconnect:" + e.ClientId);
}); //var options = new MqttServerOptions();
//await mqttServer.StartAsync(options); //var currentPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
//var certificate = new X509Certificate2(Path.Combine(currentPath, "certificate.pfx"), "yourPassword", X509KeyStorageFlags.Exportable); var optionsBuilder = new MqttServerOptionsBuilder()
.WithConnectionBacklog()
.WithDefaultEndpointPort()
.WithConnectionValidator(c=> {
//c.SessionItems.
//if (c.ClientId.Length < 10)
//{
// c.ReturnCode = MqttConnectReturnCode.ConnectionRefusedIdentifierRejected;
// //c.ReasonCode = MqttConnectReasonCode.ClientIdentifierNotValid;
// return;
//}
//if (c.Username != "mySecretUser")
//{
// c.ReturnCode = MqttConnectReturnCode.ConnectionRefusedBadUsernameOrPassword;
// return;
//} //if (c.Password != "mySecretPassword")
//{
// c.ReturnCode = MqttConnectReturnCode.ConnectionRefusedBadUsernameOrPassword;
// return;
//} c.ReturnCode = MqttConnectReturnCode.ConnectionAccepted;
Console.WriteLine("***connect validator:"+c.ClientId);
})
//.WithEncryptionCertificate(certificate.Export(X509ContentType.Pfx))
//.WithEncryptionSslProtocol(SslProtocols.Tls12)
.WithApplicationMessageInterceptor(context=> {
//if (context.ApplicationMessage.Topic == "my/custom/topic")
//{
// context.ApplicationMessage.Payload = Encoding.UTF8.GetBytes("The server injected payload.");
//}
//// It is possible to disallow the sending of messages for a certain client id like this:
//if (context.ClientId != "Someone")
//{
// context.AcceptPublish = false;
// return;
//}
// It is also possible to read the payload and extend it. For example by adding a timestamp in a JSON document.
// This is useful when the IoT device has no own clock and the creation time of the message might be important. context.AcceptPublish = true;
Console.WriteLine("***Message:" + context.ApplicationMessage.Payload);
})
.WithSubscriptionInterceptor(context=>
{
//if (context.TopicFilter.Topic.StartsWith("admin/foo/bar") && context.ClientId != "theAdmin")
//{
// context.AcceptSubscription = false;
//} //if (context.TopicFilter.Topic.StartsWith("the/secret/stuff") && context.ClientId != "Imperator")
//{
// context.AcceptSubscription = false;
// context.CloseConnection = true;
//} context.AcceptSubscription = true;
Console.WriteLine("***Subscript:" + context.TopicFilter);
})
//.WithStorage(new RetainedMessageHandler())
;
var options = optionsBuilder.Build(); //// Setting the options
//options.Storage=new RetainedMessageHandler(); StartServer(options); Console.WriteLine("Press any key to exit.");
Console.ReadLine(); //await mqttServer.StopAsync();
} public static async void StartServer(IMqttServerOptions options)
{
await mqttServer.StartAsync(options);
} } // The implementation of the storage:
// This code uses the JSON library "Newtonsoft.Json".
public class RetainedMessageHandler : IMqttServerStorage
{
private const string Filename = "C:\\MQTT\\RetainedMessages.json"; public Task SaveRetainedMessagesAsync(IList<MqttApplicationMessage> messages)
{
File.WriteAllText(Filename, JsonConvert.SerializeObject(messages));
return Task.FromResult();
} public Task<IList<MqttApplicationMessage>> LoadRetainedMessagesAsync()
{
IList<MqttApplicationMessage> retainedMessages;
if (File.Exists(Filename))
{
var json = File.ReadAllText(Filename);
retainedMessages = JsonConvert.DeserializeObject<List<MqttApplicationMessage>>(json);
}
else
{
retainedMessages = new List<MqttApplicationMessage>();
} return Task.FromResult(retainedMessages);
}
} }
代码直接运行起来,就是一个简单的Mqtt server。
5 创建xamarin APP
一个使用MQTT协议的应用程序或者设备,它总是建立到服务器的网络连接。客户端可以:
(1)发布其他客户端可能会订阅的信息;
(2)订阅其它客户端发布的消息;
(3)退订或删除应用程序的消息;
(4)断开与服务器连接。
在VS中新建一个xamarin.Forms的移动应用,创建好后在Nuget上搜索mqttnet,添加对MQTTnet包的引用。更改代码如下:
<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:local="clr-namespace:CatShell"
x:Class="CatShell.MainPage"> <StackLayout>
<!-- Place new controls here -->
<Label Text="SubscribeTopic"/>
<Entry x:Name="txtSubTopic" Placeholder="Subscribe Topic" />
<Button Text="BtnSubscribe" Clicked="SubButton_Clicked"/>
<Entry x:Name="txtReceiveMessage"/>
<Label Text="PublishTopic"/>
<Entry x:Name="txtPubTopic"/>
<Entry x:Name="txtSendMessage" />
<Button Text="Publish" Clicked="PubButton_Clicked"/>
<Editor> </Editor> </StackLayout> </ContentPage>
using MQTTnet;
using MQTTnet.Client;
using MQTTnet.Client.Options;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Xamarin.Forms; namespace CatShell
{
public partial class MainPage : ContentPage
{
public IMqttClient mqttClient;
public IMqttClientOptions options;
public MainPage()
{
InitializeComponent();
InitMqttClient();
ConnectMqttServer();
} public void InitMqttClient()
{
// Create a new MQTT client.
var factory = new MqttFactory();
mqttClient = factory.CreateMqttClient(); mqttClient.UseConnectedHandler(e => { Device.BeginInvokeOnMainThread(() =>
{
txtReceiveMessage.Text = txtReceiveMessage.Text + $">> connect success." + Environment.NewLine;
});
});
mqttClient.UseDisconnectedHandler(e =>
{
Device.BeginInvokeOnMainThread(() =>
{
txtReceiveMessage.Text = txtReceiveMessage.Text + $">> Disconnect." + Environment.NewLine;
});
});
mqttClient.UseApplicationMessageReceivedHandler(e =>
{
Device.BeginInvokeOnMainThread(() =>
{
txtReceiveMessage.Text = $">> {Encoding.UTF8.GetString(e.ApplicationMessage.Payload)}" + Environment.NewLine;
});
}); // Create TCP based options using the builder.
options = new MqttClientOptionsBuilder()
.WithClientId("Client4")
.WithTcpServer("10.100.1.247", ) // Use TCP connection, Port is opptinal
//.WithWebSocketServer("broker.hivemq.com:8000/mqtt") // Use WebSocket connection.
//.WithCredentials("bud", "%spencer%")
//.WithTls()
//.WithTls(new MqttClientOptionsBuilderTlsParameters
//{
// UseTls = true,
// CertificateValidationCallback = (X509Certificate x, X509Chain y, SslPolicyErrors z, IMqttClientOptions o) =>
// {
// // TODO: Check conditions of certificate by using above parameters.
// return true;
// }
//})
.WithCleanSession()
.Build(); } public async void ConnectMqttServer()
{
await mqttClient.ConnectAsync(options, CancellationToken.None); // Since 3.0.5 with CancellationToken } private async void SubButton_Clicked(object sender, EventArgs e)
{ string topic = txtSubTopic.Text.Trim(); if (string.IsNullOrEmpty(topic))
{
//MessageBox.Show("订阅主题不能为空!");
return;
} if (!mqttClient.IsConnected)
{
//MessageBox.Show("MQTT客户端尚未连接!");
return;
} // Subscribe to a topic
await mqttClient.SubscribeAsync(new TopicFilterBuilder().WithTopic(topic).Build()); txtReceiveMessage.Text = txtReceiveMessage.Text + $"已订阅[{topic}]主题" + Environment.NewLine;
txtSubTopic.IsReadOnly = false;
//BtnSubscribe.Enabled = false;
} private async void PubButton_Clicked(object sender, EventArgs e)
{
string topic = txtPubTopic.Text.Trim(); if (string.IsNullOrEmpty(topic))
{
//MessageBox.Show("发布主题不能为空!");
return;
} string inputString = txtSendMessage.Text.Trim(); PublishMessages(topic, inputString);
} public async void PublishMessages(string topicMsg, string payloadMsg)
{
var message = new MqttApplicationMessageBuilder()
.WithTopic(topicMsg)
.WithPayload(payloadMsg)
.WithExactlyOnceQoS()
.WithRetainFlag()
.Build(); await mqttClient.PublishAsync(message);
} }
}
代码运行起来,在APP上可以直接发信息。
6 创建winForm client(可选)
可以创建一个winForm来相互互动,在VS上新建一个windows窗体应用(.NET Framework),界面设计如下
后台代码如下:
using MQTTnet;
using MQTTnet.Client.Options;
using MQTTnet.Client;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Net.Security;
using System.Security.Cryptography.X509Certificates;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms; namespace MqttClientWin
{
public partial class Form1 : Form
{
public IMqttClient mqttClient;
public IMqttClientOptions options;
public Form1()
{
InitializeComponent();
InitMqttClient();
ConnectMqttServer();
} public void InitMqttClient()
{
// Create a new MQTT client.
var factory = new MqttFactory();
mqttClient = factory.CreateMqttClient(); mqttClient.UseApplicationMessageReceivedHandler(e =>
{
Console.WriteLine("### RECEIVED APPLICATION MESSAGE ###");
Console.WriteLine($"+ Topic = {e.ApplicationMessage.Topic}");
Console.WriteLine($"+ Payload = {Encoding.UTF8.GetString(e.ApplicationMessage.Payload)}");
Console.WriteLine($"+ QoS = {e.ApplicationMessage.QualityOfServiceLevel}");
Console.WriteLine($"+ Retain = {e.ApplicationMessage.Retain}");
Console.WriteLine(); this.Invoke(new Action(() =>
{
txtReceiveMessage.AppendText($">> {Encoding.UTF8.GetString(e.ApplicationMessage.Payload)}{Environment.NewLine}");
})); //Task.Run(() => mqttClient.PublishAsync("hello/world"));
}); mqttClient.UseConnectedHandler(async e =>
{
Console.WriteLine("### CONNECTED WITH SERVER ###"); //// Subscribe to a topic
//await mqttClient.SubscribeAsync(new TopicFilterBuilder().WithTopic("my/topic").Build()); //Console.WriteLine("### SUBSCRIBED ###"); this.Invoke(new Action(() =>
{
txtReceiveMessage.AppendText($">> connect success.{Environment.NewLine}");
}));
}); mqttClient.UseDisconnectedHandler(e =>
{
this.Invoke(new Action(() =>
{
txtReceiveMessage.AppendText($">> Disconnect .{Environment.NewLine}");
}));
}); // Create TCP based options using the builder.
options = new MqttClientOptionsBuilder()
.WithClientId("Client5")
.WithTcpServer("10.100.1.247", ) // Use TCP connection, Port is opptinal
//.WithWebSocketServer("broker.hivemq.com:8000/mqtt") // Use WebSocket connection.
//.WithCredentials("bud", "%spencer%")
//.WithTls()
//.WithTls(new MqttClientOptionsBuilderTlsParameters
//{
// UseTls = true,
// CertificateValidationCallback = (X509Certificate x, X509Chain y, SslPolicyErrors z, IMqttClientOptions o) =>
// {
// // TODO: Check conditions of certificate by using above parameters.
// return true;
// }
//})
.WithCleanSession()
.Build(); } public async void ConnectMqttServer()
{
await mqttClient.ConnectAsync(options, CancellationToken.None); // Since 3.0.5 with CancellationToken } public void ReconnectMqttServer()
{
mqttClient.UseDisconnectedHandler(async e =>
{
Console.WriteLine("### DISCONNECTED FROM SERVER ###");
await Task.Delay(TimeSpan.FromSeconds()); try
{
await mqttClient.ConnectAsync(options, CancellationToken.None); // Since 3.0.5 with CancellationToken
}
catch
{
Console.WriteLine("### RECONNECTING FAILED ###");
}
});
} public async void PublishMessages(string topicMsg,string payloadMsg)
{
var message = new MqttApplicationMessageBuilder()
.WithTopic(topicMsg)
.WithPayload(payloadMsg)
.WithExactlyOnceQoS()
.WithRetainFlag()
.Build(); await mqttClient.PublishAsync(message);
} private async void BtnSubscribe_Click(object sender, EventArgs e)
{
string topic = txtSubTopic.Text.Trim(); if (string.IsNullOrEmpty(topic))
{
MessageBox.Show("订阅主题不能为空!");
return;
} if (!mqttClient.IsConnected)
{
MessageBox.Show("MQTT客户端尚未连接!");
return;
} // Subscribe to a topic
await mqttClient.SubscribeAsync(new TopicFilterBuilder().WithTopic(topic).Build()); 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(); PublishMessages(topic, inputString); }
}
}
7 MQTT协议中的订阅、主题、会话
一、订阅(Subscription)
订阅包含主题筛选器(Topic Filter)和最大服务质量(QoS)。订阅会与一个会话(Session)关联。一个会话可以包含多个订阅。每一个会话中的每个订阅都有一个不同的主题筛选器。
二、会话(Session)
每个客户端与服务器建立连接后就是一个会话,客户端和服务器之间有状态交互。会话存在于一个网络之间,也可能在客户端和服务器之间跨越多个连续的网络连接。
三、主题名(Topic Name)
连接到一个应用程序消息的标签,该标签与服务器的订阅相匹配。服务器会将消息发送给订阅所匹配标签的每个客户端。
四、主题筛选器(Topic Filter)
一个对主题名通配符筛选器,在订阅表达式中使用,表示订阅所匹配到的多个主题。
五、负载(Payload)
消息订阅者所具体接收的内容。
8 MQTT协议中的方法
MQTT协议中定义了一些方法(也被称为动作),来于表示对确定资源所进行操作。这个资源可以代表预先存在的数据或动态生成数据,这取决于服务器的实现。通常来说,资源指服务器上的文件或输出。主要方法有:
(1)Connect。等待与服务器建立连接。
(2)Disconnect。等待MQTT客户端完成所做的工作,并与服务器断开TCP/IP会话。
(3)Subscribe。等待完成订阅。
(4)UnSubscribe。等待服务器取消客户端的一个或多个topics订阅。
(5)Publish。MQTT客户端发送消息请求,发送完成后返回应用程序线程。
xamarin Mqtt的更多相关文章
- Xamarin+Prism开发详解六:DependencyService与IPlatformInitializer的关系
祝各位2017年事业辉煌!开年第一篇博客,继续探索Xamarin.Forms… 为什么我做Xamarin开发的时候中意于Prism.Forms框架?本章为你揭晓. 实例代码地址:https://git ...
- xamarin DependencyService源码阅读
xamarin在面对PCL无法实现的各平台特有功能时使用了一种叫[DependencyService]的方式来实现.它使得xamarin能像原生平台一样做平台能做到的事情!主要分四个部分 接口:定义功 ...
- Xamarin与Visual stuido2015离线安装包分享
最近看见大伙留言才知道国内安装Xamarin开发原来这么艰辛啊! 第一:网速不快 第二:Android SDK下载受限 等等... 鉴于这些原因,特写下这篇文章以及分享打包好的离线包以帮助大家尽快体验 ...
- Xamarin+Prism开发详解五:页面布局基础知识
说实在的研究Xamarin到现在,自己就没设计出一款好的UI,基本都在研究后台逻辑之类的!作为Xamarin爱好者,一些简单的页面布局知识还是必备的. 布局常见标签: StackLayout Abso ...
- Xamarin+Prism开发详解四:简单Mac OS 虚拟机安装方法与Visual Studio for Mac 初体验
Mac OS 虚拟机安装方法 最近把自己的电脑升级了一下SSD固态硬盘,总算是有容量安装Mac 虚拟机了!经过心碎的安装探索,尝试了国内外的各种安装方法,最后在youtube上找到了一个好方法. 简单 ...
- Xamarin+Prism开发详解三:Visual studio 2017 RC初体验
Visual studio 2017 RC出来一段时间了,最近有时间就想安装试试,随带分享一下安装使用体验. 1,卸载visual studio 2015 虽然可以同时安装visual studio ...
- Xamarin+Prism开发详解二:Xaml文件如何简单绑定Resources资源文件内容
我们知道在UWP里面有Resources文件xxx.resx,在Android里面有String.Xml文件等.那跨平台如何统一这些类别不一的资源文件以及Xaml设计文件如何绑定这些资源?应用支持多国 ...
- Xamarin+Prism开发详解一:PCL跨平台类库与Profile的关系
在[Xamarin+Prism小试牛刀:定制跨平台Outlook邮箱应用]中提到过以下错误,不知道大伙还记得不: 无法安装程序包"Microsoft.Identity.Client 1.0. ...
- Xamarin+Prism小试牛刀:定制跨平台Outlook邮箱应用
通过本文你将学会如下内容: 1,如何使用Xamarin开发跨平台(Windows,Android,iOS)应用. 2,如何使用微软的登录界面登入Microsoft账号. 3,如何使用Outlook邮箱 ...
随机推荐
- 基于 Docker 的 MySQL 主从复制搭建
出处:https://www.jianshu.com/p/ab20e835a73f
- redis 在 windows 中的安装
redis 在 windows 中的安装 redis 官方并没有提供 redis 的 windows 版本.但是微软提供了 redis 的 windows 版本.有2.8和3.0版本.3.0版本支持集 ...
- 13 opencv训练器
https://blog.csdn.net/WZZ18191171661/article/details/91305466 https://blog.csdn.net/qq_25352981/arti ...
- A1033 To Fill or Not to Fill (25 分)
一.技术总结 是贪心算法的题目,题目主要考虑的问题有几个,是否会在第一个加油站的最近距离大于0,如果是这样那么直接输出答案,因为初始油箱没有汽油: 第二个是如何选定加油站,如果在可到达距离范围类,我们 ...
- 关于Design Complier/Library Compiler的跌坑(坑爹)记录
最近需要用DC做一些事,然后需要转库,中午偷个闲,特来记录一下中间的一些坎坷. 1.首先是要转库.我们只有.lib文件的格式,所以需要把.lib文件转换成.db格式.然后坑来了!!!DC2015及以后 ...
- SQLAIchemy 学习(一)Session 相关
0. 前言 最近是使用 SQLAlchemy 框架作为一个 ORM 框架,现对其做简单整理 1. 创建 Session 说到数据库,就离不开 Session.Session 的主要目的是建立与数据库的 ...
- 雪花算法(snowflake)的JAVA实现
snowflake算法由twitter公司出品,原始版本是scala版,用于生成分布式ID,结构图: 算法描述: 最高位是符号位,始终为0,不可用. 41位的时间序列,精确到毫秒级,41位的长度可以使 ...
- 五年微软DevOps MVP (也称TFS MVP)
笔者有幸第五次被微软授予MVP称号,高兴之余,在这里简单的介绍一下MVP的基本情况: 谁是 MVP? Microsoft 最有价值专家 (MVP) 是热情地与社区分享知识的技术专家.他们总是处于&qu ...
- kibana无法显示elasticsearch中的index
我是用的logstash将kafka中的数据同步到elasticsearch.logstash和kafka在同一台服务器,elasticsearch在另外的服务器上. 经过排查,是因为我的logsta ...
- python jieba 分词进阶
https://www.cnblogs.com/jiayongji/p/7119072.html 文本准备 到网上随便一搜"三体全集",就很容易下载到三体三部曲的全集文本(txt文 ...