gRPC in ASP.NET Core 3.x – gRPC 消息定义

之前写了几篇关于 Protoco Buffer 的文章。

gRPC in ASP.NET Core 3.x – gRPC 简介(1)

gRPC in ASP.NET Core 3.x – gRPC 简介(2)

当gRPC使用Protocol Buffer作为传输协议的时候,Protocol Buffer里所有的规则仍然都适用。但是在gRPC使用Protocol Buffer的时候,会添加一些额外的规则和语法,以便让gRPC能和它完美配合。
首先就是service关键字,它用来定义一个gPRC service:


在service里面,可以定义rpc调用,也就是client想让server做的事情。

  • 这里面就定义了一个rpc调用,名字叫GetByName。
  • 在调用里,我们还需要发送一个Request(请求消息),Request必须是消息类型,
        不可以发送整型,bool等原始类型,更不可以是void。
  • 同样的,Response(响应消息)也是
        消息类型,也不可以使用整型,bool,void等等。

如果请求或响应没有任何东西,那么就使用空的消息类型,但是必须带有消息。
一旦service定义好之后,我们就使用带有这个service的Protocol
Buffer消息定义所在的文档,调用Protoc编译器来对它进行编译,编译后:

  • 首先会生成一个client的stub(桩),也就是为client生成的用于来server交互的代码。我们只需要调用这个生成的client即可,其它的一些诸如序列化、反序列化的细节都不用我们操心。
  • 然后也会生成server
        interface,server这部分分为两块:
    • 一部分是消息接口的定义,这些接口我们需要去实现。例如C#,就会生成IEmployeeService之类的接口。
    • 另外一部分就是负责序列化、反序列化等工作的代码。

一个
service
定义的例子

service Employee {

    rpc GetByName (Request) returns (Response)

    rpc GetAll (Request) returns (stream Response)

    rpc UploadFile (stream Request) returns (Response)

    rpc Save(stream Request) returns (stream Response)

}