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