protobuf 介绍与使用
一、简介
Protocol Buffers 是一种语言中立、跨平台,用来序列化结构化数据的一阵协议。
主要定义了一个proto文件,就可以在多种编程语言,多种操作系统使用。
我们使用最新的 proto3 版本。
二、编写proto文件
编写一个例子文件,叫hello.proto
protobuf
syntax = "proto3";
package hello;
import "google/protobuf/timestamp.proto";
option go_package = "./api;api";
service Say {
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
message HelloRequest {
string name = 1;
}
message HelloReply {
string message = 1;
google.protobuf.Timestamp last_updated = 2;
}
2.1 定义协议格式,proto文件的头部 syntax,package,import
每一个.proto文件,都要定义使用syntax,目前默认是proto3协议格式。
protobuf
syntax = "proto3";
package hello;
import "google/protobuf/timestamp.proto";
package定义proto的命名空间,通过上面可以看到我们的hello.proto文件在api文件夹内,如果api文件夹,还有其他的.proto文件,如何防止不同的.proto文件冲突,此时就是使用package,定义每个.proto文件的package包名,作为命名空间。这样就防止了同名冲突。
import就是导入其他的.proto文件,就是配合上面的package,如果其他的文件需要引入hello.proto,就使用import "hello.proto" 就可以了。
2.2 定义go_package
定义go_package有两种方式。
1、option go_package = "./api;api";
2、option go_package = "github/hisheng/grpc-demo1/api";
两个是等价的,优先第2种,这里写第1种,是因为我们这里单纯的讲 proto格式,用相对的路径简单一点。
当我们使用go mod init,设置了项目的module,我们就可以使用第2种。
2.3 定义proto的 service和message
2.31 定义服务和方法
grpc调用过程(函数)成为方法,若干方法的集合称为 服务
protobuf
// 定义一个服务Say
service Say {
// 定义一个方法 SayHello
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
在这段代码里,我们定义了一个Say服务。
提供了供第三方调用的 SayHello方法。其中HelloRequest是请求的数据结构,HelloReply是返回的数据结构。
2.32 定义消息类型 message
一个message消息类型,有多个字段(名称/类型,序号)组成。
在这里需要唯一。
类型有很多种,官方文档有很详细的描述https://protobuf.dev/programming-guides/proto3/
我们这里主要使用了 string字符串类型,以及一个google.protobuf.Timestamp时间戳类型。
protobuf
message HelloRequest {
string name = 1;
}
message HelloReply {
string message = 1;
google.protobuf.Timestamp last_updated = 2;
}
三、安装protoc与插件
使用protoc命令编译.proto文件,生成对应go文件
3.1 安装protoc命令
sh
brew install protobuf

检查版本
sh
protoc --version

3.2 安装protobuf插件
3.21 安装protoc-gen-go插件,--go_out选项
用来生成.pb.go文件,用来处理message等正常的类型。
sh
go get -u google.golang.org/protobuf/cmd/protoc-gen-go
go install google.golang.org/protobuf/cmd/protoc-gen-go

3.22 安装protoc-gen-go-grpc插件,--go-grpc_opt选项
用来处理grpc相关的程序。
sh
go get -u google.golang.org/grpc/cmd/protoc-gen-go-grpc
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc

四、生成go代码
随便编写一个 proto 文件,我这里叫 user.proto
protobuf
syntax = "proto3";
option go_package = "user/pb;pb";//指定生成的位置和package
message RegisterParams{
string account = 1;
string password = 2;
int32 loginPlatform = 3;
string smsCode = 4;
}
message RegisterResponse{
string uid = 1;
}
service UserService{
rpc Register(RegisterParams) returns(RegisterResponse);
}
执行以下命令生成代码
sh
protoc --go_out=../pb --go_opt=paths=source_relative \
--go-grpc_out=../pb --go-grpc_opt=paths=source_relative \
*.proto

可以看到刚生成的user.pb.go和user_grpc.pb.go两个go文件。