Table of Contents generated with DocToc
- buf
buf目标就是从 api编程 转成 schema-driven paradigm ，更好管理 protobuf文件。
- 依赖管理：比如 google/api经常得拷贝到本地.使用Buf Schema Registry (BSR)可以解决问题，类似Go的module管理，javaScript的npm管理,官方仓库地址：https://buf.build/。
- stub生成过程很难：管理protoc对应插件很难
- 新的高性能protobuf编译器
- linter检查
- 检查protobuf代码前后兼容性
- 调用对应的Protoc插件
- buf工具
#使用源码，因为brew install bufbuild/buf/buf 暂时不支持M1
GO111MODULE=on GOBIN=/usr/local/bin go install \
github.com/bufbuild/buf/cmd/[email protected]- 学习前置工具
- git
- jq
- 下载源码
(⎈ |teleport.gllue.com-test:danny-xia)➜ 35_buf git:(feature/buf) ✗ git clone https://github.com/bufbuild/buf-tour
(⎈ |teleport.gllue.com-test:danny-xia)➜ 35_buf git:(feature/buf) ✗ tree
.
├── buf-tour
│ ├── README.md
│ ├── finish
│ │ ├── buf.gen.yaml
│ │ ├── buf.work.yaml
│ │ ├── client
│ │ │ └── main.go
│ │ ├── gen
│ │ │ └── proto
│ │ │ └── go
│ │ │ ├── payment
│ │ │ │ └── v1alpha1
│ │ │ │ └── payment.pb.go
│ │ │ └── pet
│ │ │ └── v1
│ │ │ ├── pet.pb.go
│ │ │ └── pet_grpc.pb.go
│ │ ├── go.mod
│ │ ├── go.sum
│ │ ├── paymentapis
│ │ │ ├── buf.lock
│ │ │ ├── buf.yaml
│ │ │ └── payment
│ │ │ └── v1alpha1
│ │ │ └── payment.proto
│ │ ├── petapis
│ │ │ ├── buf.lock
│ │ │ ├── buf.md
│ │ │ ├── buf.yaml
│ │ │ └── pet
│ │ │ └── v1
│ │ │ └── pet.proto
│ │ └── server
│ │ └── main.go
│ └── start
│ └── petapis
│ ├── google
│ │ └── type
│ │ └── datetime.proto
│ └── pet
│ └── v1
│ └── pet.proto
└── buf.md
23 directories, 20 files
执行从start开始，执行最终结果跟finish一致（除了仓库名字）
(⎈ |teleport.gllue.com-test:danny-xia)➜ 35_buf git:(feature/buf) ✗ cd buf-tour/start/petapis源文件
.
├── buf.work.yaml
├── proto
│ ├── acme
│ │ └── weather
│ │ └── v1
│ │ └── weather.proto
│ └── buf.yaml
└── vendor
└── protoc-gen-validate
├── buf.yaml
└── validate
└── validate.proto传统使用protoc方式
$ protoc \
-I proto \
-proto_path vendor/protoc-gen-validate \
-o /dev/null \
$(find proto -name '*.proto')buf使用方式
# buf.work.yaml
version: v1
directories:
- proto
- vendor/protoc-gen-validate# buf.yaml
version: v1
lint:
use:
- DEFAULT
breaking:
use:
- FILE使用过protoc的知道，-I和-proto_path就是引入对应的根目录petapis，在buf中没有-I这个flag，但是对应的buf.yaml文件的位置对应她的根目录,
如果是多个根目录，可以用buf.work.yaml，代表workspace。
buf.yaml是buf默认的入口，应该在proto的根目录，即pet/v1/pet.proto的根目录,为petapis。
# 在项目petapis下初始化
buf mod init➜ petapis git:(main) ✗ buf lint
google/type/datetime.proto:17:1:Package name "google.type" should be suffixed with a correctly formed version, such as "google.type.v1".
pet/v1/pet.proto:44:10:Field name "petID" should be lower_snake_case, such as "pet_id".
pet/v1/pet.proto:49:9:Service name "PetStore" should be suffixed with "Service".
➜ petapis git:(main) ✗ buf lint --error-format=json
{"path":"google/type/datetime.proto","start_line":17,"start_column":1,"end_line":17,"end_column":21,"type":"PACKAGE_VERSION_SUFFIX","message":"Package name \"google.type\" should be suffixed with a correctly formed version, such as \"google.type.v1\"."}
{"path":"pet/v1/pet.proto","start_line":44,"start_column":10,"end_line":44,"end_column":15,"type":"FIELD_LOWER_SNAKE_CASE","message":"Field name \"petID\" should be lower_snake_case, such as \"pet_id\"."}
{"path":"pet/v1/pet.proto","start_line":49,"start_column":9,"end_line":49,"end_column":17,"type":"SERVICE_SUFFIX","message":"Service name \"PetStore\" should be suffixed with \"Service\"."}
上面报了三种错误
- PACKAGE_VERSION_SUFFIX： 包版本后缀问题
- FIELD_LOWER_SNAKE_CASE: 字段蛇形格式
- SERVICE_SUFFIX：proto的servic名字应该带上后缀service
- 不需要校验的type
version: v1
lint:
use:
- DEFAULT
except:
- PACKAGE_VERSION_SUFFIX - 不需要校验的源码包
lint:
use:
- DEFAULT
ignore:
- google/type/datetime.proto
- remote: 远程的DNS name 地址，buf.build就是
- owner:库的所有者
- repository:仓库名
petapis git:(main) ✗ buf registry login
# 登陆后效果
(⎈ |teleport.gllue.com-test:danny-xia)➜ go_test cat ~/.netrc
machine buf.build
login danny5487401
password 9dc4224ac972468497698940586d1d672fd91fe38bde4e4b8e5c87d1dc8830d6
machine go.buf.build
login danny5487401
password 9dc4224ac972468497698940586d1d672fd91fe38bde4e4b8e5c87d1dc8830d6
buf beta registry repository create buf.build/Danny5487401/petapis --visibility publicversion: v1
name: buf.build/danny5487401/petapis相当于github的readme文件
buf pushrm -rf google
去除lint忽略文件
version: v1
lint:
use:
- DEFAULT
- ignore:
- - google/type/datetime.proto
version: v1
+deps:
+ - buf.build/googleapis/googleapis
# buf build会报错
WARN Specified deps are not covered in your buf.lock, run "buf mod update":
- buf.build/googleapis/googleapis
pet/v1/pet.proto:7:8:google/type/datetime.proto: does not exist上面因为googleapis/googleapis不在
更新外部依赖
buf mod update多个buf.lock文件，这样就不需要拷贝外部的proto文件了
前置本地工具
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest - name: go
out: gen/proto/go
opt: paths=source_relative
- name: go-grpc
out: gen/proto/go
opt:
- paths=source_relative
- require_unimplemented_servers =false- gen/proto/go: 在这下面生成文件
- paths=source_relative: 跟 pet/v1相对目录生成文件
buf generate buf.build/Danny5487401/petapismodule github.com/bufbuild/buf-tour/petstore
go 1.16
require (
google.golang.org/genproto v0.0.0-20220505152158-f39f71e6c8f3
google.golang.org/grpc v1.46.0
google.golang.org/protobuf v1.28.0
)petapi需要调用paymentapis内容
#buf.work.yaml
version: v1
directories:
- paymentapis
- petapisgo_package是很复杂使用的，一般使用和module的名字想通
syntax = "proto3";
package pet.v1;
-option go_package = "github.com/bufbuild/buf-tour/petstore/gen/proto/go/pet/v1;petv1";这时候会报错
#rm -rf gen
#buf generate
protoc-gen-go: unable to determine Go import path for "payment/v1alpha1/payment.proto"
Please specify either:
• a "go_package" option in the .proto source file, or
• a "M" argument on the command line.
See https://developers.google.com/protocol-buffers/docs/reference/go-generated#package for more information.
...# buf.gen.yaml
version: v1
+managed:
+ enabled: true
+ go_package_prefix:
+ default: github.com/bufbuild/buf-tour/petstore/gen/proto/gobuf generate 后,会覆盖依赖包googleapis的值，此时运行会报错找不到包
# buf.gen.yaml
version: v1
managed:
enabled: true
go_package_prefix:
default: github.com/bufbuild/buf-tour/petstore/gen/proto/go
+ except:
+ - buf.build/googleapis/googleapis项目顺序
- googleapis
- paymentapis
- petapis