Asp.Net Core使用SignalR进行服务间调用方法示例
网上查询过很多关于asp.net core使用signalr的简单例子，但是大部分都是简易聊天功能，今天心血来潮就搞了个使用signalr进行服务间调用的简单demo。
至于signalr是什么我就不多说了，微软官方文档也不少。
第一步新建项目
所有vs开发第一步都是新建一个解决方案哈，这里我就不多介绍如何新建项目啦~~
- 开发环境，vs2017,.net core 2.1
- 新建两个asp.net core项目
如此简单的操作大家都懂的
注入signalr
在被调用的服务端的startup.cs中注入signalr 在asp.net core2.1中已经默认包含了signalr的库，直接在 configureservices 方法中添加如下代码：
services.addsignalr().addmessagepackprotocol()
addmessagepackprotocol() 表示启用 messagepack 支持在服务器上
新建一个继承hub类的类
public class serverhub : hub
{
}
里面可以实现需要被客户端执行的方法。
配置hub连接url
在 startup.cs 的 configure 添加下面代码
app.usesignalr(routes =>
{
routes.maphub<serverhub>("/myserver");
});
添加服务
新建一个services文件夹，添加我们的服务接口和接口实现类。
public interface imyservice
{
task<string> sayhello();
task sleep();
}
public class myservice : imyservice
{
public async task<string> sayhello()
{
return await task.factory.startnew(() => "hello");
}
public async task sleep()
{
await task.delay(3000);
}
}
在startup.cs中的 configureservices 方法中进行依赖注入，注意需要在 addsignalr() 之前注入。
services.addscoped<imyservice, myservice>();
在serverhub添加依赖注入
在serverhub中添加如下代码
private readonly iserviceprovider _serviceprovider;
public serverhub(iserviceprovider serviceprovider)
{
_serviceprovider = serviceprovider;
}
因为我们需要使用到依赖注入获取指定service，所以只注入 iserviceprovider ，使用 iserviceprovider 动态获取服务接口。
使用反射动态获取服务接口并执行指定方法
为了可以动态的选择服务并且执行服务相应的方法，我们使用反射来动态获取。 这里我们添加两个方法，一个有返回值，一个没有返回值
public async task<dynamic> excute(string servername,string functionname,object[] parameters)
{
return await task.factory.startnew(() =>
{
var type = type.gettype(servername);
var service = _serviceprovider.getrequiredservice(type);
var method = type.getmethod(functionname);
var resulttask = method.invoke(service, new object[] { }) as task;
dynamic result = resulttask.gettype().getproperty("result").getvalue(resulttask, null);
return result;
});
}
public async task excutewithoutresult(string servername, string functionname, object[] parameters)
{
var type = type.gettype(servername);
var service = _serviceprovider.getrequiredservice(type);
var method = type.getmethod(functionname);
var resulttask = method.invoke(service, new object[] { }) as task;
await resulttask;
var msg = "task done";
await clients.caller.sendasync("callback",msg);
}
方法中传入三个参数
- servername：服务接口名称（完整的命名空间）
- functionname：方法的名称
- parameters: 方法所需的参数
1.使用type.gettype(servername)获取服务接口的type。
2.使用_serviceprovider.getrequiredservice(type)从依赖注入中获取对应服务。
3.使用type.getmethod(functionname)获取需要执行的方法。
4.执行方法method.invoke(service, new object[] { })
由于我们的服务是异步方法， method.invoke() 返回的是一个 object 对象，所以在将 method.invoke() 返回类型转为 task 类型。
resulttask.gettype().getproperty("result").getvalue(resulttask, null) 是通过反射获取 task 的 result 属性来回去相应的返回结果。
因为我们不知道方法返回的 task 中返回的结果类型是什么，所以我们依旧使用反射来获取 task 的结果并使用 dynamic 接收。
无返回值的我们使用 clients.caller.sendasync() 在任务处理结束后给调用方返回一条消息。
在调用方添加一个singalrclient类
public class signalrclient
{
private readonly hubconnection connection;
public signalrclient()
{
connection = new hubconnectionbuilder()
.withurl("http://localhost:5000/myserver")
.addmessagepackprotocol()
.build();
connection.closed += async (error) =>
{
await task.delay(new random().next(0, 5) * 1000);
await connection.startasync();
};
initonmethod();
connection.startasync().configureawait(false).getawaiter().getresult();
}
}
在构造函数中初始化signalr连接
withurl("http://localhost:5000/myserver") 是连接被调用方的url
addmessagepackprotocol() 是使用快速和精简的二进制序列化格式进行传输。 在 connection.closed 加入连接关闭事件，关闭后自动重新连接。 initonmethod 初始化服务方回调的监听事件
private void initonmethod()
{
connection.on<string>("callback",(msg)=> {
console.writeline($"------------{msg}----------");
});
}
connection.startasync() 启动连接。
添加两个请求服务端的方法
一个有返回值，一个无返回值。
public async task<dynamic> requestserver1()
{
var result = await connection.invokeasync<dynamic>("excute", "signalrserver1.services.imyservice", "sayhello",new object[] { });
return result;
}
public async task requestwithoutresult()
{
await connection.sendasync("excutewithoutresult", "signalrserver1.services.imyservice", "sleep", new object[] { });
}
需要返回值的我们使用 connection.invokeasync() 方法
不需要返回值的我们使用 connection.sendasync() 方法
将signalrclient以单例形式注册依赖注入
在 startup.cs 中的 configureservices 方法中添加 services.addsingleton<signalrclient>() 。
使用signalrclient请求服务
在控制器中将signalrclient注入
private readonly signalrclient _signalrclient;
public valuescontroller(signalrclient signalrclient)
{
_signalrclient = signalrclient;
}
// get api/values
[httpget]
public async task<actionresult<ienumerable<string>>> get()
{
var str = await _signalrclient.requestserver1().configureawait(false);
await _signalrclient.requestwithoutresult().configureawait(false);
return new string[] { str };
}
在请求中同时调用一个有返回值，一个无返回值的方法。无返回值的方法在任务执行完后执行一个回调。
启动服务
可以看到服务调用已经成功 task done是我们无返回值调用那个方法中接收到回调时的输出.
connection.on<string>("callback",(msg)=> {
console.writeline($"------------{msg}----------");
});
以上就是我简单做的一个demo。希望对大家的学习有所帮助，也希望大家多多支持。