如何使用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中序列化与反序列化的基本使用，需要的可以参考一下2023-04-04
这篇文章主要给大家介绍了Go语言中的内存布局，那么本文中将尝试解释Go如何在内存中构建结构体，以及结构体在字节和比特位方面是什么样子。 有需要的朋友们可以参考借鉴，感兴趣的朋友们下面来跟着小编一起学习学习吧。2016-11-11
这篇文章主要介绍了Golang 统计字符串中数字字母数量,本文给出了两种从字符串获取数字与字母数量的方法，分别是ASCII 码值和正则表达式，需要的朋友可以参考下2022-06-06
本文主要介绍了Golang中Json的序列化和反序列化的使用，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-04-04
这篇文章主要介绍了Go 修改map slice array元素值操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2020-12-12
golang RWMutex读写锁实现读共享写独占的功能示例
在 Go 里除了互斥锁外,还有读写锁 RWMutex,它主要用来实现读共享,写独占的功能,今天我们也顺便分析下读写锁,加深对 Go 锁的理解2023-09-09
golang中package is not in GOROOT报错的真正解决办法
这篇文章主要给大家介绍了关于golang中package is not in GOROOT报错的真正解决办法,文中通过图文介绍的非常详细,对同样遇到这个问题的朋友具有一定的参考学习价值,需要的朋友可以参考下2023-03-03
本文主要介绍了Gin+Gorm实现CRUD的实战，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-02-02
这篇文章主要为大家介绍了go slice 扩容实现原理源码解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2023-01-01
gRPC是一种进程间通信技术,在微服务和云原生领域都有着广泛的应用,下面这篇文章主要给大家介绍了关于Golang中四种gRPC模式的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下2024-03-03
最新评论