微服务架构攀登之路（三）之gRPC入门

阅读原文时间：2023年07月08日阅读：1

1. gRPC 简介

gRPC 由 google 开发，是一款语言中立、平台中立、开源的远程过程调用系统

gRPC 客户端和服务端可以在多种环境中运行和交互，例如用 java 写一个服务端，可以用 go 语言写客户端调用

2. gRPC 与 Protobuf 介绍

微服务架构中，由于每个服务对应的代码库是独立运行的，无法直接调用，彼此间的通信就是个大问题

gRPC 可以实现微服务，将大的项目拆分为多个小且独立的业务模块，也就是服务，各服务间使用高效的 protobuf 协议进行RPC 调用，gRPC 默认使用 protocol buffers，这是 google 开源的一套成熟的结构数据序列化机制（当然也可以使用其他数据格式如JSON）

可以用 proto files 创建 gRPC 服务，用 message 类型来定义方法参数和返回类型

3. 安装 gRPC 和 Protobuf

go get -u -v github.com/golang/protobuf/proto
go get google.golang.org/grpc（无法使用，用如下命令代替）
git clone https://github.com/grpc/grpc-go.git $GOPATH/src/google.golang.org/grpc
git clone https://github.com/golang/net.git $GOPATH/src/golang.org/x/net
git clone https://github.com/golang/text.git $GOPATH/src/golang.org/x/text
go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
git clone https://github.com/google/go-genproto.git $GOPATH/src/google.golang.org/genproto
cd $GOPATH/src/
go install google.golang.org/grpc
go get github.com/golang/protobuf/protoc-gen-go
go build github.com/golang/protobuf/protoc-gen-go
上面安装好后，会在GOPATH/bin 下生成 protoc-gen-go.exe
但还需要一个 protoc.exe，windows 平台编译受限，很难自己手动编译，直接去网站下载一个，地址：https://github.com/protocolbuffers/protobuf/releases/tag/v3.9.0 ，同样放到GOPATH/bin 下

1. 基本规范

文件以.proto 做为文件后缀，除结构定义外的语句以分号结尾

结构定义可以包含：message、service、enum

rpc 方法定义结尾的分号可有可无

Message 命名采用驼峰命名方式，字段命名采用小写字母加下划线分隔方式

message SongServerRequest {
required string song_name = 1;
}

Enums 类型名采用驼峰命名方式，字段命名采用大写字母加下划线分隔方式

Service 与 rpc 方法名统一采用驼峰式命名

enum Foo {
FIRST_VALUE = 1;
SECOND_VALUE = 2;
}

2. 字段规则

限定修饰符包含 required\optional\repeated

Required: 表示是一个必须字段，必须相对于发送方，在发送消息之前必须设置该字段的值，对于接收方，必须能够识别该字段的意思。发送之前没有设置

required 字段或者无法识别 required 字段都会引发编解码异常，导致消息被丢弃

Optional：表示是一个可选字段，可选对于发送方，在发送消息时，可以有选择性的设置或者不设置该字段的值。对于接收方，如果能够识别可选字段就进行相应的处理，如果无法识别，则忽略该字段，消息中的其它字段正常处理。

---因为 optional 字段的特性，很多接口在升级版本中都把后来添加的字段都统一的设置为 optional 字段，这样老的版本无需升级程序也可以正常的与新的软件进行通信，只不过新的字段无法识别而已，因为并不是每个节点都需要新的功能，因此可以做到按需升级和平滑过渡

Repeated：表示该字段可以包含 0~N 个元素。其特性和 optional 一样，但是每一次可以包含多个值。可以看作是在传递一个数组的值

数据类型

Protobuf 定义了一套基本数据类型。几乎都可以映射到 C++\Java 等语言的基础数据类型

N 表示打包的字节并不是固定。而是根据数据的大小或者长度

关于 fixed32 和 int32 的区别。fixed32 的打包效率比 int32 的效率高，但是使用的空间一般比
int32 多。因此一个属于时间效率高，一个属于空间效率高

字段名称

字段名称的命名与
C、C++、Java 等语言的变量命名方式几乎是相同的

protobuf 建议字段的命名采用以下划线分割的驼峰式。例如 first_name 而不是firstName

字段编码值

有了该值，通信双方才能互相识别对方的字段，相同的编码值，其限定修饰符和数据类型必须相同，编码值的取值范围为 1~2^32（4294967296）

其中 1~15 的编码时间和空间效率都是最高的，编码值越大，其编码的时间和空间效率就越低，所以建议把经常要传递的值把其字段编码设置为 1-15 之间的值

1900~2000 编码值为 Google protobuf 系统内部保留值，建议不要在自己的项目中使用

字段默认值

当在传递数据时，对于
required 数据类型，如果用户没有设置值，则使用默认值传递到对端

3. service

如何定义

如果想要将消息类型用在 RPC
系统中，可以在.proto 文件中定义一个 RPC 服务接口，protocol buffer 编译器会根据所选择的不同语言生成服务接口代码

例如，想要定义一个 RPC 服务并具有一个方法，该方法接收 SearchRequest 并返回一个 SearchResponse，此时可以在.proto 文件中进行如下定义：

service SearchService {
rpc Search (SearchRequest) returns (SearchResponse) {}
}

生成的接口代码作为客户端与服务端的约定，服务端必须实现定义的所有接口方法，客户端直接调用同名方法向服务端发起请求，比较麻烦的是，即便业务上不需要参数也必须指定一个请求消息，一般会定义一个空message

4. Message 如何定义

一个 message 类型定义描述了一个请求或响应的消息格式，可以包含多种类型字段

例如定义一个搜索请求的消息格式，每个请求包含查询字符串、页码、每页数目

字段名用小写，转为 go 文件后自动变为大写，message 就相当于结构体

syntax = "proto3";

message SearchRequest {
string query = 1; // 查询字符串
int32 page_number = 2; // 页码
int32 result_per_page = 3; // 每页条数
}

首行声明使用的 protobuf 版本为 proto3

SearchRequest 定义了三个字段，每个字段声明以分号结尾，.proto 文件支持双斜线 // 添加单行注释

5. 添加更多 Message 类型

一个.proto 文件中可以定义多个消息类型，一般用于同时定义多个相关的消息，例如在同一个.proto 文件中同时定义搜索请求和响应消息

syntax = "proto3";

// SearchRequest 搜索请求
message SearchRequest {
string query = 1; // 查询字符串
int32 page_number = 2; // 页码
int32 result_per_page = 3; // 每页条数
}
// SearchResponse 搜索响应
message SearchResponse {
…
}

6. 如何使用其他 Message

message 支持嵌套使用，作为另一 message 中的字段类型

message SearchResponse {
repeated Result results = 1;
}

message Result {
string url = 1;
string title = 2;
}

7. Message 嵌套的使用

支持嵌套消息，消息可以包含另一个消息作为其字段。也可以在消息内定义一个新的消息

内部声明的 message 类型名称只可在内部直接使用

message SearchResponse {
message Result {
string url = 1; string title = 2;
repeated string snippets = 3;
}
repeated Result results = 1;
}

另外，还可以多层嵌套

message Outer {
message MiddleAA {
message Inner {
int64 ival = 1;
bool booly = 2;
}
}
message MiddleBB {
message Inner {
int32 ival = 1;
bool booly = 2;
}
}
}