golang Proto生成

文章介绍了如何在Go环境中配置protoc并使用protoc-gen-gogofaster工具生成proto文件对应的Go代码,避免修改proto文件和生成多余字段。首先设置gopath,下载并安装protoc,然后安装protoc-gen-gogofaster,将其添加到环境变量。在proto文件目录下运行protoc命令生成Go代码,同时提到了使用gogofaster生成的结构体便于字节流的解码和编码。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

首先安装go配置好gopath等参数,然后下载最新的protoc,安装,配置protoc到系统环境变量path中[如果是mac则可以使用brew install protobuf安装]。

安装完后使用protoc-gen-gogofaster配合protoc进行生成proto文件对应的go文件。原因是如果用protoc-gen-go需要在protoc里配置package之类的多余的东西。不方便和其他语言公用一个proto文件,不用gogofast是因为会生成多余的字段。影响使用。而gogofaster则既不用修改proto文件,又不会在生成的结构体里多生成字段。

步骤

  1. 运行:

    go install github.com/gogo/protobuf/protoc-gen-gogofaster@latest
    

    会在gopath目录的bin里面生成一个protoc-gen-gogofaster.exe文件。

  2. 将生成protoc-gen-gogofaster.exe添加到protoc.exe所在文件夹中(否则提示未定义 --gogofaster_out)[如果是mac系统只需要将protoc-gen-gogofaster上层目录加到环境变量中即可]

  3. 使用命令行在proto文件所在目录下(否则需要添加输入“-I proto文件目录”)运行:

    protoc --gogofaster_out=输出目录 proto文件(带.proto)
    

    会在输入目录下生成xxx.pb.go文件。便可拿到golang中使用了。

顺便一提,字节流解码成gogofaster生成的proto结构,或者proto结构编码成字节流可以使用下面命令导入proto,(如果运行过步骤1则不需要,步骤1已经下载过了这个依赖).使用proto.Unmarshal 解码,proto.Marshal 编码。

	go install github.com/gogo/protobuf/proto@latest
### Golang Protocol Buffers 使用教程 #### 安装 Protocol Buffers 编译器 为了在 Go 应用程序中使用 Protocol Buffers,需要先安装 `protoc` 编译器。该编译器负责将 `.proto` 文件转换成目标语言的源代码文件[^5]。 可以按照官方文档指南下载适合操作系统的版本,并将其路径添加到环境变量中以便全局调用。 #### 创建 .proto 文件 创建一个新的 `.proto` 文件来定义消息格式。下面是一个简单的例子: ```protobuf syntax = "proto3"; option go_package = "./;examplepb"; message Person { string name = 1; int32 id = 2; string email = 3; } ``` 此段代码定义了一个名为 `Person` 的消息类型,其中包含了三个字段:名字 (`name`)、ID (`id`) 和电子邮件地址 (`email`)。每个字段都有唯一的编号,这是用来识别字段的关键部分[^1]。 #### 生成 Go 代码 保存上述 `.proto` 文件后,在终端执行命令以生成对应的 Go 源码: ```bash protoc --go_out=. person.proto ``` 这会基于给定的消息定义自动生产必要的序列化/反序列化逻辑。生成后的文件可以直接被引入至项目当中[^4]。 #### 初始化 Go 工程并编写测试案例 确保已经初始化好 Go module 并设置了正确的依赖项之后,就可以开始写入业务逻辑了。这里给出一段简单示例展示怎样编码和解码 `Person` 对象: ```go package main import ( "log" example "path/to/generated/code/examplepb" // 替换成实际位置 ) func main() { person := &example.Person{ Name: "Alice", Id: 1, Email: "alice@example.com", } data, err := proto.Marshal(person) if err != nil { log.Fatal("marshaling error:", err) } newPerson := &example.Person{} err = proto.Unmarshal(data, newPerson) if err != nil { log.Fatal("unmarshaling error:", err) } log.Printf("Unmarshal result %+v", *newPerson) } ``` 这段代码展示了如何实例化一个 `Person` 类型的对象,接着利用 `Marshal()` 函数对其进行序列化处理;随后再通过 `Unmarshal()` 方法恢复原始对象状态[^2]。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值