在存储相对复杂的结构体时 protobuf 比 json 更高效,而且方便后期字段扩展。
我们可以将数据用 protobuf 序列化后存入 mysql 或 redis 中
一、安装 Protobuf
- 拉取项目
$ go get -d -u github.com/golang/protobuf/protoc-gen-go
- 切换到 release 版本
$ git -C "$(go env GOPATH)"/src/github.com/golang/protobuf checkout v1.2.0
注意: 如果不指定版本,会使用 master 分支,而 dep 等包管理工具,会优先拉取 release 的版本,导致编译出的 protoc-gen-go 与 vendor 里的源码版本不一致,最终编译报错
替代方案:如果此处不指定版本,可以在 dep 的配置文件 gopkg.toml 里指定为 master
[[override]]
branch = "master"
name = "github.com/golang/protobuf"
- 编译安装
$ go install github.com/golang/protobuf/protoc-gen-go
二、项目中创建 proto 文件
- 定义 proto 对象
$ vim protos/protos.pb.go
syntax = "proto3";
package protos;
message Info {
uint32 UID = 1;
int32 Power = 3;
int64 StartedAt = 4;
double OutputMoney = 7;
}
- 编译成 go 文件
$ protoc --go_out=. protos/*.proto
- 代码里使用
import (
"time"
"demo-api/protos"
"github.com/golang/protobuf/proto"
)
// 序列化
obj := protos.Info{
UID: 1,
Power: 2,
StartedAt: time.Now().Unix(),
OutputMoney: 0,
}
data, err := proto.Marshal(obj)
Check(err)
// 反序列化
var info protos.Info
err = proto.Unmarshal(data, &info)
Check(err)
三、VSCode 自动提示和格式化
安装插件 vscode-proto3 及其依赖的 Clang-Format
如果存在报错 clang-format not installed
,需要在系统里安装 clang-format
# MacOS可以直接通过brew安装
$ brew install clang-format
clang-format同时会格式化javascript文件,这与prettier冲突,要在 settings.json 禁用掉一些格式化功能
{
"clang-format.language.javascript.enable": false,
"clang-format.language.typescript.enable": false,
"clang-format.language.java.enable": false,
}
四、总结
时间类型
golang 里的 time.Time,protobuf 也可以支持,但是我不希望在代码里做额外的类型转换,所有 proto 里的时间都定义成了 int64,用来存储 unix timestampUid 和 UID 的问题
这是 golang 里比较恶心的问题,proto 里如果变量名为 uid,编译后会转换为 Uid,而自家的 golang 规范却要求的是 UID,所以我们再 proto 里可以直接命名为 UIDint 和 int32
protobuf 不支持 int,所以在 golang 里与 proto 对应的字段都由 int 改成了 int32, 减少强制转换次数