proto編譯引用外部包問題

proto編譯引用外部包問題

在test.proto文件中引用了一個外部包:

import "google/api/annotations.proto";

當使用命令編譯的時候提示找不到包：

# protoc --go_out=plugins=grpc:. ./test.proto
google/api/annotations.proto: File not found.
test.proto:5:1: Import "google/api/annotations.proto" was not found or had errors.

解決：

去github上將對應的包下載下來放在$GOPATH/src下，例如這里缺失google/api。

去gooogleapis將項目下載下來，並將整個項目放到$GOPATH/src，此時的完整路徑應該是:

$GOPATH/src/google/api/annotations.proto

這才完成了第一步，如果這時候你去直接執行protoc編譯命令，依舊會得到上面的報錯信息，protoc並沒有成功的獲取到外部proto文件。

為了解決問題，首先了解下protoc中import的兩條規則：

1. import 不允許使用相對路徑；
2. import 導入路徑應該從根開始的絕對路徑；

這個根開始的絕對路徑指的是$GOPATH/src開始的路徑，這個需要先了解。

假設此時的目錄結構為:

src
-- google
  -- api
  	-- annotations.proto
-- test
  -- test.proto

test.proto中引用了google/api/annotations.proto，此時我們命令的執行位置為：

src/test

執行的命令為：

protoc --go_out=plugins=grpc:. ./test.proto

protoc有一個參數-I，表示引入文件的目錄路徑，這里有坑。

-I參數簡單來說，就是如果多個proto文件之間有互相依賴，生成某個proto文件時，需要import其他幾個proto文件，這時候就要用-I來指定搜索目錄。如果沒有指定-I參數，則在當前目錄進行搜索。

例如這里的import "google/api/annotations.proto";，這里的這個路徑，其實是從$GOPATH/src開始的路徑。

也就是說，首先要用-I參數將引入包的路徑設置到$GOPATH/src目錄下，即

protoc -I ../

完整命令:

# pwd
.../src/test
# protoc -I ../ -I ./ --go_out=plugins=grpc:. ./test.proto

每個-I參數都引入一個目錄，proto文件中引入了幾個外部proto文件理論來說就需要多少個-I（同一目錄的可以一次性引入），再加上待編譯的proto也需要引入，所以上面這里就用了兩個-I來引入目錄文件。

推薦使用$GOPATH/src的方式來引入，簡單直觀不容易出錯：

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