.Net Core中使用Grpc

MicroHeart！發表於2020-10-16
RPC

一、Grpc概述

　　gRPC 基於如下思想：定義一個服務， 指定其可以被遠端呼叫的方法及其引數和返回型別。gRPC 預設使用protocol buffers作為介面定義語言，來描述服務介面和有效載荷訊息結構。如果有需要的話，可以使用其他替代方案。

定義的服務分為4中型別：

  • 單項 RPC，即客戶端傳送一個請求給服務端，從服務端獲取一個應答，就像一次普通的函式呼叫。這種最常用。
  • 服務端流式 RPC，即客戶端傳送一個請求給服務端，可獲取一個資料流用來讀取一系列訊息。客戶端從返回的資料流裡一直讀取直到沒有更多訊息為止。
  • 客戶端流式 RPC，即客戶端用提供的一個資料流寫入併傳送一系列訊息給服務端。一旦客戶端完成訊息寫入，就等待服務端讀取這些訊息並返回應答。
  • 雙向流式 RPC，即兩邊都可以分別通過一個讀寫資料流來傳送一系列訊息。這兩個資料流操作是相互獨立的，所以客戶端和服務端能按其希望的任意順序讀寫，例如：服務端可以在寫應答前等待所有的客戶端訊息，或者它可以先讀一個訊息再寫一個訊息，或者是讀寫相結合的其他方式。每個資料流裡訊息的順序會被保持。

二、.Net Core中使用Grpc

使用Grpc 就三步：定義Grpc服務、實現Grpc服務、呼叫Grpc服務。

2.1 定義Grpc服務

1、在VS中選擇.Net Core建立類庫

2、引入Google.Protobuf、Grpc.Core包

3、建立proto檔案，定義一個SsmServer服務，服務中提供兩個方法，一個最簡單的單項RPC方法，一個雙向流式RPC。後面這個檔案會生成一個同名的C#類檔案。

syntax = "proto3";  //語法指定proto3
package ShenDa.SSM.Grpc; //後面生成C#檔案的名稱空間

import "Protos/Common.proto"; 
import "Protos/Health.proto";
import "Protos/User.proto";//指定定義服務中使用的引數的位置

service SsmService{
    //健康檢查   單項 RPC
    rpc Health(EmptyRequest) returns (HealthResponse){}
    //雙向流
    rpc User_Add(stream UserAddRequest) returns(stream UserAddResponse){}
}

定義的Health.proto檔案

syntax = "proto3";
package ShenDa.SSM.Grpc;

message HealthResponse{ //返回引數
    bool Success=1;    //每個欄位必須要指定序號
    string Message=2;
}

以上服務就定義完成了。現在需要將這個proto檔案生成C#檔案，可以使用命令，也可以使用工具。在這裡我使用工具生成。

5、引用Grpc.Tools ，然後在工程檔案中指定要生成的proto檔案。

    <ItemGroup>
        <Protobuf Include="Protos\User.proto" />
        <Protobuf Include="Protos\Health.proto" />
        <Protobuf Include="Protos\Common.proto" />
        <Protobuf Include="Protos\SsmService.proto" />
    </ItemGroup>

生成專案，就會在 obj資料夾中生成對應的C#檔案。其他檔案都是生成對應的實體類，但是定義的服務的proto檔案，比較特殊，它會生成一個同名的類檔案，類中包含

  • 一個抽象類，名稱為服務名+Base。其中包含我們定義的虛兩個方法
  • 一個部分類，名稱為服務名+Client，繼承 ClientBase<服務名Client>

以上所有的Grpc服務都已經定義完了。因為客戶端不可能每個都通過新增應用專案的方式使用，所以我們還需要打包客戶端Nuget包。

6、生成Nuget包，提供給客戶端使用

　　通過VS設定打包生成Nuget包，生成Grpc客戶端Nuget包。

2.2 實現Grpc服務

通過VS的GRPC模板建立專案，定義實現類並繼承上面生成的抽象類，然後重寫我們定義的方法。

    public partial class SsmServiceImpl : SsmService.SsmServiceBase
    {
        public override async Task<HealthResponse> Health(EmptyRequest request, ServerCallContext context)
        {
            var response = new HealthResponse()
            {
                Message = string.Empty,
                Success = true
            };

            return await Task.FromResult(response);
        }
    }

配置Grpc服務

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddGrpc();
        }
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.UseEndpoints(endpoints =>
            {
                endpoints.MapGrpcService<SsmServiceImpl>();//注入服務的實現。
                endpoints.MapGet("/", async context =>
                {
                    await context.Response.WriteAsync("Communication with gRPC endpoints must be made through a gRPC client. To learn how to create a client, visit: https://go.microsoft.com/fwlink/?linkid=2086909");
                });
            });
        }

專案結構截圖：

2.3 客戶端呼叫Grpc

1、新增引用Google.Protobuf、Grpc.Core、Grpc.Net.Client 還有剛才生成的Nuget包 ShenDa.SSM.Grpc

2、呼叫

    class Program
    {
        static async Task Main(string[] args)
        {

            var channel = GrpcChannel.ForAddress("https://localhost:5001");
            var client = new SsmServiceClient(channel);

            await HealthCheck(client);
        }

        public static async Task HealthCheck(SsmServiceClient client)
        {
            var response = await client.HealthAsync(new EmptyRequest());

            System.Console.WriteLine(response.Success ? "健康" : "連線失敗");
        }
    }

 

相關文章