proto编译引用外部包问题

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

1
import "google/api/annotations.proto";

当使用命令编译的时候提示找不到包:

1
2
3
# 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,此时的完整路径应该是:

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

这才完成了第一步,如果这时候去直接执行protoc编译命令,依旧会得到上面的报错信息,protoc并没有成功的获取到外部proto文件。

为了解决问题,首先了解下protoc中import的两条规则:

  1. import 不允许使用相对路径:Backslashes, consecutive slashes, ".", or ".." are not allowed in the virtual path
  2. import 导入路径应该使用从根开始的绝对路径:google/api/annotations.proto

这个根开始的绝对路径指的是$GOPATH/src开始的路径,这个需要先了解。

假设此时的目录结构为:

1
2
3
4
5
6
src
-- google
-- api
-- annotations.proto
-- test
-- test.proto

test.proto中引用了google/api/annotations.proto,此时我们命令的执行位置为:

1
src/test

执行的命令为:

1
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目录下,即

1
protoc -I ../

完整命令:

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

每个-I参数都引入一个目录,proto文件中引入了几个外部proto文件理论来说就需要多少个-I(同一目录的可以一次性引入),再加上待编译的proto也需要引入,所以上面这里就用了两个-I来引入目录文件。

推荐使用$GOPATH/src的方式来引入

简单直观不容易出错

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

针对Js版本的动态引入

grpc-node 提供了结合 @grpc/proto-loader 进行动态引入proto的功能.

如果使用该方式,则忽略上面提到的**import的两条规则**.

即优先考虑使用相对路径引入,否则报错:Error: ENOENT: no such file or directory

1
2
// eg:test.proto中需要这样写
import "../google/api/http.proto";