.Net Core中使用Grpc

2020 年 10 月 16 日
筆記
.NET Core, gRPC

一、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: //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("//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 ? "健康" : "連接失敗");
        }
    }

Tags: .NET Core gRPC