C# RPC 远程RPC调用 C#服务器设计 CS架构设计 远程API接口 RPC可视化 MqttRpc实现 HslCommunication远程调用，同步网络访问，进度报告
今天来说说C#的远程RPC调用，当然其实不止是限于C#，这个RPC对JAVA，Python都是支持的，好了，进入主题
开始之前先介绍下：hslcommunication 官网：http://www.hslcommunication.cn/
本功能需要最新版 V9.5.0以上支持
在Visual Studio 中的NuGet管理器中可以下载安装，也可以直接在NuGet控制台输入下面的指令安装：
Install-Package HslCommunication
如果需要教程：Nuget安装教程：http://www.cnblogs.com/dathlin/p/7705014.html
组件的完整信息和API介绍参照：http://www.cnblogs.com/dathlin/p/7703805.html 组件的使用限制，更新日志，都在该页面里面。
本库的demo源代码地址：https://github.com/dathlin/HslCommunication
之前也有写文章介绍到，侧重的是发布订阅，数据推送的实现 https://www.cnblogs.com/dathlin/p/13416030.html 但是此处更新了东西，再写一篇文章，介绍。
我们通常都有什么需求呢？服务，多个程序通信，多个电脑通信的需求。就好比下面的场景。
本质上来说，就是客户端发送数据到服务器，服务器处理，返回数据给客户端。服务器只要识别不同的请求就OK，最好这个客户端带有账户密码功能，进度报告功能，本着这个设计思路，在HslCommunication实现了远程RPC调用。看下面的代码使用
我们开始由简单到复杂，我就很简单的创建一个服务，然后返回一串数据给客户端。我有个winform的程序作为服务器，无所谓winform还是控制台的。
private void FormClient_Load( object sender, EventArgs e )
{
ServerStart( );
}
private MqttServer mqttServer;
private void ServerStart( )
{
mqttServer = new MqttServer( );
mqttServer.OnClientApplicationMessageReceive += MqttServer_OnClientApplicationMessageReceive;
mqttServer.ServerStart( 1883 );
}
private void MqttServer_OnClientApplicationMessageReceive( MqttSession session, MqttClientApplicationMessage message )
{
if (session.Protocol != "MQTT")
{
// 测试回传一条数据信息
mqttServer.PublishTopicPayload( session, "Test", Encoding.UTF8.GetBytes( "这是回传的一条测试数据" ) );
}
}
服务器很简单，其中的 if (session.Protocol != "MQTT") 这个是必须的，只有不是MQTT协议头的，才是RPC调用的请求。
这个服务器就是一个很简单的信息，不管服务器来啥数据，我都返回Test,这是回传的一条测试数据。
那么我们的客户应该怎么写呢？客户端的写法都是一致的，都是实例化对象，连，读
MqttSyncClient syncClient = new MqttSyncClient( "127.0.0.1", 1883 );
OperateResult<string, string> read = syncClient.ReadString( "", null );
if (read.IsSuccess)
{
MessageBox.Show( read.Content2 );
}
else
{
MessageBox.Show( "失败：" + read.Message );
}
当然，客户端最后，把syncClient定义成全局变量，然后设置长连接。就像这样。
private void FormClient_Load( object sender, EventArgs e )
{
syncClient = new MqttSyncClient( "127.0.0.1", 1883 );
syncClient.SetPersistentConnection( );
}
private MqttSyncClient syncClient;
private void Button_1_click( )
{
OperateResult<string, string> read = syncClient.ReadString( "", null );
if (read.IsSuccess)
{
MessageBox.Show( read.Content2 );
}
else
{
MessageBox.Show( "失败：" + read.Message );
}
}
这个变量syncClient就可以到处使用了，当然了我下面的演示都是直接那DEMO测试，本质都是调用ReadString
然后我们启动刚才的服务器端，现在现实收到了。
现在我们发现服务器每次返回的都是一致的，我现在想根据客户端请求的不同，返回不同的数据。比如我有个西门子PLC。我想根据客户端不同的请求命令，来响应不同的结果。
这时候就需要加入西门子的通信对象了
private void FormClient_Load( object sender, EventArgs e )
{
ServerStart( );
siemens = new SiemensS7Net( SiemensPLCS.S1200, "192.168.8.12" );
siemens.SetPersistentConnection( );
}
private MqttServer mqttServer;
private SiemensS7Net siemens;
然后我们来实现远程的操作。
private void MqttServer_OnClientApplicationMessageReceive( MqttSession session, MqttClientApplicationMessage message )
{
if (session.Protocol != "MQTT")
{
if (message.Topic == "STOP")
{
OperateResult write = siemens.Write( "M100.0", false );
if (write.IsSuccess)
mqttServer.PublishTopicPayload( session, "Success", Encoding.UTF8.GetBytes( "停止设备成功" ) );
else
mqttServer.ReportOperateResult( session, write.Message ); // 停止失败了
}
else if (message.Topic == "START")
{
OperateResult write = siemens.Write( "M100.0", true );
if (write.IsSuccess)
mqttServer.PublishTopicPayload( session, "Success", Encoding.UTF8.GetBytes( "启动设备成功" ) );
else
mqttServer.ReportOperateResult( session, write.Message ); // 启动失败了
}
else
{
mqttServer.ReportOperateResult( session, "不支持的功能" ); // 其他的命令返回不支持的内容
}
}
}
因为MqttServer支持报告结果，如果result.IsSuccess为true, 客户端就读取true，如果result.IsSuccess为false，客户端就读取到False
public void ReportOperateResult( MqttSession session, OperateResult<string> result )
上述的代码可以精简为，
private void MqttServer_OnClientApplicationMessageReceive( MqttSession session, MqttClientApplicationMessage message )
{
if (session.Protocol != "MQTT")
{
if (message.Topic == "STOP")
{
mqttServer.ReportOperateResult( session, siemens.Write( "M100.0", false ).Convert<string>("停止设备成功") );
}
else if (message.Topic == "START")
{
mqttServer.ReportOperateResult( session, siemens.Write( "M100.0", true ).Convert<string>( "启动设备成功" ) );
}
else
{
mqttServer.ReportOperateResult( session, "不支持的功能" ); // 其他的命令返回不支持的内容
}
}
}
我们再来运行一下
我输入了A，就显示不支持的功能，我再试试看输入，START
这时候，PLC的网络是好的，就返回了正确的数据，我们强制给断线，看看会返回什么结果。Read按钮之后，等待了10秒钟，返回了错误信息，这个信息是siemens对象写入失败的信息，直接传递给了客户端。
好了，接下来开始讨论高级一点内容。我想实现一个直接ReadInt16的接口，传入地址和长度信息。所以客户端上传的数据用JSON封装 "{ "Address": "M100", "Length":10 }"
那么我在服务器这么写
private void MqttServer_OnClientApplicationMessageReceive( MqttSession session, MqttClientApplicationMessage message )
{
if (session.Protocol != "MQTT")
{
if (message.Topic == "STOP")
{
mqttServer.ReportOperateResult( session, siemens.Write( "M100.0", false ).Convert<string>("停止设备成功") );
}
else if (message.Topic == "START")
{
mqttServer.ReportOperateResult( session, siemens.Write( "M100.0", true ).Convert<string>( "启动设备成功" ) );
}
else if (message.Topic == "ReadInt16")
{
JObject json = JObject.Parse( Encoding.UTF8.GetString( message.Payload ) );
string address = json["Address"].Value<string>( );
ushort length = json["Length"].Value<ushort>( );
mqttServer.ReportOperateResult( session,
siemens.ReadInt16( address, length ).Then( m => OperateResult.CreateSuccessResult( m.ToJsonString( ) ) ) );
}
else
{
mqttServer.ReportOperateResult( session, "不支持的功能" ); // 其他的命令返回不支持的内容
}
}
}
然后我们在客户端操作一下
非常好，如果我们传入的字符串写错了呢？比如 { "Address": "M100", "Length":10 少写了个}。服务器就会奔溃，我们只能改代码
private void MqttServer_OnClientApplicationMessageReceive( MqttSession session, MqttClientApplicationMessage message )
{
if (session.Protocol != "MQTT")
{
if (message.Topic == "STOP")
{
mqttServer.ReportOperateResult( session, siemens.Write( "M100.0", false ).Convert<string>( "停止设备成功" ) );
}
else if (message.Topic == "START")
{
mqttServer.ReportOperateResult( session, siemens.Write( "M100.0", true ).Convert<string>( "启动设备成功" ) );
}
else if (message.Topic == "ReadInt16")
{
try
{
JObject json = JObject.Parse( Encoding.UTF8.GetString( message.Payload ) );
string address = json["Address"].Value<string>( );
ushort length = json["Length"].Value<ushort>( );
mqttServer.ReportOperateResult( session,
siemens.ReadInt16( address, length ).Then( m => OperateResult.CreateSuccessResult( m.ToJsonString( ) ) ) );
}
catch (Exception ex)
{
mqttServer.ReportOperateResult( session, "读取失败：" + ex.Message );
}
}
else
{
mqttServer.ReportOperateResult( session, "不支持的功能" ); // 其他的命令返回不支持的内容
}
}
}
然后我在读取就会出现。
这时候比较好的提示了信息。
我们的程序通常都有很多的接口，也就是很多不同的Topic，然后很多的接口都会有参数，如果按照这个来写，那我不是累死了，而且代码又很难看，又混乱。确实是这样的。而且还有个问题，我客户端是不支持查询服务器有哪些接口的，如果客户端服务器都是我自己一个人写的，我还能参考服务器的源代码，然后看查询接口信息和参数信息，如果客户端是别人写的呢？我还要维护一份接口列表，给到对方，一旦服务器端发生接口更改了，又得改接口文档，太麻烦了，那么这种情况，hsl怎么来解决呢？
答案就是注册M-RPC服务，我称之为基于Mqtt协议的HSL标准的RPC实现。就简称为M-RPC服务。
这是分割线，接下来才是V9.5.0实现的内容，激动人心的时刻要来了。
我们现在来实现刚才实现了三个功能接口，重新做一遍，就发现区别了。
private void FormClient_Load( object sender, EventArgs e )
{
ServerStart( );
siemens = new SiemensS7Net( SiemensPLCS.S1200, "192.168.8.12" );
siemens.SetPersistentConnection( );
}
private MqttServer mqttServer;
private SiemensS7Net siemens;
private void ServerStart( )
{
mqttServer = new MqttServer( );
mqttServer.OnClientApplicationMessageReceive += MqttServer_OnClientApplicationMessageReceive;
mqttServer.ServerStart( 1883 );
// 注册服务
mqttServer.RegisterMqttRpcApi( this );
}
private void MqttServer_OnClientApplicationMessageReceive( MqttSession session, MqttClientApplicationMessage message )
{
if (session.Protocol != "MQTT")
{
mqttServer.ReportOperateResult( session, "不支持的功能" ); // 其他的命令返回不支持的内容
}
}
[HslMqttApi]
public OperateResult Start( )
{
return siemens.Write( "M100.0", true );
}
[HslMqttApi]
public OperateResult Stop( )
{
return siemens.Write( "M100.0", false );
}
[HslMqttApi]
public OperateResult<short[]> Read(string address, ushort length )
{
return siemens.ReadInt16( address, length );
}
上面代码的HslMqttApi特性很重要，如果这个方法没有实现这个特性，就不会公开访问，我们在用客户端连接的时候，就出现了有意思的东西，当我们连上的一瞬间，客户端的左侧就出现了已经注册好的Topic的列表
我们看到这个注册的Topic服务，默认是注册对象的类名+方法名，那么我们可以修改么？当然可以，稍后讲解，先来看看点击其中的Read会发生什么事
自动将参数格式填好了，值需要我们来修改一下
M-RPC诚不欺我也，我们看到可以准确的返回数据，返回的是一个json格式数组，我们可以提取出，或是转化出我们实际数据。
我们再来看看有没有啥高级的功能？？？？
1. 方法注释功能，我们可以在服务器里对方法进行注释，客户端看到方法就知道含义了。怎么操作呢？
[HslMqttApi("读取PLC数据的内容，传入地址和长度，返回short[]信息")]
public OperateResult<short[]> Read(string address, ushort length )
{
return siemens.ReadInt16( address, length );
}
好了，我们然后再打开客户端的时候，选中Read方法
哇，这个使用起来真是好，那岂不是我以后写好服务器的接口好，和另外一个同事或是别的厂家的人说，我们的接口是M-RPC服务，你自己连上去看看就知道了。
2. 动态修改方法的API接口，比如我已经定义了Read方法，但是在接口里，我就不想叫Read，还有个情况是，注册服务不支持重载的方法，如果两个方法名一致，但都要实现M-RPC的，只能动态修改API接口。
[HslMqttApi( "ReadData", "读取PLC数据的内容，传入地址和长度，返回short[]信息")]
public OperateResult<short[]> Read(string address, ushort length )
{
return siemens.ReadInt16( address, length );
}
这样，就修改成功了，对客户端来说，这个就等同于ReadData，当然了，你想取任何的名称都可以的。
看到已经修改掉了。
3. 动态修改类的API接口
前面注册之后的，都是带FormMqttServer，我不想要这个，或是换成别的。我先试试看去除这个FormMqttServer
private void ServerStart( )
{
mqttServer = new MqttServer( );
mqttServer.OnClientApplicationMessageReceive += MqttServer_OnClientApplicationMessageReceive;
mqttServer.ServerStart( 1883 );
// 注册服务
mqttServer.RegisterMqttRpcApi( "", this );
}
注册服务里，只需要指定apiTopic参数为空就可以了。
我换成另一个试试看。
// 注册服务 mqttServer.RegisterMqttRpcApi( "Devices", this );
如果我注册的APITopic里带斜杠会怎么样？我假设我有很多厂，要注册很多的服务的。
// 注册服务 mqttServer.RegisterMqttRpcApi( "Factory1/Devices", this );
嗯，很好，这样的话，我可以定义很多个对象，有账户验证接口的服务，有设备数据交互的服务，有财务接口，有ERP的接口，等等都可以进行注册了。
4. 权限问题，既然我可以注册很多接口，我想要进行权限控制，目前支持对mqttSesiion的ClientID和UserName控制，举个例子，我的读取数据的接口只想对admin账户开发，其他没有权限
[HslMqttApi( "ReadData", "读取PLC数据的内容，传入地址和长度，返回short[]信息")]
[HslMqttPermission(UserName ="admin")]
public OperateResult<short[]> Read(string address, ushort length )
{
return siemens.ReadInt16( address, length );
}
我们再增加一个特性，就可以控制权限，客户端登录后，
当我用admin账户登录的时候，就可以支持了。
那么服务器如何控制登录的账户信息呢？
MqttServer有个事件，验证的事件，进行修改验证即可。
private void ServerStart( )
{
mqttServer = new MqttServer( );
mqttServer.OnClientApplicationMessageReceive += MqttServer_OnClientApplicationMessageReceive;
mqttServer.ClientVerification += MqttServer_ClientVerification;
mqttServer.ServerStart( 1883 );
// 注册服务
mqttServer.RegisterMqttRpcApi( "Devices", this );
}
private int MqttServer_ClientVerification( string clientId, string userName, string passwrod )
{
if (userName == "admin" && passwrod == "123456")
{
return 0; // 成功
}
else
{
return 5; // 账号密码验证失败
}
}
这样就可以控制那些账户可以登录。
5. 手动获取API信息，
代码上的实现如下：
private void button7_Click( object sender, EventArgs e )
{
OperateResult<MqttRpcApiInfo[]> read = mqttSyncClient.ReadRpcApis( );
if (read.IsSuccess)
{
textBox8.Text = read.Content.ToJsonString( );
}
else
{
MessageBox.Show( "Read Failed:" + read.Message );
}
}
最后，我们来说说另一个有意思的功能，hsl自带的plc通信类，机器人通讯类，都实现了 HslMqttApi 特性类，这会发生什么事呢？高潮部分来了！！！！
如果我的一个PLC，只和我的服务器程序连接，其他所有的客户端都只能走我这去连接plc，是不是我只要注册个PLC就ok了？我来试试
private void ServerStart( )
{
mqttServer = new MqttServer( );
mqttServer.OnClientApplicationMessageReceive += MqttServer_OnClientApplicationMessageReceive;
mqttServer.ServerStart( 1883 );
// 注册服务
mqttServer.RegisterMqttRpcApi( "Devices", this );
mqttServer.RegisterMqttRpcApi( "PLC", siemens );
}
就加了一行代码，我们再打开客户端看看。
我发现我可以远程读写PLC了，嗯，再看看能不能读取订阅号
我去，还真可以。到目前为止M-RPC已经展示了一些核心的功能和特性，因为支持byte[]数组交互，当然还有支持文件上传下载，进度报告，这些内容在
https://www.cnblogs.com/dathlin/p/13416030.html
已经说明过了，M-RPC功能还在不断丰富和增强中，感谢使用和支持，如有需要。可以联系
