.Net Core中使用Grpc
一、Grpc概述
gRPC 基于如下思想：定義一個(gè)服務(wù)， 指定其可以被遠(yuǎn)程調(diào)用的方法及其參數(shù)和返回類型。gRPC 默認(rèn)使用protocol buffers作為接口定義語(yǔ)言，來(lái)描述服務(wù)接口和有效載荷消息結(jié)構(gòu)。如果有需要的話，可以使用其他替代方案。
定義的服務(wù)分為4中類型：
單項(xiàng) RPC，即客戶端發(fā)送一個(gè)請(qǐng)求給服務(wù)端，從服務(wù)端獲取一個(gè)應(yīng)答，就像一次普通的函數(shù)調(diào)用。這種最常用。
服務(wù)端流式 RPC，即客戶端發(fā)送一個(gè)請(qǐng)求給服務(wù)端，可獲取一個(gè)數(shù)據(jù)流用來(lái)讀取一系列消息。客戶端從返回的數(shù)據(jù)流里一直讀取直到?jīng)]有更多消息為止。
客戶端流式 RPC，即客戶端用提供的一個(gè)數(shù)據(jù)流寫入并發(fā)送一系列消息給服務(wù)端。一旦客戶端完成消息寫入，就等待服務(wù)端讀取這些消息并返回應(yīng)答。
雙向流式 RPC，即兩邊都可以分別通過(guò)一個(gè)讀寫數(shù)據(jù)流來(lái)發(fā)送一系列消息。這兩個(gè)數(shù)據(jù)流操作是相互獨(dú)立的，所以客戶端和服務(wù)端能按其希望的任意順序讀寫，例如：服務(wù)端可以在寫應(yīng)答前等待所有的客戶端消息，或者它可以先讀一個(gè)消息再寫一個(gè)消息，或者是讀寫相結(jié)合的其他方式。每個(gè)數(shù)據(jù)流里消息的順序會(huì)被保持。
二、.Net Core中使用Grpc
使用Grpc 就三步：定義Grpc服務(wù)、實(shí)現(xiàn)Grpc服務(wù)、調(diào)用Grpc服務(wù)。
2.1 定義Grpc服務(wù)
1、在VS中選擇.Net Core創(chuàng)建類庫(kù)
2、引入Google.Protobuf、Grpc.Core包
3、創(chuàng)建proto文件，定義一個(gè)SsmServer服務(wù)，服務(wù)中提供兩個(gè)方法，一個(gè)最簡(jiǎn)單的單項(xiàng)RPC方法，一個(gè)雙向流式RPC。后面這個(gè)文件會(huì)生成一個(gè)同名的C#類文件。
syntax = "proto3"; //語(yǔ)法指定proto3package ShenDa.SSM.Grpc; //后面生成C#文件的命名空間import "Protos/Common.proto";import "Protos/Health.proto";import "Protos/User.proto";//指定定義服務(wù)中使用的參數(shù)的位置service SsmService{//健康檢查 單項(xiàng) RPCrpc Health(EmptyRequest) returns (HealthResponse){}//雙向流rpc User_Add(stream UserAddRequest) returns(stream UserAddResponse){}}
定義的Health.proto文件
syntax = "proto3";package ShenDa.SSM.Grpc;message HealthResponse{ //返回參數(shù)bool Success=1; //每個(gè)字段必須要指定序號(hào)string Message=2;}
以上服務(wù)就定義完成了。現(xiàn)在需要將這個(gè)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>
生成項(xiàng)目，就會(huì)在 obj文件夾中生成對(duì)應(yīng)的C#文件。其他文件都是生成對(duì)應(yīng)的實(shí)體類，但是定義的服務(wù)的proto文件，比較特殊，它會(huì)生成一個(gè)同名的類文件，類中包含
一個(gè)抽象類，名稱為服務(wù)名+Base。其中包含我們定義的虛兩個(gè)方法
一個(gè)部分類，名稱為服務(wù)名+Client，繼承?ClientBase<服務(wù)名Client>
以上所有的Grpc服務(wù)都已經(jīng)定義完了。因?yàn)榭蛻舳瞬豢赡苊總€(gè)都通過(guò)添加應(yīng)用項(xiàng)目的方式使用，所以我們還需要打包客戶端Nuget包。
6、生成Nuget包，提供給客戶端使用
通過(guò)VS設(shè)置打包生成Nuget包，生成Grpc客戶端Nuget包。
2.2 實(shí)現(xiàn)Grpc服務(wù)
通過(guò)VS的GRPC模板創(chuàng)建項(xiàng)目，定義實(shí)現(xiàn)類并繼承上面生成的抽象類，然后重寫我們定義的方法。
public partial class SsmServiceImpl : SsmService.SsmServiceBase{public override async TaskHealth(EmptyRequest request, ServerCallContext context) {var response = new HealthResponse(){Message = string.Empty,Success = true};return await Task.FromResult(response);}}
配置Grpc服務(wù)
public void ConfigureServices(IServiceCollection services){services.AddGrpc();}public void Configure(IApplicationBuilder app, IWebHostEnvironment env){app.UseEndpoints(endpoints =>{endpoints.MapGrpcService();//注入服務(wù)的實(shí)現(xiàn)。 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");});});}
項(xiàng)目結(jié)構(gòu)截圖：
2.3 客戶端調(diào)用Grpc
1、添加引用Google.Protobuf、Grpc.Core、Grpc.Net.Client 還有剛才生成的Nuget包?ShenDa.SSM.Grpc
2、調(diào)用
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 ? "健康" : "連接失敗");}}