.NET gRPC 核心功能初体验，附Demo源码

gRPC是高性能的RPC框架， 有效地用于服务通信(不管是数据中心内部还是跨数据中心)。

由Google开源，目前是一个Cloud Native Computing Foundation（CNCF）孵化项目。

其功能包括：

• 双向流
• 强大的二进制序列化
• 可插拔的身份验证，负载平衡和运行状况检查

在gRPC中，客户端应用程序可以直接在A服务器上调用B服务器的方法，就好像它是本地对象一样，从而使您更轻松地创建分布式应用程序和微服务。

与许多RPC系统一样，gRPC也是围绕着定义服务的思想(定义可远程调用方法的入参和返回值类型)。

在服务器端，服务器实现此接口并运行gRPC服务器，以处理客户端调用。

在客户端，客户端具有一个存根（在某些语言中仅称为客户端），提供与服务器相同的方法。

在本文中，我将向您展示如何使用.NET5创建gRPC服务。我将分解gRPC的一些重要基础概念，并给出一个通信示例。

1.创建一个gRPC服务器

我们将从使用gRPC服务模板创建一个新的dotnet项目。

如果使用Visual Studio，请创建一个新项目，然后选择gRPC Service模板，使用GrpcAuthor作为项目的名称。

1.1 The RPC Service Definition

客户端与服务端使用protocol buffers交流/通信：

protocol buffers既用作服务的接口定义语言(IDL)，又用作底层消息交换格式。

① 使用protocol buffers在.proto文件中定义服务接口。在其中，定义可远程调用的方法的入参和返回值类型。服务器实现此接口并运行gRPC服务器以处理客户端调用。

② 定义服务后，使用protocol buffers编译器protoc从.proto文件生成数据访问/传输类。该文件包含服务接口中消息和方法的实现。

关注VS脚手架项目Protos文件夹中的greet.proto。

syntax = "proto3";

option csharp_namespace = "GrpcAuthor";

package greet;

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply);
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings.
message HelloReply {
  string message = 1;
}

让我们分解一下.proto文件，了解protocol buffers的基本语法

从.proto文件上大致知道 定义的服务功能 (给某人一个回应)， 这里提示一些语法：

1. syntax指示使用的protocol buffers的版本。在这种情况下，proto3是撰写本文时的最新版本。
2. csharp_namespace指示生成的文件所在的命名空间。package说明符也是这个作用，用于防止协议消息类型之间的名称冲突。

对于C＃，如果提供选项csharp_namespace，csharp_namespace值将用作命名空间；

在Java中，如果提供选项java_package，java_package将用作包名称。

1. service Greeter定义服务基类名称, rpc SayHello (HelloRequest) returns (HelloReply); 是一个一元rpc调用
2. HelloRequest和HelloReply是在客户端和服务器之间交换信息的数据结构。它们被称为消息。
   
   你在消息字段中定义的数字是不可重复的，当消息被序列化为Protobuf时，该数字用于标识字段，这是因为序列化一个数字比序列化整个字段名称要快。
3. 更多语法，请查看https://developers.google.com/protocol-buffers/docs/overview

1.2 实现服务接口

为了从.proto文件生成代码，可以使用protoc编译器和C＃插件来生成服务器或客户端代码。

脚手架项目使用Grpc.AspNetCore NuGet包：所需的类由构建过程自动生成, 你只需要在项目.csproj文件中添加配置节：

<ItemGroup>
  <Protobuf Include="Protos\greet.proto" GrpcServices="Server" />
</ItemGroup>

生成的代码知道如何使用protocol buffers与其他服务/客户端进行通信。

C＃工具生成GreeterBase类型，将用作实现gRPC服务的基类。

public class GreeterService : Greeter.GreeterBase
{
    private readonly ILogger<GreeterService> _logger;
    public GreeterService(ILogger<GreeterService> logger)
    {
        _logger = logger;
    }

    public override Task<HelloReply> SayHello(HelloRequest request, ServerCallContext context)
    {
        return Task.FromResult(new HelloReply
        {
            Message = "Hello " + request.Name
        });
    }
}

最后注意注册Grpc端点endpoints.MapGrpcService<GreeterService >();

--- 启动服务---...

2. 创建gRPC .NET控制台客户端

Visual Studio创建一个名为GrpcAuthorClient的新控制台项目。

安装如下nuget包:

Install-Package Grpc.Net.Client

Install-Package Google.Protobuf

Install-Package Grpc.Tools

Grpc.Net.Client包含.NET Core客户端;

Google.Protobuf包含protobuf消息API;

Grpc.Tools对Protobuf文件进行编译。

1. 拷贝服务端项目中的..proto文件
2. 将选项csharp_namespace值修改为GrpcAuthorClient。
3. 更新.csproj文件的配置节

<ItemGroup>
 <Protobuf Include="Protos\author.proto" GrpcServices="Client" />
</ItemGroup>

1. Client主文件:

static void Main(string[] args)
       {
           var serverAddress = "https://localhost:5001";

           using var channel = GrpcChannel.ForAddress(serverAddress);
           var client = new Greeter.GreeterClient(channel);
           var reply = client.SayHello(new HelloRequest { Name = "宋小宝！" });

           Console.WriteLine(reply.Message.ToString());

           Console.WriteLine("Press any key to exit...");
           Console.ReadKey();
       }

使用服务器地址创建GrpcChannel，然后使用GrpcChannel对象实例化GreeterClient；然后使用SayHello同步方法; 服务器响应时，打印结果。

脚手架例子就可以入门，下面聊一聊另外的核心功能

3. 其他核心功能

1. 通信方式

• Unary RPC(一元Rpc调用): 上面的例子
• Server streaming RPC ： 服务器流式RPC，客户端在其中向服务器发送请求，并获取流以读取回一系列消息。客户端从返回的流中读取，直到没有更多消息为止。 gRPC保证单个RPC调用中的消息顺序。
• Client streaming RPC：客户端流式RPC，客户端在其中编写一系列消息，然后再次使用提供的流将它们发送到服务器。客户端写完消息后，它将等待服务器读取消息并返回响应。同样，gRPC保证了单个RPC调用中的消息顺序
• Bidirectional streaming RPC： 双向流式RPC，双方都使用读写流发送一系列消息。这两个流是独立运行的，因此客户端和服务器可以按照自己喜欢的顺序进行读写：例如，服务器可以在写响应之前等待接收所有客户端消息，或者可以先读取一条消息再写入一条消息，或读写的其他组合。每个流中的消息顺序都会保留。

2. Metadata

元数据是以键值对列表的形式提供的有关特定RPC调用的信息（例如身份验证详细信息），其中键是字符串，值通常是字符串，但可以是二进制数据。

元数据对于gRPC本身是不透明的：它允许客户端向服务器提供与调用相关的信息，反之亦然。

3. Channels

gRPC通道提供到指定主机和端口上的gRPC服务器的连接。

创建客户端存根时用到它，可以指定通道参数来修改gRPC的默认行为，例如打开或关闭消息压缩。

通道具有状态，包括已连接和空闲。

---

4 gRPC打乒乓球

针对脚手架项目，稍作修改--->乒乓球局

(考察gRpc双向流式通信、Timeout机制、异常处理):

客户端发送"gridsum", 服务端回发"musdirg"; 客户端再发送"gridsum"， 往复......

① 添加接口

rpc PingPongHello(stream HelloRequest) returns (stream HelloReply);

② 实现服务契约

 public override async Task PingPongHello(IAsyncStreamReader<HelloRequest> requestStream,IServerStreamWriter<HelloReply> responseStream, ServerCallContext context)
        {
            try
            {
                while (!context.CancellationToken.IsCancellationRequested)
                {
                    var asyncRequests = requestStream.ReadAllAsync();
                    // 客户端与服务端"打乒乓"
                    await foreach (var req in asyncRequests)
                    {
                        var send = Reverse(req.Name);
                        await responseStream.WriteAsync(new HelloReply
                        {
                            Message = send,
                            Id = req.Id + 1
                        });
                        Debug.WriteLine($"第{req.Id}回合，服务端收到 {req.Name}；开始第{req.Id + 1}回合,服务端回发 {send}");
                    }
                }
            }
            catch (RpcException ex)
            {
                System.Diagnostics.Debug.WriteLine($"{ex.Message}");
            }
            catch (IOException ex)
            {
                System.Diagnostics.Debug.WriteLine($"{ex.Message}");
            }
        }

③ 添加客户端代码

using (var cancellationTokenSource = new CancellationTokenSource( 5* 1000))
{
     try
     {
           var duplexMessage = client.PingPongHello(null, null, cancellationTokenSource.Token);
           await duplexMessage.RequestStream.WriteAsync(new HelloRequest { Id = 1, Name = "gridsum" }) ;

           var asyncResp = duplexMessage.ResponseStream.ReadAllAsync();
           await foreach (var resp in asyncResp)
           {
              var send = Reverse(resp.Message);
              await duplexMessage.RequestStream.WriteAsync(new HelloRequest {Id= resp.Id, Name = send });
             Console.WriteLine($"第{resp.Id}回合，客户端收到 {resp.Message}, 客户端发送{send}");
          }
     }
     catch (RpcException ex)
     {
            Console.WriteLine("打乒乓球时间到了（客户端5s后终断gRpc连接）");
     }
}

https://github.com/zaozaoniao/GrpcAuthor

总结

gRPC是具有可插拔身份验证和负载平衡功能的高性能RPC框架。

使用protocol buffers定义结构化数据;使用不同语言自动产生的源代码在各种数据流中写入和读取结构化数据。

在本文中，您学习了如何使用protocol buffers（版本3）定义服务接口以及如何使用C＃实现服务。最后，您使用gRPC双向流式通信创建了 "打乒乓球"Demo。

Additional Resources

• https://developers.google.com/protocol-buffers/docs/csharptutorial

• https://www.grpc.io/docs/what-is-grpc/core-concepts/

• https://docs.microsoft.com/en-us/dotnet/architecture/grpc-for-wcf-developers/why-grpc