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。若有不足之處，請多多指點。基本沒寫過文章，寫的很差請諒解哈哈~~~