gRPC 应用指引

1、服务定义

service HelloService {
  rpc SayHello (HelloRequest returns (HelloResponse;
}

message HelloRequest {
  string greeting = 1;
}

message HelloResponse {
  string reply = 1;
}

gRPC 可以定义四种类型服务：

rpc SayHello(HelloRequest returns (HelloResponse;

• 服务端流式请求：客户端发送一次请求，服务端流式返回一系列数据。

  rpc LotsOfReplies(HelloRequest returns (stream HelloResponse;
  

• 客户端流式请求：客户端流式写入一系列请求，然后发送到服务端。客户端写完请求后，等待服务端接受并返回结果。

  rpc LotsOfGreetings(stream HelloRequest returns (HelloResponse;
  

• 双向流式请求：客户端和服务端双向发送数据流，各自独立。可以随读随写，或者一次性读完再写。

  rpc BidiHello(stream HelloRequest returns (stream HelloResponse;
  

2、API 使用

首先在 .proto 文件中定义一个服务，然后使用 gRPC 提供的 pb 编译插件来生成客户端和服务端代码。

服务端：实现定义的服务，响应客户端请求。gRPC 框架解码请求，执行服务方法，编码返回结果。
• 客户端：本地 stub 包含实现的服务方法，客户端可以直接调用 stub 的相应方法，以 pb 消息类型包装请求参数发送到服务器，同时返回服务器返回的结果。

3、同步和异步

4、RPC 生命周期

a）Unary RPC

客户端发送一次请求，获取一次返回。

客户端请求本地 stub 方法，服务端获取到通知，并伴随着客户端的请求数据，包括客户端 metadata、方法名及 deadline。服务端可以直接返回自身的 metadata（必须在业务结果返回前返回）或者等待客户端的请求消息（自定义）。
• 服务端收到客户端请求消息，然后执行相应的方法，组装相应的数据结果，伴随着请求状态信息（状态码及可能状态消息）返回给客户端。
• 如果状态为 OK，则客户端可以获取到结果进行处理，完成整个调用过程。

b）服务端流式 RPC

c）客户端流式 RPC

客户端发送的是一个请求数据流。

d）双向流式 RPC

5、Deadlines/Timeouts

gRPC 允许客户端声明超时（请求 DEADLINE_EXCEEDED 异常之前等待的时间）。服务端可以通过此来判定请求是否超时及剩余处理时间。

6、RPC 终止

7、RPC 请求取消

客户端和服务端都可以在任何时候取消 RPC 流程。

8、Metadata

key 大小写敏感，不能以 grpc- 做前缀（保留），二进制 value 的 key 以 -bin 结尾。

元数据使用，不同开发语言可能不同。

9、Channels

channel 提供相应的参数配置控制 gRPC 请求行为，例如交互数据压缩等。