卓越飞翔博客卓越飞翔博客

卓越飞翔 - 您值得收藏的技术分享站
技术文章35140本站已运行394

`go mod tidy` 抱怨 bazel 生成的 protobuf 包丢失

`go mod tidy` 抱怨 bazel 生成的 protobuf 包丢失

php小编香蕉在处理编译错误时,有时会遇到"go mod tidy"命令抱怨bazel生成的protobuf包丢失的问题。这个问题的解决方法其实很简单,只需要在go.mod文件中手动添加对应的protobuf包依赖即可。通过执行"go mod tidy"命令来更新依赖关系,再次编译就不会出现包丢失的问题了。这个方法简单有效,能够帮助开发者快速解决编译错误,提高开发效率。

问题内容

我在目录中有一个 .proto protobuf 定义文件,我正在使用 bazel 从中构建一个 go 库,如下所示(下面使用 gazelle 生成的 build.bazel 文件):

load("@rules_proto//proto:defs.bzl", "proto_library")
load("@io_bazel_rules_go//go:def.bzl", "go_library")
load("@io_bazel_rules_go//proto:def.bzl", "go_proto_library")

proto_library(
    name = "events_proto",
    srcs = ["events.proto"],
    visibility = ["//visibility:public"],
    deps = ["@com_google_protobuf//:timestamp_proto"],
)

go_proto_library(
    name = "proto_go_proto",
    importpath = "github.com/acme/icoyote/proto",
    proto = ":events_proto",
    visibility = ["//visibility:public"],
)

go_library(
    name = "proto",
    embed = [":proto_go_proto"],
    importpath = "github.com/acme/icoyote/proto",
    visibility = ["//visibility:public"],
)

其他一些代码依赖于 //icoyote/proto:proto,当我在模块中运行 go mod tidy 时,它抱怨找不到包 github.com/acme/icoyote/proto:

go: finding module for package github.com/acme/icoyote/proto
github.com/acme/icoyote/cmd/icoyote imports
        github.com/acme/icoyote/proto: no matching versions for query "latest"

任何没有 bazel 集成的 ide(例如 vscode、没有 bazel 插件的 goland/intellij)也会抱怨

我该怎么办?

解决方法

之所以发生这种情况,是因为 bazel 确实使用 protocbuild 文件中的 go_proto_library 规则下生成 .go 文件,但仅将它们写到 bazel 下的临时目录中 - bingo_library 规则使用,并且 go mod tidy 似乎没有研究 bazel-bin (可能是因为它是一个符号链接,但如果是的话,这些文件相对于 go.mod 位置的路径都是错误的)

一种选择是通过自己调用 protoc 手动生成 go 文件,并删除 build 文件中的 proto_librarygo_proto_library 规则,然后更改 go_library 规则来构建生成的文件。这是次优的,因为每次更改 .proto 文件时都必须手动重新运行 protoc (如果将其放入 //go:generate 指令,则必须重新运行 gogenerate)。

相反,我们可以执行以下操作:

  1. 将文件 empty.go 添加到包含 .proto 文件的目录中。它应该看起来像这样:
package proto
  • 然后告诉 ngazelle 忽略 empty.go (这样当您运行 gazelle --fix 时,它不会尝试将 go_library 规则添加到 build 文件中)。我们通过将以下内容添加到 build 文件来实现此目的:
  • # gazelle:exclude empty.go

    这足以让 go mod tidy 闭嘴。

    这也将使 ide 停止抱怨导入,尽管在引用该包中应该包含的任何内容时仍然会出现错误。如果您不想放弃 ide 而选择带有 bazel 插件的优秀 goland 或 intellij idea,您可能必须求助于手动 protoc 方法。也许有一种方法可以创建一个符号链接到 bazel 在 bazel-bin 下写出生成的 .go 文件的位置,并强制 go mod tidy 跟随它,但我还没有尝试过。如果您这样做并且有效,请分享!

    卓越飞翔博客
    上一篇: 喵喵对话数据
    下一篇: 返回列表
    留言与评论(共有 0 条评论)
       
    验证码:
    隐藏边栏