前提

所有組件已經(jīng)安裝好，包括：

protoc

protoc-gen-go

protoc-gen-grpc-gateway

protoc-gen-swagger

怎么裝再開(kāi)一篇

分為三個(gè)部分：

• 編譯pb.go
• 編譯pb.gw.go
• 編譯swagger.json

首先準(zhǔn)備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參數(shù)引入相關(guān)的依賴，例如這里的google/api/annotations.proto：

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

第一個(gè)-I

引入當(dāng)前目錄（因?yàn)橐?code>hello.proto）；

第二個(gè)-I

引入go的相關(guān)依賴；

第三個(gè)-I

引入annotations.proto這個(gè)文件，使用的前提是$GOPATN/src下已經(jīng)準(zhǔn)備好了相關(guān)的包；

完整命令：

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參數(shù)，這里設(shè)置為當(dāng)前目錄，更新下hello.proto內(nèi)容：

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:.

運(yùn)行：

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

這時(shí)候命令行會(huì)輸出一大串東西，生成文件失敗，并且在最后標(biāo)注了：

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

試了很多方法，最后發(fā)現(xiàn)，go_package參數(shù)不能寫./，要加上后綴包名，例如改成./hello，不知道真正的原因是不是這個(gè)，但這樣改了以后編譯通過(guò)了。

這時(shí)候完整的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;
}

重新運(yùn)行上面的命令，成功生成 hello.pb.gw.go文件，此時(shí)目錄如下：

.
├── 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:.

運(yùn)行：

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

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

總結(jié)

至此，三個(gè)文件都已經(jīng)成功生成了，整理下目錄文件，如下：

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

其中踩了好幾個(gè)坑：

• google/api/annotations.proto怎么解決
• proto引入外部proto文件怎么處理
• gateway生成失敗報(bào)錯(cuò)

雖然還有些地方?jīng)]弄清楚，但好歹都解決了，記錄一下供學(xué)習(xí)。

以上就是如何使用proto組件編譯pb.go文件的詳細(xì)內(nèi)容，更多關(guān)于go proto編譯組件的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論