go proto编译引用外部包问题解决方案示例

更新时间：2023年10月13日 11:18:25 作者：返回主页Yisany

这篇文章主要为大家介绍了go 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的两条规则：

import 不允许使用相对路径；
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

以上就是go proto编译引用外部包问题解决方案示例的详细内容，更多关于go proto编译引用外部包的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

一文带你熟悉Go语言中的for循环
这篇文章主要和大家分享一下Go语言中for循环的定义与使用，文中的示例代码讲解详细，对我们学习Go语言有一定的帮助，需要的可以参考一下
2022-11-11
golang 日志库ZAP[uber-go zap]示例详解
ZAP是由Uber开源的高性能Go语言日志库,支持多种日志级别及基本信息打印,虽然ZAP本身不支持日志分割,但可以结合lumberjack进行日志切割,实现日志按文件大小、时间或间隔切割等功能,ZAP提供Logger和SugaredLogger两种日志记录器
2024-10-10
golang搭建静态web服务器的实现方法
这篇文章主要介绍了golang搭建静态web服务器的实现方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-08-08
Golang 使用gorm添加数据库排他锁,for update
这篇文章主要介绍了Golang 使用gorm添加数据库排他锁,for update，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-12-12
go语言beego框架web开发语法笔记示例
这篇文章主要为大家介绍了go语言beego框架web开发语法笔记示例，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步早日升职加薪
2022-04-04
Go调用链可视化工具使用实例探究
本文介绍一款工具 go-callvis,它能够将 Go 代码的调用关系可视化出来,并提供了可交互式的 web 服务,在接手他人代码或调研一些开源项目时,如果能够理清其中的代码调用链路,这将加速我们对实现的理解
2024-01-01
Golang开发之字符串与切片问题踩坑记录
字符串和切片，都是golang常用的两种内置数据类型，最近在日常工作中，遇到了一个字符串切片导致的问题，记录一下排查问题的过程，避免后续在这种场景上踩坑
2023-07-07
Go语言中的基础数据类型使用实例
这篇文章主要为大家介绍了Go中的基础数据类型使用示例解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-04-04
golang官方嵌入文件到可执行程序的示例详解
这篇文章主要介绍了golang官方嵌入文件到可执行程序,本文通过示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-02-02
golang中的io.ReadCloser与ioutil.NopCloser使用
这篇文章主要介绍了golang中的io.ReadCloser与ioutil.NopCloser使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-03-03