导入GitHub存储库中的protobuf文件
如何导入 GitHub 存储库中的 protobuf 文件?Protobuf 没有远程导入路径的本机概念,因此导入路径必须相对于指示的本地文件系统基本路径。通常,最简单的方法是为您的组织创建一个包含 protobuf 定义的存储库,并将导入路径设置为相对于该存储库的 protos/ 目录。另一种选择是使用 buf,它可以通过 go 模块导入生成的 pb 代码,或者将所有代码生成到单独的存储库中。
我目前有两个 protobuf 存储库:api 和 timestamp:
时间戳存储库:
- readme.md - timestamp.proto - timestamp.pb.go - go.mod - go.sum
api 存储库:
- readme.md - protos/ - dto1.proto - dto2.proto
目前,timestamp 包含对我想在 api 中使用的时间戳对象的引用,但我不确定导入应该如何工作,或者应该如何修改编译过程来处理这个问题。让这个过程变得复杂的是,api 存储库被编译为 go 的一个单独的下游存储库,名为 api-go。
例如,考虑 dto1.proto:
syntax = "proto3"; package api.data; import ""; option go_package = "github.com/my-user/api/data"; // golang message dto1 { string id = 1; timestamp timestamp = 2; }
我的编译命令是这样的:
find $GEN_PROTO_DIR -type f -name "*.proto" -exec protoc \
--go_out=$GEN_OUT_DIR --go_opt=module=github.com/my-user/api-go \
--go-grpc_out=$GEN_OUT_DIR --go-grpc_opt=module=github.com/my-user/api-go \
--grpc-gateway_out=$GEN_OUT_DIR --grpc-gateway_opt logtostderr=true \
--grpc-gateway_opt paths=source_relative --grpc-gateway_opt
generate_unbound_methods=true \{} \;
假设我在 timestamp 中为我想要将 api 编译成的每种编程语言都有一个定义,我如何将其导入到 .proto 文件中以及我应该做什么来确保导入不会破坏我的下游回购?
正确答案
protobuf 没有远程导入路径的本机概念。因此导入路径必须相对于某些指示的本地文件系统基本路径(通过 -i / --proto_path 指定)。
选项 1
通常,最简单的方法是为您的组织创建一个包含 protobuf 定义的存储库 - 例如名为 acme-contract 的存储库
.
└── protos
└── acme
├── api
│ └── data
│ ├── dto1.proto
│ └── dto2.proto
└── timestamp
└── timestamp.proto
你的 dto1.proto 看起来像:
syntax = "proto3";
package acme.api.data;
import "acme/timestamp/timestamp.proto";
message dto1 {
string id = 1;
acme.timestamp.timestamp timestamp = 2;
}
只要生成与此存储库的 protos/ 目录相关的代码,就不应该有问题。
选项 2
有多种替代方案,您可以继续将定义拆分到不同的存储库中,但您无法真正逃避导入与文件系统相关的事实。
从历史上看,这可以通过手动克隆各种存储库并安排目录以使路径是相对的,或者使用 -i 指向可能有意或无意包含原始文件的各种位置(例如在 $gopath 中)来处理。这些策略最终往往会变得相当混乱且难以维护。
buf 现在让事情变得更容易了。如果您想要拥有 timestamp 存储库:
.
├── buf.gen.yaml
├── buf.work.yaml
├── gen
│ └── acme
│ └── timestamp
│ └── timestamp.pb.go
├── go.mod
├── go.sum
└── protos
├── acme
│ └── timestamp
│ └── timestamp.proto
├── buf.lock
└── buf.yaml
timestamp.proto 看起来像:
syntax = "proto3";
package acme.timestamp;
option go_package = "github.com/my-user/timestamp/gen/acme/timestamp";
message timestamp {
int64 unix = 1;
}
buf.gen.yaml 看起来像:
version: v1
plugins:
- name: go
out: gen
opt: paths=source_relative
- name: go-grpc
out: gen
opt:
- paths=source_relative
- require_unimplemented_servers=false
- name: grpc-gateway
out: gen
opt:
- paths=source_relative
- generate_unbound_methods=true
... gen/ 下的所有内容都是通过 bufgenerate 生成的。
然后在您的 api 存储库中:
.
├── buf.gen.yaml
├── buf.work.yaml
├── gen
│ └── acme
│ └── api
│ └── data
│ ├── dto1.pb.go
│ └── dto2.pb.go
└── protos
├── acme
│ └── api
│ └── data
│ ├── dto1.proto
│ └── dto2.proto
├── buf.lock
└── buf.yaml
buf.yaml 看起来像:
version: v1
name: buf.build/your-user/api
deps:
- buf.build/your-user/timestamp
breaking:
use:
- file
lint:
use:
- default
dto1.proto 看起来像:
syntax = "proto3";
package acme.api.data;
import "acme/timestamp/timestamp.proto";
option go_package = "github.com/your-user/api/gen/acme/api/data";
message dto1 {
string id = 1;
acme.timestamp.timestamp timestamp = 2;
}
和 buf.gen.yaml 与 timestamp 存储库中的相同。
通过 bufgenerate 生成的代码将依赖于通过 go 模块的 timestamp 存储库:
// code generated by protoc-gen-go. do not edit.
// versions:
// protoc-gen-go v1.28.1
// protoc (unknown)
// source: acme/api/data/dto1.proto
package data
import (
timestamp "github.com/your-user/timestamp/gen/acme/timestamp"
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
reflect "reflect"
sync "sync"
)
//
请注意,如果对依赖项进行更改,您需要确保 buf 和 go 模块保持相对同步。
选项 3
如果您不想利用 go 模块来导入生成的 pb 代码,您也可以寻找与 option 2 类似的设置,而是将所有代码生成到单独的存储库中(类似于从声音来看,你现在正在做的事情)。通过使用 buf 托管模式最容易实现这一点,这基本上使其不需要+忽略任何 go_modules 指令。
在 api-go 中:
. ├── buf.gen.yaml ├── go.mod └── go.sum
buf.gen.yaml 包含:
version: v1
managed:
enabled: true
go_package_prefix:
default: github.com/your-user/api-go/gen
plugins:
- name: go
out: gen
opt: paths=source_relative
- name: go-grpc
out: gen
opt:
- paths=source_relative
- require_unimplemented_servers=false
- name: grpc-gateway
out: gen
opt:
- paths=source_relative
- generate_unbound_methods=true
然后,您需要为每个相应的存储库生成代码(布什到 bsr):
$ buf generate buf.build/your-user/api $ buf generate buf.build/your-user/timestamp
之后您应该为两者生成一些代码:
. ├── buf.gen.yaml ├── gen │ └── acme │ ├── api │ │ └── data │ │ ├── dto1.pb.go │ │ └── dto2.pb.go │ └── timestamp │ └── timestamp.pb.go ├── go.mod └── go.sum
导入将相对于当前模块:
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.28.1
// protoc (unknown)
// source: acme/api/data/dto1.proto
package data
import (
timestamp "github.com/your-user/api-go/gen/acme/timestamp"
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
reflect "reflect"
sync "sync"
)
//
总而言之,我建议选择 1 - 将您的 protobuf 定义合并到单个存储库中(包括供应商第 3 方定义) - 除非有特别充分的理由不这样做。
文中关于的知识介绍,希望对你的学习有所帮助!若是受益匪浅,那就动动鼠标收藏这篇《导入GitHub存储库中的protobuf文件》文章吧,也可关注golang学习网公众号了解相关技术文章。
PHP修改字体中字符编码向量
- 上一篇
- PHP修改字体中字符编码向量
- 下一篇
- 2023年消费维权舆情热点:电商主播言行不当引发投诉居于榜首
-
- Golang · Go问答 | 19分钟前 | 标准库 · go · Go image.Gray SubImage 灰度图 像素存储
- Go image.Gray.SubImage 怎样取得共享像素存储的灰度子图
- 112浏览 收藏
-
- Golang · Go问答 | 27分钟前 | 标准库 · Go问答 · Go 透明度 image.Rectangle image.Alpha image.Alpha.SubImage 像素共享
- Go image.Alpha.SubImage 怎样理解裁剪视图与原缓冲区的共享
- 450浏览 收藏
-
- Golang · Go问答 | 34分钟前 | 标准库 · 序列化 · Go问答 · Go 自定义类型 序列化 encoding/gob GobDecoder GobDecode GobEncoder
- Go encoding/gob.GobDecoder 怎样让自定义类型接管 Gob 解码
- 164浏览 收藏
-
- Golang · Go问答 | 44分钟前 | 网络编程 · 标准库 · go · SMTP Go net/textproto 点编码 文本协议 Writer.DotWriter
- Go net/textproto.Writer.DotWriter 怎样写入需要点转义的协议正文
- 450浏览 收藏
-
- Golang · Go问答 | 50分钟前 | 标准库 · go · Go bufio.Reader net/textproto 文本协议 Reader.ReadLineBytes
- Go net/textproto.Reader.ReadLineBytes 怎样理解返回缓冲区的有效期
- 458浏览 收藏
-
- Golang · Go问答 | 58分钟前 | 标准库 · go · Go index/suffixarray 后缀数组 suffixarray.Index.Write 二进制流
- Go index/suffixarray.Index.Write 怎样把后缀数组索引写入二进制流
- 241浏览 收藏
-
- Golang · Go问答 | 1小时前 | 数据结构 · go · Go container/ring Ring.Len 环形结构
- Go container/ring.Ring.Len 怎样统计环形结构中的元素数
- 452浏览 收藏
-
- Golang · Go问答 | 1小时前 |
- Go testing/fstest.MapFS.Sub 怎样把子目录作为独立文件系统使用
- 275浏览 收藏
-
- Golang · Go问答 | 1小时前 | 标准库 · 测试 · go · Go io.Reader 短读 testing/iotest OneByteReader 单字节读取
- Go testing/iotest.OneByteReader 怎样模拟逐字节读取的输入
- 316浏览 收藏
-
- Golang · Go问答 | 1小时前 |
- Go debug/gosym.Table.LineToPC 怎样根据文件和行号查询地址
- 419浏览 收藏
-
- Golang · Go问答 | 1小时前 |
- Go debug/gosym.Table.SymByAddr 怎样按地址寻找符号对象
- 408浏览 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 1095次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 1092次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 1259次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 1200次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 1049次使用
-
- 用Nginx反向代理部署go写的网站。
- 2023-01-17 502浏览
-
- GoLand调式动态执行代码
- 2023-01-13 502浏览
-
- Go index/suffixarray.Index.Bytes 怎样取得索引引用的原始数据
- 2026-11-18 501浏览
-
- Go gosym.Sym.BaseName 怎样去掉符号的包名与接收者
- 2026-11-17 501浏览
-
- 正则命名捕获组取不到值怎么办
- 2026-11-15 501浏览

