找到不含包 XXX 的模块 XXX

从现在开始，我们要努力学习啦！今天我给大家带来《找到不含包 XXX 的模块 XXX》，感兴趣的朋友请继续看下去吧！下文中的内容我们主要会涉及到等等知识点，如果在阅读本文过程中有遇到不清楚的地方，欢迎留言呀！我们一起讨论，一起学习！

对 golang 不太熟悉，这可能是我犯的一个愚蠢的错误......但是，我仍然无法弄清楚。

这样，我得到了一个 proto3 文件（我们称之为 file.proto），其标头如下：

syntax = "proto3";
package [package_name];
option go_package = "github.com/[user]/[repository]";

我使用 protoc：

protoc --go_out=$gopath/src --go-grpc_out=$gopath/src file.proto

到目前为止一切顺利，我最终在 /go/src/github.com/[user]/[repository]/ 中生成了两个生成的文件（file_grpc.pb.go），并且它们在包 [package_name] 内定义。

然后，我尝试构建的代码具有以下导入：

import (
    "github.com/[user]/[repository]/[package_name]"
)

我天真地认为它会起作用。但是，在运行 go mod tidy 时会产生以下错误：

go: downloading github.com/[user]/[repository] v0.0.0-20211105185458-d7aab96b7629
go: finding module for package github.com/[user]/[repository]/[package_name]
example/xxx imports
    github.com/[user]/[repository]/[package_name]: module github.com/[user]/[repository]@latest found (v0.0.0-20211105185458-d7aab96b7629), but does not contain package github.com/[user]/[repository]/[package_name]

知道我在这里做错了什么吗？ docker 内的 go 版本为 go1.19 linux/amd64 (golang:1.19-alpine)。

注意：我也尝试仅导入 github.com/[user]/[repository]，显然同样的问题。

更新：

好吧，我所做的就是从 git 存储库获取 proto 文件，该存储库仅包含 proto 文件：

wget https://raw.githubusercontent.com/[user]/[repository]/file.proto

然后我使用 protoc 从该文件生成 go 文件：

protoc --go_out=. --go-grpc_out=. file.proto

现在，在当前目录中，它看起来像：

- directory
 | - process.go
 | - file.proto
 | - github.com
   | - [user]
     | - [repository]
       | - file.pb.go
       | - file_grpc.pb.go

在同一目录中，我运行：

go mod init xxx
go mod tidy
cgo_enabled=0 go build process.go

process.go中的导入指令如下：

import (
    "xxx/github.com/[user]/[repository]"
)

现在看起来好像找到了它，但仍然收到 grpc 错误，这很奇怪，因为没有任何变化。我仍然需要弄清楚它是否来自上述问题。谢谢！

正确答案

您的问题实际上是多个问题合而为一；我会尝试提供一些有帮助的信息。您遇到的最初问题是 because

目录中必须至少存在一个扩展名为 .go 的文件，才能将其视为包。

这是有道理的，因为如果该存储库不包含任何 .go 文件（即 go 编译器无法真正对这些文件执行任何操作），则导入 github.com/[user]/[repository] 将毫无意义。

您的选择是：

1. 将 protoc 的输出直接复制到您的项目文件夹中，并更改 package 声明以匹配您的包。如果您这样做，则无需任何导入。
2. 将 protoc 的输出复制（或将 protoc 设置为 protoc）到项目的子文件夹中。导入路径将是 go.mod 中 module 声明的值加上 go.mod 所在文件夹的路径（这就是您所做的）。
3. 将文件存储在存储库中（在 github 或其他地方）。如果您“希望它是不可知的”，则这不需要与您的 .proto 文件是相同的存储库（请注意，如果生成的文件仅在一个代码库中使用或存储库可访问，则可以组合 2 和 3）向所有用户）。

选项 1 很简单，但它通常有益于保持生成的代码独立（明确不应编辑的内容并改进编辑器自动完成功能等）。

选项 2 可以（特别是如果 protoc 直接写入文件并且您正确设置了 go_package）。但是，当生成的文件将在多个模块中使用（例如作为客户代码的一部分）并且您的存储库是私有的时，可能会出现问题。他们需要在运行 protoc 之前更改 go_package （或搜索/替换 package 声明），并且导入其他 .proto 文件可能无法正常工作。

选项 3 可能是大多数情况下的最佳方法，因为它适用于 go 工具。您可以创建 github.com/[user]/goproto （或类似的）并将所有生成的代码放在那里。要使用此功能，您的客户只需 import github.com/[user]/goproto （无需运行 protoc 等）。

Go 模块/包介绍

go spec没有详细说明导入路径的格式，留给实现：

ImportPath 的解释取决于实现，但它通常是已编译包的完整文件名的子字符串，并且可能与已安装包的存储库相关。

由于您使用的是 go modules（现在几乎是默认值），因此解析包路径（导入路径的同义词）的实现规则可以是 summarised as：

模块中的每个包都是同一目录中编译在一起的源文件的集合。包路径是与包含包的子目录连接的模块路径（相对于模块根）。例如，模块“golang.org/x/net”包含目录“html”中的包。该包的路径是“golang.org/x/net/html”。

因此，如果您的“模块路径”（通常是 go.mod 中的顶行）设置为 xxx (go mod init xxx)，那么您将在子文件夹 github.com/[user]/[repository] ​​中导入包 与 import xxx/github.com/[user]/[repository] （正如您所发现的）。如果您删除了中间文件夹并将文件放入 [repository] 子文件夹中（直接位于主文件夹中），那么它将是 import xxx/[repository]

您会在上面的示例中注意到，我使用的 module 名称是存储库的路径（而不是您在 go mod init xxx 中使用的 xxx）。这是有意为之的，因为当您从不同的模块导入包时，它允许 go 工具找到该包。例如，如果您使用了 go mod init github.com/[user]/[repository] 和 option go_package = "github.com/[user]/[repository]/myproto";" 那么生成的文件应该进入项目中的 myproto 文件夹，然后使用 import github.com/[user]/[repository]/myproto 导入它们。

虽然您不必遵循这种方法，但我强烈推荐它（它会让您免于很多痛苦！）。可能需要一段时间才能理解执行此操作的方法，但是一旦您理解了，它就会很好地工作并且非常清楚包的托管位置。

好了，本文到此结束，带大家了解了《找到不含包 XXX 的模块 XXX》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多Golang知识！