如何使用proto组件编译pb.go文件

更新时间：2023年10月13日 11:31:45 作者：Yisany

这篇文章主要介绍了如何使用proto组件编译pb.go文件的详细过程详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

前提

所有组件已经安装好，包括：

protoc

protoc-gen-go

protoc-gen-grpc-gateway

protoc-gen-swagger

怎么装再开一篇

分为三个部分：

编译pb.go
编译pb.gw.go
编译swagger.json

首先准备hello.proto文件

syntax = "proto3";
package hello;
import "google/api/annotations.proto";
service HelloWorld {
  rpc SayHelloWorld(HelloWorldRequest) returns (HelloWorldResponse) {
    option (google.api.http) = {
      post: "/hello_world"
      body: "*"
    };
  }
}
message HelloWorldRequest {
  string referer = 1;
}
message HelloWorldResponse {
  string message = 1;

1. 编译pb.go文件

需要使用protoc-gen-go组件，命令：

protoc --go_out=plugins=grpc:. ${xxx.proto}

注意要用-I参数引入相关的依赖，例如这里的google/api/annotations.proto：

protoc -I ./ -I $GOPATH/src -I $GOPATH/src/google/api --go_out=plugins=grpc:.

第一个-I

引入当前目录（因为要用hello.proto）；

第二个-I

引入go的相关依赖；

第三个-I

引入annotations.proto这个文件，使用的前提是$GOPATN/src下已经准备好了相关的包；

完整命令：

protoc -I ./ -I $GOPATH/src -I $GOPATH/src/google/api --go_out=plugins=grpc:. ./hello.proto

输出：

$ protoc -I ./ -I $GOPATH/src -I $GOPATH/src/google/api --go_out=plugins=grpc:. ./hello.proto
protoc-gen-go: unable to determine Go import path for "hello.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.
--go_out: protoc-gen-go: Plugin failed with status code 1.

看输出需要在hello.proto文件中指定go_package参数，这里设置为当前目录，更新下hello.proto内容：

syntax = "proto3";
package hello;
option go_package="./";
import "google/api/annotations.proto";
service HelloWorld {
  rpc SayHelloWorld(HelloWorldRequest) returns (HelloWorldResponse) {
    option (google.api.http) = {
      post: "/hello_world"
      body: "*"
    };
  }
}
message HelloWorldRequest {
  string referer = 1;
}
message HelloWorldResponse {
  string message = 1;
}

再次编译，成功生成hello.pb.go文件。

2. 编译pb.gw.go文件

需要使用protoc-gen-grpc-gateway 组件，命令：

protoc -I ./ -I $GOPATH/src -I $GOPATH/src/google/api --grpc-gateway_out=logtostderr=true:.

运行：

protoc -I ./ -I $GOPATH/src -I $GOPATH/src/google/api --grpc-gateway_out=logtostderr=true:. ./hello.proto

这时候命令行会输出一大串东西，生成文件失败，并且在最后标注了：

...
--grpc-gateway_out: 11:1: expected 'IDENT', found 'import'

试了很多方法，最后发现，go_package参数不能写./，要加上后缀包名，例如改成./hello，不知道真正的原因是不是这个，但这样改了以后编译通过了。

这时候完整的hello.proto如下：

syntax = "proto3";
package hello;
option go_package="./hello";
import "google/api/annotations.proto";
service HelloWorld {
  rpc SayHelloWorld(HelloWorldRequest) returns (HelloWorldResponse) {
    option (google.api.http) = {
      post: "/hello_world"
      body: "*"
    };
  }
}
message HelloWorldRequest {
  string referer = 1;
}
message HelloWorldResponse {
  string message = 1;
}

重新运行上面的命令，成功生成 hello.pb.gw.go文件，此时目录如下：

.
├── hello
│ └── hello.pb.gw.go
├── hello.pb.go
└── hello.proto

3. 编译swagger.json文件

需要使用protoc-gen-swagger 组件，命令：

protoc -I ./ -I $GOPATH/src -I $GOPATH/src/google/api --swagger_out=logtostderr=true:.

运行：

protoc -I ./ -I $GOPATH/src -I $GOPATH/src/google/api --swagger_out=logtostderr=true:. ./hello.proto

变成成功，生成hello.swagger.json文件。

总结

至此，三个文件都已经成功生成了，整理下目录文件，如下：

.
├── hello.pb.go
├── hello.pb.gw.go
├── hello.proto
└── hello.swagger.json

其中踩了好几个坑：

google/api/annotations.proto怎么解决
proto引入外部proto文件怎么处理
gateway生成失败报错

虽然还有些地方没弄清楚，但好歹都解决了，记录一下供学习。

以上就是如何使用proto组件编译pb.go文件的详细内容，更多关于go proto编译组件的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

Go mod replace使用方法及常见问题分析
这篇文章主要为大家介绍了Go mod replace使用方法及常见问题分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-08-08
golang通过gorm操作sqlite设置主键自增的步骤
这篇文章主要介绍了golang通过gorm操作sqlite设置主键自增的详细步骤,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
2023-09-09
浅谈go中defer的一个隐藏功能
这篇文章主要介绍了浅谈go中defer的一个隐藏功能，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-12-12
利用Go语言实现Raft日志同步
这篇文章主要为大家详细介绍了如何利用Go语言实现Raft日志同步，文中的示例代码讲解详细，对我们深入了解Go语言有一定的帮助，需要的可以参考一下
2023-05-05
Go 1.22中的for循环新特性详解
在 Go 语言中,for 循环是实现迭代的主要方式,Go 中的 for 循环非常灵活,有多种使用方式,本文将给大家详细的介绍一下Go 1.22中的for循环新特性,感兴趣的朋友可以参考下
2024-02-02
go local history本地历史恢复代码神器
这篇文章主要为大家介绍了go local history本地历史恢复代码神器的使用功能详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2024-01-01
3个Go语言中实用重构技术分享
代码重构是在不改变外部功能的情况下对现有代码进行改进，是编程的核心部分之一，本文为大家介绍了Go语言中3个实用重构技术，需要的可以参考一下
2023-06-06
浅谈Go Channel 高级实践
这篇文章主要介绍了浅谈Go Channel 高级实践，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-08-08
golang调用shell命令(实时输出,终止)
本文主要介绍了golang调用shell命令(实时输出,终止)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-02-02
Go设置http请求超时的方法实现
这篇文章主要介绍了Go设置http请求超时的方法实现,最近接手了一个老项目进行维护,发现其中有个关于 http 请求的方法设置的 timeout 没有生效,很奇怪,一开始查看代码并没有发现什么可疑点,后查看了源码,打断点调试才发现问题所在,这里简单记录复盘一下
2024-08-08