戈朗。替换不是真正的 go 包的包的模块路径

Question

有这个包https://github.com/open-telemetry/opentelemetry-proto 其中仅包含 protobuf 定义。要生成 golang 代码，必须键入：

make gen-go

go build 失败并显示以下消息：

build opentel: cannot load github.com/open-telemetry/opentelemetry-proto/gen/go/common/v1: module github.com/open-telemetry/opentelemetry-proto@latest found (v0.11.0), but does not contain package github.com/open-telemetry/opentelemetry-proto/gen/go/common/v

我试图在 go.mod 文件中用另一个路径替换一个路径，但显然我不太擅长。我怎样才能让它发挥作用？

我已将这些生成的文件复制到

$GOPATH/src/opentelemetry-proto/gen/go

我应该在主包中的 import 语句中添加什么？

Answer 1

Go 源代码的生成方式存在一些挑战。我假设 repo 作者的目标是跨语言和 GOPATH 和 GO MODULES Go 用例的一致性......所以，是的，对他们和我们来说都是粗糙的。​​

这是一个（！？）解决方案：

假设您在 /path/to/somedir 中，并且它包含同一级别的 opentelemetry-proto 和 ``my-module` 的克隆，即：

.
├── my-module
└── opentelemetry-proto

1. make gen-go 和以前一样。这应该创建./opentelemetry-proto/gen

2. 在./opentelemetry-proto/gen/go/github.com/open-telemetry/opentelemetry-proto 转到go mod init github.com/open-telemetry/opentelemetry-proto：

.
├── gen
└── go.mod

1. 从my-module、go mod init my-module 内部，然后：

go.mod:

module my-module

go 1.17

require (
    github.com/open-telemetry/opentelemetry-proto v0.11.0
)

replace (
    github.com/open-telemetry/opentelemetry-proto => ../opentelemetry-proto/gen/go/github.com/open-telemetry/opentelemetry-proto

注意使用GOPATH 到包的路径是必需的（它们不使用 Go 模块），因此，如果我们使用GOPATH，我们可以GOPATH=${GOPATH}:${PROTO_GEN_GO_DIR}/github.com/open-telemetry/opentelemetry-proto

然后，例如

main.go:

package main

import (
    v1 "github.com/open-telemetry/opentelemetry-proto/gen/go/collector/metrics/v1"
)

func main() {
    // E.g.
    _ = v1.ExportMetricsServiceRequest{}
}

解释：

make gen-go 不创建模块，但我们可以创建一个。

模块隐含在gen/go 下的路径中，即github.com/open-telemetry/opentelemetry-proto

然后，在我们的项目中，我们可以通过replace 为其提供本地路径。路径是克隆的路径，然后返回到我们新创建的go.mod。

导入路径是从模块到我们感兴趣的任何包的路径（即过度复杂的替换路径）。

注意通常 protobuf 导入是 pb，但我使用的是 v1。

我会做什么：

我认为生成代码的模块应该与其 repo 匹配。如果opentelemetry-proto 是我的，我会在没有gen/go 的情况下将源代码生成到repo 根目录中

这样——IMO——将一切简化为：

github.com/open-telemetry/opentelemetry-proto => ../opentelemetry-proto

还有：

import (
    v1 "github.com/open-telemetry/opentelemetry-proto/collector/metrics/v1"
)