ProtoBuf

[hhstore]

related:

• 62 : grpc

• 101 : grpc+protobuf

[hhstore]

protobuf:

• 译: Protobuf3语言指南

proto mirror:

• https://github.com/gogo
• 该组织下项目, 对应Google几个项目的mirror地址

Google项目	mirror 对应
import "gogoproto/gogo.proto";	import "github.com/gogo/protobuf/gogoproto/gogo.proto";
import "google/api/annotations.proto";	import "github.com/gogo/googleapis/google/api/annotations.proto";

• 可选mirror 2个:

  https://github.com/gogo/googleapis https://github.com/googleapis/googleapis

• mirror 1 更合适, 只是工具性内容.
• mirror 2 是 Google全部API, 不需要import这个.

golang proto3 数据类型映射关系:

• 官方文档 - proto3数据类型

编码:

• 编码

枚举类型:

• enum

map 类型:

• maps

unknowns 未知类型:

• unknowns

json 映射:

• JSON Mapping

options:

• options

[hhstore]

参考:

• https://github.com/Jergoo/go-grpc-example
• 给了 grpc 使用示例代码+文档

proto 最佳实践:

• https://github.com/googleapis/googleapis
• Google 官方 API 仓库, 所有服务的 API 定义.

[hhstore]

go 代码自动生成 proto:

• https://github.com/src-d/proteus

• 官方有效示例: https://github.com/src-d/proteus/blob/master/example/Makefile

• -p 待生成的 go 代码目录, 不是文件

• -f 生成结果目录.

• 支持生成 service 代码

• 支持生成 枚举类型

# 当前路径下生成:
-> % proteus -p go-common/app/service/main/dm/internal/model/subtitle  --verbose -f .

# 生成全部: 
proteus  -p go-common/app/service/main/dm/internal/model/subtitle/ -f .

# 只生成 proto:
proteus proto -p go-common/app/service/main/dm/internal/model/subtitle/ -f .

• 支持生成 枚举类型, 方法, 在代码前一行加注释//proteus:generate:

//proteus:generate
type Preference struct {
        Name string
        Value string
        Options Options
}

//proteus:generate
type Status int

const (
        Pending Status = iota
        Active
        Closed
)

package users

//proteus:generate
func GetUser(id uint64) (*User, error) {
        // impl
}

//proteus:generate
func (s *UserStore) UpdateUser(u *User) error {
        // impl
}

生成全部:

roteus -f /path/to/protos/folder \
        -p my/go/package \
        -p my/other/go/package

只生成 proto:

proteus proto -f /path/to/output/folder \
        -p my/go/package \
        -p my/other/go/package
        --verbose