gRPC 基于如下思想：定义一个服务， 指定其可以被远程调用的方法及其参数和返回类型。gRPC 默认使用protocol buffers作为接口定义语言，来描述服务接口和有效载荷消息结构。如果有需要的话，可以使用其他替代方案。

定义的服务分为4中类型：

  • 单项 RPC，即客户端发送一个请求给服务端，从服务端获取一个应答，就像一次普通的函数调用。这种最常用。
  • 服务端流式 RPC，即客户端发送一个请求给服务端，可获取一个数据流用来读取一系列消息。客户端从返回的数据流里一直读取直到没有更多消息为止。
  • 客户端流式 RPC，即客户端用提供的一个数据流写入并发送一系列消息给服务端。一旦客户端完成消息写入，就等待服务端读取这些消息并返回应答。
  • 双向流式 RPC，即两边都可以分别通过一个读写数据流来发送一系列消息。这两个数据流操作是相互独立的，所以客户端和服务端能按其希望的任意顺序读写，例如：服务端可以在写应答前等待所有的客户端消息，或者它可以先读一个消息再写一个消息，或者是读写相结合的其他方式。每个数据流里消息的顺序会被保持。

使用Grpc 就三步：定义Grpc服务、实现Grpc服务、调用Grpc服务。

1、在VS中选择.Net Core创建类库

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

3、创建proto文件，定义一个SsmServer服务，服务中提供两个方法，一个最简单的单项RPC方法，一个双向流式RPC。后面这个文件会生成一个同名的C#类文件。

  1. syntax = "proto3";  //语法指定proto3
  2. package ShenDa.SSM.Grpc; //后面生成C#文件的命名空间
  4. import "Protos/Common.proto"; 
  5. import "Protos/Health.proto";
  6. import "Protos/User.proto";//指定定义服务中使用的参数的位置
  8. service SsmService{
  9.     //健康检查   单项 RPC
  10.     rpc Health(EmptyRequest) returns (HealthResponse){}
  11.     //双向流
  12.     rpc User_Add(stream UserAddRequest) returns(stream UserAddResponse){}
  13. }

定义的Health.proto文件

  1. syntax = "proto3";
  2. package ShenDa.SSM.Grpc;
  4. message HealthResponse{ //返回参数
  5.     bool Success=1;    //每个字段必须要指定序号
  6.     string Message=2;
  7. }

以上服务就定义完成了。现在需要将这个proto文件生成C#文件，可以使用命令，也可以使用工具。在这里我使用工具生成。

5、引用Grpc.Tools ，然后在工程文件中指定要生成的proto文件。

  1.     <ItemGroup>
  2.         <Protobuf Include="Protos\User.proto" />
  3.         <Protobuf Include="Protos\Health.proto" />
  4.         <Protobuf Include="Protos\Common.proto" />
  5.         <Protobuf Include="Protos\SsmService.proto" />
  6.     </ItemGroup>

生成项目，就会在 obj文件夹中生成对应的C#文件。其他文件都是生成对应的实体类，但是定义的服务的proto文件，比较特殊，它会生成一个同名的类文件，类中包含

  • 一个抽象类，名称为服务名+Base。其中包含我们定义的虚两个方法
  • 一个部分类，名称为服务名+Client，继承 ClientBase<服务名Client>

以上所有的Grpc服务都已经定义完了。因为客户端不可能每个都通过添加应用项目的方式使用，所以我们还需要打包客户端Nuget包。

6、生成Nuget包，提供给客户端使用

　　通过VS设置打包生成Nuget包，生成Grpc客户端Nuget包。

通过VS的GRPC模板创建项目，定义实现类并继承上面生成的抽象类，然后重写我们定义的方法。

  1.     public partial class SsmServiceImpl : SsmService.SsmServiceBase
  2.     {
  3.         public override async Task<HealthResponse> Health(EmptyRequest request, ServerCallContext context)
  4.         {
  5.             var response = new HealthResponse()
  6.             {
  7.                 Message = string.Empty,
  8.                 Success = true
  9.             };
  11.             return await Task.FromResult(response);
  12.         }
  13.     }

配置Grpc服务

  1.         public void ConfigureServices(IServiceCollection services)
  2.         {
  3.             services.AddGrpc();
  4.         }
  5.         public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
  6.         {
  7.             app.UseEndpoints(endpoints =>
  8.             {
  9.                 endpoints.MapGrpcService<SsmServiceImpl>();//注入服务的实现。
  10.                 endpoints.MapGet("/", async context =>
  11.                 {
  12.                     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");
  13.                 });
  14.             });
  15.         }

项目结构截图：

1、添加引用Google.Protobuf、Grpc.Core、Grpc.Net.Client 还有刚才生成的Nuget包 ShenDa.SSM.Grpc

2、调用

  1.     class Program
  2.     {
  3.         static async Task Main(string[] args)
  4.         {
  6.             var channel = GrpcChannel.ForAddress("https://localhost:5001");
  7.             var client = new SsmServiceClient(channel);
  9.             await HealthCheck(client);
  10.         }
  12.         public static async Task HealthCheck(SsmServiceClient client)
  13.         {
  14.             var response = await client.HealthAsync(new EmptyRequest());
  16.             System.Console.WriteLine(response.Success ? "健康" : "连接失败");
  17.         }
  18.     }

 

版权声明：本文为MicroHeart原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://www.cnblogs.com/MicroHeart/p/13824612.html