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: 方法所需的引數
- 使用
Type.GetType(serverName)
獲取服務介面的Type。 - 使用
_serviceProvider.GetRequiredService(type)
從依賴注入中獲取對應服務。 - 使用
type.GetMethod(functionName)
獲取需要執行的方法。 - 執行方法
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。如有不足之處,請多多指點。基本沒寫過文章,寫的不好請諒解哈哈~~~