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

Question

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

make gen-go

go 构建失败并显示以下消息：

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 作者的目标是跨语言以及 Go 的 GOPATH 和 GO MODULES 用例的一致性......所以，是的，对他们和我们来说都很粗糙。

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

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

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

make gen-go 和以前一样。这应该创建 ./opentelemetry-proto/gen
在./opentelemetry-proto/gen/go/github.com/open-telemetry/opentelemetry-proto中去go mod init github.com/open-telemetry/opentelemetry-proto:

.
├── gen
└── go.mod

从 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

NOTE With GOPATH paths down to packages are required (they're not using Go Modules) and so, if we were using GOPATH, we could 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.

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

NOTE Commonly protobuf imports are pb but I've used v1.

我会做什么：

我认为生成代码的模块应该与其存储库匹配。如果 opentelemetry-proto 是我的，我会在没有 gen/go

的情况下将源代码生成到 repo root

因为这将 -- IMO -- 将所有内容简化为：

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

并且：

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

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

Golang. Replace module path for package that are not real go packages

go

protocol-buffers

open-telemetry