管理依赖项

本文翻译自《Managing dependencies》。

目录

使用和管理依赖项的工作流程

管理模块依赖项

查找和导入有用的包

在代码中启用依赖项跟踪

给一个模块命名

添加一个依赖项

获取一个指定版本的依赖项

发现可用的更新

升级或降级一个依赖项

同步你代码的依赖项

开发和测试未发布的模块代码

       需求某个本地目录中的模块代码

       需求来自你自己的代码仓库分支的外部模块代码

使用代码仓库标识符获取特定的某个提交(commit)

移除一个依赖项指定一个模块代理服务器

当你的代码使用外部包时,这些包(作为模块分发)成为依赖项。随着时间的推移,你可能需要升级或更换它们。Go提供了依赖项管理工具,可帮助你在合并外部依赖项时确保Go应用程序的安全。

本主题描述如何执行任务来管理你在代码中采用的依赖项。你可以使用Go工具执行其中的大部分操作。本主题还描述了如何执行一些你可能会觉得有用的其他依赖相关的任务。

另请参阅

  • 如果你不熟悉将依赖项作为模块来使用,请查看入门教程以获取简要介绍。
  • 使用go命令管理依赖项有助于确保你对依赖项的需求保持一致,并且go.mod文件的内容有效。有关命令的参考,请参阅go命令。你还可以通过键入go help 命令名从命令行获得帮助,例如go help mod tidy
  • 用于更改依赖项的Go命令编辑你的go.mod文件。有关该文件内容的更多信息,请参阅go.mod文件参考
  • 让你的编辑器或IDE能够感知Go模块可以使管理它们的工作变得更容易。有关支持Go的编辑器的更多信息,请参阅编辑器插件和IDE
  • 本主题不描述如何开发、发布和模块的版本控制供其他人使用。有关更多信息,请参阅开发和发布模块

使用和管理依赖项的工作流程

你可以通过Go工具获取和使用有用的包。在pkg.go.dev上,你可以搜索你可能觉得有用的包,然后使用go命令将这些包导入到你自己的代码中以调用它们的功。

下面列出了最常见的依赖管理步骤。有关每个步骤的更多信息,请参阅本主题中的对应小节。

1 在pkg.go.dev找到有用的包

2 在代码中导入所需的包

3 将你的代码添加到模块中以进行依赖跟踪(如果它不在模块中的话)。请参阅启用依赖项跟踪

4 添加外部包作为依赖项,以便你可以管理它们。

5 随着时间的推移,根据需要升级或降级依赖项的版本

管理模块依赖项

在Go中,你将依赖项作为模块来管理,在代码中导入这些模块的包。该过程得到以下支持:

  • 用于发布模块和检索其代码的去中心化系统。开发人员使他们的模块可供其他开发人员从代码仓库中使用,并使用版本号发布。开发人员使用版本号在代码仓库中发布他们的模块,供其他开发人员获取并使用。
  • 一个包搜索引擎和文档浏览器(pkg.go.dev),你可以在其中找到模块。请参阅查找和导入有用的包
  • 模块版本编号规约可帮助你了解模块的稳定性和向后兼容性。请参阅模块版本编号
  • 使你更容易管理依赖项的Go工具,包括获取模块的源代码、升级等。有关更多信息,请参阅本主题中的各个小节。

查找和导入有用的包

你可以搜索pkg.go.dev来查找包含可能有用的函数的包。

找到要在代码中使用的包后,在页面顶部找到包路径,然后单击复制路径按钮将路径复制到剪贴板。在你自己的代码中,将路径粘贴到import语句中,如下例所示:

import "rsc.io/quote"

在代码导入包后,启用依赖项跟踪并获取要编译的包代码。有关更多信息,请参阅在代码中启用依赖项跟踪添加依一个赖项

在代码中启用依赖项跟踪

要跟踪和管理你添加的依赖项,你首先要将代码放入其自己的模块中。这会在源代码树的根目录下创建一个go.mod文件。你添加的依赖项将列在该文件中。 要将你的代码添加到它自己的模块中,请使用go mod init命令。例如,从命令行切换到代码的根目录,然后按以下示例运行命令:

$ go mod init example/mymodule

go mod init命令的参数是模块的模块路径。如果可能,模块路径应该是源代码的存储库的位置。

如果一开始你不知道模块的最终存储库位置,请使用一个安全的替代品。这可以是你拥有的域名或你控制的其他名称(如公司名称),以及模块名称或源代码目录的路径。有关详细信息,请参见给一模块个命名

当你使用Go工具管理依赖关系时,这些工具会更新go.mod文件,以便它维护你当前的依赖项列表。

添加依赖项时,Go工具也会创建一个go.sum文件,其中包含你所依赖的模块的校验和。Go使用该文件来验证下载的模块文件的完整性,尤其是对其他项目开发人员而言。

把go.mod文件和go.sum文件和代码一起放在代码存储库中。

有关更多信息,请参阅go.mod参考手册

给一个模块命名

当你运行go mod init以创建用于跟踪依赖项的模块时,你指定一个模块路径作为模块的名称。模块路径是模块中的包的导入路径的前缀。请务必指定一个不会与其他模块的模块路径有冲突的模块路径。

模块路径至少要指出有关其来源的信息,例如公司名称或作者名称或所有者姓名。但是模块路径最好也能描述模块是什么或做什么。 模块路径通常采用以下形式:

<prefix>/<descriptive-text>

前缀prefix通常是部分描述模块的字符串,例如描述模块来源的字符串。这可能是:

  • 可以让Go工具找到模块源代码的存储库的位置(如果你要发布模块,则需要模块源代码的存储库)。例如它可能是github.com/<project-name>/。如果你认为可以发布模块供其他人使用,请使用此最佳实践。有关发布的详细信息,请参阅开发和发布模块
  • 一个你掌控的名字。如果你不使用存储库名称,请确保选择一个你确信不会被其他人使用的前缀。一个很好的选择是你公司的名字。避免使用widgets、utilities或app等常用术语。

对于描述性文本descriptive-text,最好选择项目名称。请记住,包的名称才是主要描述功能信息的。模块路径为这些包的名称创建了一个命名空间。

保留的模块路径前缀

Go保证不会在包名中使用以下字符串。

  • test–你可以使用test作为模块的模块路径前缀,该模块的代码旨在本地测试另一个模块中的功能。对作为测试的一部分创建的模块使用test路径前缀。例如,你的测试本身可能会运行go mod init test,然后以某种特定方式安装该模块,以便使用Go源代码分析工具进行测试。
  • example–在某些Go文档中用作模块路径前缀,例如在教程中创建的模块只是为了跟踪依赖项。

请注意,当示例可能是一个已发布的模块时,Go文档也会使用example.com来演示。

添加一个依赖项

从已发布的模块导入包后,可以使用go get命令将该模块添加为依赖项进行管理。

该命令执行以下操作:

  • 如果有必要,它会在你的go.mod文件中为命令行上给出的包的模块添加require指令。require指令跟踪所依赖的模块的最低版本。请参阅go.mod参考手册以了解更多信息。
  • 如果需要,它会下载模块源代码,以便你可以编译依赖于它们的包。它可以从proxy.golang.org等模块代理或直接从版本控制存储库下载模块。模块源代码缓存在本地。你可以设置Go工具下载模块的位置。有关更多信息,请参阅指定模块代理服务器

下面描述几个例子。

  • 要在模块中添加包的所有依赖项,请运行如下命令(“.”指的是当前目录中的包):$ go get .
  • 要添加特定的依赖项,请将其模块路径指定为该命令的参数:$ go get example.com/theirmodule

该命令还验证它下载的每个模块。这确保它在模块发布后没有发生改变。如果模块在发布后发生了变化——例如,开发人员更改了提交(commit)的内容——Go工具将显示一个安全错误。此身份验证检查可保护你免受可能已被篡改的模块的侵害。

获取一个指定版本的依赖项

你可以通过在go get命令中指定版本号来获取依赖模块的特定版本。该命令更新go.mod文件中的require指令(当然你也可以手动更新)。

你可能想要那样做,如果:

  • 你想要获得模块的指定预发布版本以进行试用。
  • 你发现你当前使用的版本不适合你,因此你想获得一个你知道的可以依赖的版本。
  • 你想要升级或降级你已经依赖的模块。

以下是使用go get命令的示例:

  • 要获得特定编号的版本,请在模块路径后附加一个@符号,后跟你想要的版本编号:$ go get example.com/[email protected]
  • 要获取最新版本,请在模块路径后附加@latest:$ go get example.com/theirmodule@latest

以下go.mod文件的require指令示例(有关更多信息,请参阅go.mod参考手册)说明了如何需求特定版本号:

require example.com/theirmodule v1.3.4

发现可用的更新

你可以检查当前模块中是否已经使用了更新版本的依赖项。使用go list命令显示模块的依赖项列表,以及该模块可用的最新版本。发现可用的升级后,你可以使用你的代码进行试用,以决定是否升级到新版本。

有关go list命令的更多信息,请参阅go list -m

这里有几个例子。

  • 列出当前模块依赖的所有模块,以及每个模块可用的最新版本:$ go list -m -u all
  • 显示特定模块最新可用的版本:$ go list -m -u example.com/theirmodule

升级或降级一个依赖项

你可以通过使用Go工具发现可用版本来升级或降级依赖的模块,然后将不同的版本添加为依赖项。

1 要发现新版本,请使用go list命令,如发现可用更新小节所述。

2 要将特定版本添加为依赖项,请使用获取一个指定版本的依赖项小节所述的go get命令。

同步你代码的依赖项

你可以管理所有导入的包对应的依赖项,同时删除不再使用的依赖项。

当你一直在更改代码和依赖项时,这可能很有用,可能会创建一个你管理的依赖项和下载模块的集合,这些模块不再与代码中导入的包依赖的模块集合相匹配。

要保持依赖项集合整洁,请使用go mod tidy命令。对于代码中导入的包集,此命令编辑你的go.mod文件以添加必需但缺少的模块。它还会删除不提供任何相关包的未使用的模块。

该命令除了一个标志-v外没有其他参数,它打印有关已删除模块的信息。

$ go mod tidy

开发和测试未发布的模块的代码

你可以指定你的代码使用可能还未发布的依赖项模块。这些模块的代码可能在它们各自的存储库中,在这些存储库的分支中,或者在当前依赖它们的模块所在的本地硬盘里。

你可能希望在以下情况下执行此操作:

  • 你想对外部模块的代码进行自己的更改,例如在分叉和/或克隆它之后。例如,你可能想要修复该模块,然后将其作为一个拉取请求(pull request)发送给模块的开发人员。
  • 你正在构建一个新模块并且尚未发布它,因此go get命令访问不到它所在的存储库。

需求本地目录中的某个模块的代码

你可以指定所需模块的代码与依赖它的代码位于同一本地硬盘里。当你处于以下情况时,你可能会发现这很有用:

  • 开发自己的独立模块并希望使用当前模块进行测试。
  • 修复外部模块中的问题或向外部模块添加功能,并希望使用当前模块进行测试。(请注意,你还可以从你自己的存储库分支中获取外部模块。有关更多信息,请参阅下文的需求来自你自己的代码仓库分支的外部模块代码。)

要让Go命令使用模块代码的本地副本,请在go.mod文件中使用replace指令替换require指令中给出的模块路径。有关指令的更多信息,请参阅go.mod参考手册

在下面的go.mod文件示例中,当前模块依赖外部模块example.com/theirmodule,使用不存在的版本号(v0.0.0-unpublished)来确保替换正常工作。replace指令然后用../theirmodule替换原始模块路径,该目录与当前模块目录处于同一级别。

module example.com/mymodule

go 1.16

require example.com/theirmodule v0.0.0-unpublished

replace example.com/theirmodule v0.0.0-unpublished => ../theirmodule

设置require/replace对时,使用go mod editgo get命令确保文件描述的依赖项保持一致:

$ go mod edit -replace=example.com/[email protected]=../theirmodule
$ go get example.com/[email protected]

注意:当你使用replace指令时,Go工具不会验证外部模块,如添加一个依赖项小节所述。

有关版本号的更多信息,请参阅模块版本编号

需求来自你自己的代码仓库分支的外部模块的代码

当你fork一个外部模块的代码仓库时(例如修复模块代码中的问题或添加新功能),你可以让Go工具使用你fork的代码作为模块的源代码。这对于测试你自己的代码的更改很有用。(请注意,你还可以在本地硬盘目录中需求模块代码。有关更多信息,请参阅需求本地目录中的某个模块的代码小节。)

为此,你可以在go.mod文件中使用replace指令,将外部模块的原始模块路径替换为你fork的代码仓库的路径。这会指示Go工具在编译时使用替换路径(fork的代码仓库的路径),同时允许你保持你代码里的import语句里的原始模块路径保持不变。

有关replace指令的更多信息,请参阅go.mod文件参考手册

在下面的go.mod文件示例中,当前模块需求外部模块example.com/theirmodule。然后replace指令使用example.com/myfork/theirmodule替换原始模块路径,这是模块代码仓库的你的一个分支。

module example.com/mymodule

go 1.16

require example.com/theirmodule v1.2.3

replace example.com/theirmodule v1.2.3 => example.com/myfork/theirmodule v1.2.3-fixed

设置require/replace对时,最好使用Go工具命令,以确保与go.mod文件中描述的需求保持一致。使用go list命令查看当前使用的模块的版本。然后使用go mod edit命令用fork的分支替换所需的模块:

$ go list -m example.com/theirmodule
example.com/theirmodule v1.2.3
$ go mod edit -replace=example.com/[email protected]=example.com/myfork/[email protected]

注意:当你使用replace指令时,Go工具不会对外部模块进行身份验证,如添加一个依赖项小节中所述。

有关版本号的更多信息,请参阅模块版本编号

使用代码仓库标识符获取特定的某个提交(commit)

你可以使用go get命令从某个模块的代码仓库中,提取指定某个commit里的未发布(译者注:未加版本号标签)的代码。

为此,你可以使用go get命令,并使用@符号指定你想要的代码。当你使用go get时,该命令将向你的go.mod文件添加一个需求外部模块的require指令,使用基于commit的详细信息的伪版本号。

以下示例提供了一些说明。这些基于一个模块,其源代码位于git存储库中。

  • 要提取指定某个commit里的模块代码,请附加@commithash(译者注:@commit的哈希值)形式:$ go get example.com/theirmodule@4cf76c2
  • 要提取指定某个分支里的模块代码,请附加@branchname(译者注:@分支名称)形式:$ go get example.com/theirmodule@bugfixes

移除一个依赖项

当你的代码不再使用某个模块中的任何包时,你可以停止将该模块作为依赖项进行追踪。

要停止追踪所有未使用的模块,请运行go mod tidy命令。此命令还可以在构建模块的包时添加所需的缺失依赖项。

$ go mod tidy

要删除特定依赖项,请使用go get命令,指定该模块的模块路径并附加@none,如下例所示:

$ go get example.com/theirmodule@none

go get命令还将降级或删除依赖于已删除模块的其他依赖项。

指定一个模块代理服务器

当你使用Go工具处理模块时,这些工具默认从proxy.golang.org(Google运营的公共模块镜像)或直接从模块的代码仓库下载模块。你可以指定Go工具使用另一个代理服务器来下载和验证模块。例如,一些人设置了一个自己的模块代理服务器,以便更好地控制依赖项的使用方式。

要指定另外的模块代理服务器供Go工具使用,请将GOPROXY环境变量设置为一个或多个另外的模块代理服务器的URL。Go工具将按照你指定的顺序尝试每个URL。默认情况下,GOPROXY首先指定一个Google运营的公共的模块代理,然后直接从模块的存储库中下载模块代码(由其模块路径指出):

GOPROXY="https://proxy.golang.org,direct"

有关GOPROXY环境变量(包括其值支持的他行为)的详细信息,请参阅go命令参考手册

你可以将变量设置为其他模块代理服务器的URL,用逗号或管道分隔多个URL。

  • 当你使用逗号时,只有当前URL返回HTTP 404或410时,Go工具才会尝试列表中的下一个URL。GOPROXY="https://proxy.example.com,https://proxy2.example.com"
  • 当你使用管道时,Go工具将尝试列表中的下一个URL,而不考虑HTTP错误代码。GOPROXY="https://proxy.example.com|https://proxy2.example.com"

Go模块经常在版本控制服务器和模块代理上开发和分发,有些服务器和代理在公共互联网上不可用。此时你可以设置GOPRIVATE环境变量来配置go命令,以便从私有源下载和构建模块。

GOPRIVATEGONOPROXY环境变量可以设置为与模块前缀匹配的全局模式列表,与这些模式匹配的模块是私有的,不应该从中代理任何请求。例如:

GOPRIVATE=*.corp.example.com,*.research.example.com

管理模块的源代码

本文翻译自《Managing module source》。

目录

Go工具如何查找你发布的模块

在存储库中组织代码

选择存储库的范围

一个存储库管理一个模块的源代码

一个存储库管理多个模块的源代码

当你开发要发布以供其他人使用的模块时,你可以通过遵循本篇文章中描述的存储库规约来确保其他开发人员更容易地使用你的模块。

本文描述了你在管理模块存储库时可能采取的操作。有关在版本之间进行修订时你将采取的工作流程步骤顺序的信息,请参阅模块发布和版本控制工作流程

此处描述的一些规约在模块中是必需的,而另一些则是最佳实践。本内容假设你熟悉管理依赖项中描述的基本模块使用实践。

Go支持以下用于发布模块的存储库:Git、Subversion、Mercurial、Bazaar和Fossil。

有关模块开发的概述,请参阅开发和发布模块

Go工具如何找到你发布的模块

在Go发布模块和获取代码的分布式系统中,你可以将代码保留在存储库中的同时发布模块。Go工具依赖于存储库路径和存储库标签的命名规则,它们指示模块的名称和版本号。当你的存储库符合这些要求时,你的模块代码可以通过Go工具(例如go get命令)从存储库下载。

当开发人员使用go get命令为其代码导入的包获取源代码时,该命令执行以下操作:

1 go get在Go源代码中的import语句的包路径中识别模块路径。

2 使用从模块路径派生的URL,该命令在模块代理服务器上或直接在其存储库中定位模块源代码。

3 通过将模块的版本号与存储库标签匹配来查找要下载的模块版本的源代码,以发现存储库中的代码。当尚不知道要使用的版本号时,go get将查找最新版本。

4 检索模块源代码并将其下载到开发人员的本地模块缓存。

在存储库中组织代码

通过遵循此处描述的规约,你可以保持简单的维护并改善开发人员对你的模块的使用体验。将模块代码放入存储库通常与使用其他代码一样简单。

下图说明了具有两个包的简单模块的源代码层次结构。

你的首次提交应包括下表中列出的文件:

文件描述
LICENSE模块的许可证。
go.mod描述模块,包括它的模块路径(实际上就是它的名称)和它的依赖关系。有关更多信息,请参阅go.mod参考
模块路径将在module指令中给出,例如:
module example.com/mymodule
有关选择模块路径的更多信息,请参阅管理依赖项
虽然你可以编辑go.mod文件,但你会发现通过go命令进行更改更可靠。
go.sum包含表示模块依赖项的加密哈希值。Go工具使用这些哈希值来验证下载的模块,试图确认下载的模块是可信的。如果此确认失败,Go将显示一个安全性错误。
当没有依赖项时,该文件将为空或不存在。你不应该编辑此文件,除非使用go mod tidy命令删除不需要的条目。
包目录和.go源代码文件目录构成模块中的包,.go文件就是源代码文件。

你可以在命令行创建一个空的存储库,添加将成为首次提交的一部分的文件,并在提交时添加注释。下面是一个使用git的例子:

$ git init
$ git add --all
$ git commit -m "mycode: initial commit"
$ git push

选择存储库的范围

当代码应该独立于其他模块中的代码进行版本控制时,你在模块中发布该代码。

将存储库设计为在其根目录中托管单个模块将有助于简化维护,尤其是随着时间的推移,当你发布新的次版本和补丁版本、创建新的主版本分支等时候。但是,如果你的其他模块的代码依赖它,你可以改为在单个存储库中维护一组模块。

一个存储库管理一个模块的源代码

你可以维护一个包含单个模块源代码的存储库。在此模型中,你将go.mod文件放在存储库的根目录里,存储库的根目录里还有包子目录,包子目录里有Go源代码文件。

这是最简单的方法,随着时间的推移,你的模块可能更易于管理。它可以帮助你避免在模块目录名上附加版本号。

一个存储库管理多个模块的源代码

你可以用单个存储库发布多个模块。例如,你可能在一个存储库中包含多个模块的源代码,但希望分别对这些模块进行版本控制。

作为模块根目录的每个子目录都必须有自己的go.mod文件。

当发布一个模块时,在子目录中管理模块源代码需要更改版本标签的形式。你必须在标签版本号前面加上对应的模块根目录下的子目录的名称。有关版本号的更多信息,请参阅模块版本编号

例如,对于下面的模块example.com/mymodules/module1的v1.2.3版本,你将拥有以下内容:

  • 模块路径:example.com/mymodules/module1
  • 版本标签:module1/v1.2.3
  • 用户导入的包路径:example.com/mymodules/module1/package1
  • 用户require指令中的模块路径:example.com/mymodules/module1 module1/v1.2.3

发布一个模块

本文翻译自《Publishing a module》。

当你想让一个模块可供其他开发人员使用时,你可以发布它,以便Go工具可以看到它。发布模块后,导入其包的开发人员将能够通过运行go get等命令来解析对模块的依赖关系。

注意:发布后不要更改模块的已加标签的版本。对于使用该模块的开发人员,Go工具会根据第一个下载的副本对下载的模块进行身份验证。如果两者不同,Go工具将返回安全错误。不要更改以前发布版本的代码,而是发布一个新版本。

另请参阅

发布步骤

使用以下步骤发布模块。

1 打开命令提示符并切换到本地存储库中的模块的根目录。

2 运行go mod tidy,它会删除模块可能积累的任何不再需要的依赖项。

$ go mod tidy

3 最后一次运行go test ./...以确保一切正常。

这会运行你使用Go测试框架编写的单元测试。

$ go test ./...
ok      example.com/mymodule       0.015s

4 使用git tag命令给项目打新版本号标签。

对于版本号,请使用一个向用户表明此版本中更改性质的数字。有关更多信息,请参阅模块版本编号

$ git commit -m "mymodule: changes for v0.1.0"
$ git tag v0.1.0

5 将新标签推送到源存储库。

$ git push origin v0.1.0

6 通过运行go list命令使模块可用,以提示Go使用有关你正在发布的模块的信息更新其模块索引。

在命令前面加上将GOPROXY环境变量设置为Go代理的语句。这将确保你的请求到达代理。

$ GOPROXY=proxy.golang.org go list -m example.com/[email protected]

对你的模块感兴趣的开发人员从中导入一个包并运行go get命令,就像他们对任何其他模块一样。他们可以针对最新版本运行go get命令,也可以指定特定版本,如下例所示:

$ go get example.com/[email protected]

开发一个主版本更新

本文翻译自《Developing a major version update》。

目录

主版本更新的注意事项

为主版本的发布创建分支

当你在潜在的新版本中所做的更改不能保证模块用户的向后兼容性时,你必须把这些更改更新到主版本。例如,如果你更改模块的公开API会破坏使用该模块以前版本的客户端代码,你就应该通过开发一个新的主版本来实现这种更改。

注意:每个版本类型——主版本、次版本、补丁版本或预发布版本——对模块的用户来说都有不同的含义。这些用户依靠这些差异来了解版本对他们自己的代码所代表的风险级别。换句话说,在准备发布时,请确保其版本号准确地反映了自上一版本以来的更改的性质。有关版本号的更多信息,请参阅模块版本编号

另请参阅

主版本更新的注意事项

仅在绝对必要时才更新到新的主版本。因为主版本更新对你和你模块的用户来说都意味着重大的变化。当你考虑进行主版本更新时,请考虑以下事项:

  • 发布新的主版本对你以前的主版本的维护意味着什么,你需要向你的用户明确这一点。以前的版本是否已弃用?还是像以前一样支持?你会维护以前的版本,包括Bug修复吗?
  • 准备好维护两个版本:旧版本和新版本。例如,如果你修复了一个Bug,你通常会将这些修复移植到另一个中。
  • 请记住,从依赖管理的角度来看,新的主版本是一个新模块。在你发布新的主版本后,你的用户将需要更新以使用新模块,而不是简单地升级。这是因为新的主版本与之前的主版本具有不同的模块路径。例如,对于模块路径为example.com/mymodule的模块,v2版本将具有模块路径example.com/mymodule/v2。
  • 当你开发新的主版本时,你还必须在导入新模块里的包的那些代码里,修改导入路径。如果你的模块的用户想要升级到新的主版本,他们也必须更改他们的导入路径。

为主版本的发布创建分支

在准备开发新的主版本时,最直接的处理源代码的方式是从存储库创建先前主版本的最新版本的分支。

例如,在命令提示符下,你可以cd到模块的根目录,然后在那里创建一个新的v2分支。

$ cd mymodule
$ git checkout -b v2
Switched to a new branch "v2"

创建源代码的分支后,需要对新版本的源代码进行以下更改:

  • 在新版本的go.mod文件中,将新的主版本号附加到模块路径,如下例所示:

现有版本:example.com/mymodule

新版本:example.com/mymodule/v2

  • 在Go代码中,更新从该模块导入包的每个导入路径,将主版本号附加到模块路径部分。

旧的导入语句:import“example.com/mymodule/package1”

新的导入语句:import“example.com/mymodule/v2/package1”

有关发布步骤,请参见发布一个模块

模块发布和版本控制工作流程

本文翻译自《Module release and versioning workflow》。

目录

常见的工作流程步骤

针对未发布的模块进行编程

发布预发布(pre-release)版本

发布第一个(不稳定的)版本

发布第一个稳定版本

发布Bug修复

发布不破坏API的更改

发布破坏API的更改

当你开发供其他开发人员使用的模块时,你可以遵循有助于使用该模块的开发人员获得可靠、一致的体验的工作流程。本主题描述了该工作流程中的高级步骤。

有关模块开发的概述,请参阅开发和发布模块

也请参阅

  • 如果你只想在代码中使用外部包,请务必查看管理依赖项
  • 对于每个新版本,你都用其版本号表示对模块的更改。有关更多信息,请参阅模块版本编号

常见的工作流程步骤

以下序列说明了一个新模块的发布和版本控制的工作流程步骤。有关每个步骤的更多信息,请参阅本主题中的各个章节。

1 开始一个模块并组织它的源代码,使开发人员更容易使用,使你更容易维护。

如果你是开发模块的新手,请查看教程:创建Go模块

在Go的去中心化模块发布系统中,如何组织代码很重要。有关更多信息,请参阅管理模块源代码

2 开始编写调用未发布模块中的函数的本地客户端代码

在发布模块之前,它不能用于使用go get等命令的典型的依赖管理工作流程。在此阶段测试模块代码的一个好方法是,在本地目录中调用并测试它的代码。

有关本地开发的更多信息,请参阅下文的针对未发布的模块进行编程小节。

3 当模块的代码准备好供其他开发人员试用时,你可以开始发布alphas和beta等v0预发布版。有关详细信息,请参见下文的发布预发布(pre-release)版本小节。

4 发布一个v0版本,不保证稳定,但用户可以试用。有关详细信息,请参见下文的发布第一个(不稳定的)版本小节。

5 发布v0版本后,你可以(而且应该!)继续发布它的新版本

这些新版本可能包括bug修复(补丁版本)、对模块公开API的添加(次要版本),甚至是破坏性的更改。因为v0版本不保证稳定性或向后兼容性,所以你可以对其版本进行重大更改。

有关详细信息,请参见下文的发布Bug修复小节和发布不破坏API的更改小节。

6 当你准备好发布稳定版本时,你可以将预发布版本发布为alphas版本或beta版本。有关详细信息,请参见下文的发布预发布(pre-release)版本小节。

7 发布v1作为第一个稳定版本

这是第一个对模块稳定性做出承诺的版本。有关详细信息,请参见下文的发布第一个稳定版本小节。

8 在v1版本中,继续修复bug,并在必要时添加模块的公共API。

有关详细信息,请参见下文的发布Bug修复小节和发布不破坏API的更改小节。

9 当无法避免时,在一个新的主版本中发布破坏性的更改。

主版本更新——例如从v1.x.x到v2.x.x——对于模块的用户来说可能是一个非常具有破坏性的升级。这应该是最后的手段。有关更多信息,请参阅下文的发布破坏API的更改小节。

针对未发布的模块进行编程

当你开始开发模块或模块的新版本时,你还没有发布它。在发布模块之前,你将无法使用Go命令将该模块添加为依赖项。相反,当你在另一个模块中编写调用这个未发布模块的函数的客户端代码时,你首先需要在本地文件系统里引用该模块的副本。

你可以使用客户端模块的go.mod文件中的replace指令从本地引用该模块。有关更多信息,请参阅在本地目录中需求模块代码

发布预发布(pre-release)版本

你可以发布预发布版本,使模块可供其他人试用并向你提供反馈。预发布版本不保证稳定性。

预发布版本号后附有预发布标识符。有关版本号的更多信息,请参见模块版本号

以下是两个例子:

v0.2.1-beta.1
v1.2.3-alpha

在提供预发布版本时,请记住,使用预发布版本的开发人员需要使用go get命令按版本号明确指出它。这是因为,在默认情况下,go命令在定位你需求的模块时更喜欢正式的发布版本而不是预发布版本。因此,开发人员必须通过显式地指出来获得预发布版本,如下例所示:

go get example.com/[email protected]

你可以通过给存储库中的模块代码加标签来发布预发布版本,并在标签中指定预发布标识符。有关更多信息,请参阅发布模块

发布第一个(不稳定的)版本

当你发布预发布版本时,你可以发布不保证稳定性或向后兼容性的发布版本,但给你的用户一个试用该模块并向你提供反馈的机会。

不稳定版本是指版本号在v0.x.x范围内的版本。v0版本不保证稳定性或向后兼容性。但它为你提供了一种方法,可以在使用v1和更高版本做出稳定性承诺之前获得反馈并改进你的API。有关更多信息,请参见模块版本编号

与其他已发布版本一样,你可以在发布稳定的v1版本之前进行更改代码时增加v0版本号的次版本号和补丁版本号部分。例如,在发布v.0.0.0版本之后,你可能会发布带有第一组Bug修复的v0.0.1版本。 这是一个示例版本号:

v0.1.3

你可以通过给存储库中的模块代码加标签来发布不稳定版本,并在标签中指定v0版本号。有关更多信息,请参阅发布模块

发布第一个稳定版本

你的第一个稳定版本将具有v1.x.x版本号。第一个稳定版本是在预发布版本和v0版本之后发布的,你可以通过它们获得反馈、修复Bug并为用户稳定模块。

在v1版本中,你向使用你的模块的开发人员做出以下承诺:

  • 他们可以升级到主版本号后续的次版本和补丁版本,而不会破坏自己的代码。
  • 你不会对模块的公共API进行进一步的更改——包括它的函数和方法签名——这会破坏向后兼容性。
  • 你不会删除任何导出的类型,因为这会破坏向后兼容性。
  • 未来对API的更改(例如向结构体添加新字段)将向后兼容,并将包含在新的次版本中。
  • Bug修复(例如安全修复)将包含在补丁版本中或作为次版本的一部分。

注意:虽然你的第一个主版本可能是v0版本,但v0版本并没有稳定性或向后兼容性保证。因此,当你从v0升级到v1时,你无需注意破坏向后兼容性,因为v0版本被认为是不稳定的。

有关版本号的更多信息,请参阅模块版本编号。 下面是一个稳定版本号的例子:

v1.0.0

你通过给存储库中的模块代码加标签来发布第一个稳定版本,并在标签中指定v1版本号。有关更多信息,请参阅发布模块

发布Bug修复

你可以发布一个版本,其中的更改仅限于Bug修复。这称为补丁版本。

补丁版本仅包含较小的更改。特别是,它没有对模块的公开API进行任何更改。使用代码的开发人员可以安全地升级到这个版本,而无需更改他们的代码。

注意:你的补丁版本应该尽量不要将任何该模块自己的依赖项升级超过补丁版本。否则,升级到该模块补丁版本的人可能会意外地对他们使用的间接依赖项进行更具侵入性的更改。

补丁版本会增加模块版本号的补丁部分。有关更多信息,请参阅模块版本编号

在以下示例中,v1.0.1是一个补丁版本。

旧版本:v1.0.0

新版本:v1.1.0

你可以通过给存储库中的模块代码加标签来发布次要版本,增加标签中的次要版本号。有关更多信息,请参阅发布模块

发布破坏API的更改

你可以通过发布(major)版本来发布破坏向后兼容的版本。

主版本不保证向后兼容性,通常是因为它包含对模块公开API的更改,这些更改会破坏调用模块先前版本的代码。

考虑到主版本升级可能对依赖于模块的代码产生的破坏性影响,如果可以的话,你应该避免主版本更新。有关主版本更新的更多信息,请参阅开发主版本更新。有关避免进行破坏性更改的策略,请参阅博客文章保持模块兼容

如果发布其他类型的版本需要使用版本号来给模块代码加标签,那么发布主版本更新需要更多的步骤。

1 在开始开发新的主版本之前,在你的存储库中为新版本的源代码创建一个位置。

一种方法是在存储库中创建一个新的分支,专门用于新的主版本及其后续的次版本和补丁版本。有关更多信息,请参见管理模块源代码。 2 在模块的go.mod文件中,修改模块路径以附加新的主版本号,如下例所示:

example.com/mymodule/v2

既然模块路径是模块的标识,此更改有效地创建了一个新模块。它还更改了包路径,确保开发人员不会无意中导入破坏其代码的版本。相反,那些想要升级的用户将显式地用新路径替换旧路径。

3 在你的代码中,更改你正在更新的模块里的任何包的导入路径,包括你正在更新的模块里的包。你需要这样做,因为你更改了模块路径。

4 与任何新版本一样,在发布正式版本之前,你应该发布预发布版本以获得反馈和Bug报告。

5 通过在存储库中给模块代码加标签,增加标签中的主版本号(例如从v1.5.2到v2.0.0),发布新的主版本。

有关详细信息,请参见发布一个模块

教程:多模块工作空间入门

本文翻译自《Tutorial: Getting started with multi-module workspaces》。

目录

先决条件

为代码创建模块

创建工作空间

下载并修改golang.org/x/example模块

了解有关工作空间的详细信息

本教程介绍Go中多模块工作空间的基础知识。使用多模块工作空间,你可以告诉Go命令,你正在同时在多个模块中编写代码,并且可以轻松地在这些模块中构建和运行代码。

在本教程中,你将在共享的多模块工作空间中创建两个模块,对这些模块进行更改,并在一个构建中查看这些更改的结果。

注意:有关其他教程,请参见教程

先决条件

  • 安装Go 1.18或更高版本。
  • 编辑代码的工具。任何文本编辑器都可以正常工作。
  • 命令行终端。Go在Linux和Mac上的任何终端以及Windows中的PowerShell或cmd上都能很好地工作。

本教程需要go1.18或更高版本。确保你已经使用Go.dev/dl上的链接安装了Go 1.18或更高版本。

为你的代码创建一个模块

首先,为你要编写的代码创建一个模块。

1 打开命令提示符并切换到你的家目录。 在Linux或Mac上:

$ cd ~

在Windows上:

C:\> cd %HOMEPATH%

(译者注:或者执行C:\> cd %USERPROFILE%

本教程的其余部分将显示$作为提示符。你使用的命令也可以在Windows上使用。

2 在命令提示符下,为代码创建一个名为workspace的目录。

$ mkdir workspace
$ cd workspace

3 初始化模块

我们的示例将创建一个依赖于golang.org/x/example的新模块hello

创建hello模块:

$ mkdir hello
$ cd hello
$ go mod init example.com/hello
go: creating new go.mod: module example.com/hello

使用go get添加golang.org/x/example依赖项。

$ go get golang.org/x/example

在hello目录中创建hello.go,并输入以下内容:

package main

import (
    "fmt"

    "golang.org/x/example/stringutil"
)

func main() {
    fmt.Println(stringutil.Reverse("Hello"))
}

现在,运行hello程序:

$ go run example.com/hello
olleH

创建工作空间

在这一步中,我们将创建一个go.work文件来指定带有模块的工作空间。

初始化工作空间

workspace目录中,运行:

$ go work init ./hello

go work init命令告诉go为包含./hello目录中的模块的工作空间创建一个go.work文件。

go命令生成一个如下所示的go.work文件:

go 1.18

use ./hello

go.work文件的语法与go.mod相似。

go指令告诉Go应该使用哪个版本的Go来解释Go文件。它类似于go.mod文件中的go指令。

use指令告诉Go在构建时hello目录中的模块应该是主(main)模块。

因此,在workspace的任何子目录中,该模块都将处于活动状态。

运行workspace目录下的程序

在workspace目录中,运行:

$ go run example.com/hello
olleH

Go命令把包含在工作空间中的所有模块作为主模块。这允许我们引用一个模块中的包,甚至模块外的包。在模块或工作空间之外运行go run命令会导致错误,因为go命令不知道要使用哪些模块。

接下来,我们将golang.org/x/example模块的本地副本添加到工作空间。然后,我们将向stringutil包添加一个新函数,我们可以使用它来代替Reverse

下载并修改golang.org/x/example模块

在这一步中,我们将下载包含golang.org/x/example模块的Git存储库的副本,将其添加到工作空间,然后向其中添加一个我们将在hello程序中使用的新函数。

1 克隆存储库 在workspace目录中,运行git命令来克隆存储库:

$ git clone https://go.googlesource.com/example
Cloning into 'example'...
remote: Total 165 (delta 27), reused 165 (delta 27)
Receiving objects: 100% (165/165), 434.18 KiB | 1022.00 KiB/s, done.
Resolving deltas: 100% (27/27), done.

2 将模块添加到工作空间

$ go work use ./example

go work use命令将一个新模块添加到go.work文件中。它现在看起来像这样:

go 1.18

use (
    ./hello
    ./example
)

该模块现在包括example.com/hello模块和golang.org/x/example模块。

这将允许我们使用我们将在stringutil模块的副本中编写的新代码,而不是使用go get命令下载的模块缓存中的该模块版本。(译者注:这说明go.work文件中use的模块被使用的优先级高于本地模块缓存中和网络上的同名模块。)

3 添加新函数

我们将在golang.org/x/example/stringutil包中添加一个将字符串大写的新函数。

workspace/example/stringutil目录中创建一个名为toupper.go的新文件,其中包含以下内容:

package stringutil

import "unicode"

// ToUpper把参数字符串s里的所有rune字符变为大写
func ToUpper(s string) string {
    r := []rune(s)
    for i := range r {
        r[i] = unicode.ToUpper(r[i])
    }
    return string(r)
}

4 修改hello程序以使用该函数

修改workspace/hello/hello.go的内容,包含以下内容:

package main

import (
    "fmt"

    "golang.org/x/example/stringutil"
)

func main() {
    fmt.Println(stringutil.ToUpper("Hello"))
}

运行工作空间里的代码

在workspace目录里,运行

$ go run example.com/hello
HELLO

Go命令找到在命令行上给出的,由go.work文件指定的,在hello目录中的example.com/hello模块。并类似地解析由go.work文件导入的golang.org/x/example模块。

可以使用go.work来代替添加replace指令跨多个模块工作。

由于这两个模块位于同一个工作空间中,因此很容易在一个模块中进行更改并在另一个模块中使用它。

更进一步

现在,要正确发布这些模块,我们需要发布golang.org/x/example模块,例如v0.1.0。 这通常是通过在模块的版本控制存储库里给提交(commit)加标签来完成的。

有关更多详细信息,请参阅模块发布工作流程文档。发布完成后,我们可以在hello/go.mod中增加对golang.org/x/example模块的需求:

cd hello
go get golang.org/x/[email protected]

这样,go命令就可以正确地解析工作空间之外的模块。

学习更多工作空间相关的知识

go命令除了我们之前在教程中见过的go work init之外,还有多个子命令用于处理工作空间:

  • go work use [-r] [dir]dir添加一个use指令到go.work文件,如果dir参数指定的目录存在的话,如果dir参数指定的目录不存在,该命令就会删除对应的use指令。dir的工作文件(如果存在),如果参数目录不存在,则删除use目录。-r标志递归地检查dir参数指定的目录的子目录。
  • go work edit编辑go.work文件,类似于go mod edit
  • go work sync将工作空间构建列表中的依赖项同步到每个工作空间模块中。

有关工作空间和go.work文件的详细信息,请参见《Go模块文档》中的工作空间(workspace)小节。

设置通过SSH秘钥与GitHub进行认证和通信

连接GitHub已有的代码仓库时,可以使用SSH秘钥(公私钥)进行认证。如何创建SSH秘钥并将其添加至GitHub,请参考GitHub的帮助文档https://docs.github.com/cn/authentication/connecting-to-github-with-ssh。

需要注意的步骤是:

  • 你需要在家目录里创建.ssh文件夹,把SSH私钥拷贝进去,公钥不用拷贝进去。公钥的内容需要粘贴到你的GitHub账户网站的设置里,请参考https://docs.github.com/cn/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account。
  • SSH私钥的文件名应该是id_rsa,因为id_rsa是git默认查找的私钥名字之一,否则就找不到私钥,会报错“[email protected]: Permission denied (publickey).”。如果你的SSH私钥的文件名不是id_rsa,那么应该改名为id_rsa。
  • 如果你使用的是Ubuntu等Linux操作系统,私钥文件不能有被其他人读写的权限:
chmod o-rwx ./id_rsa
chmod g-rwx ./id_rsa

完成设置后,就可以用家目录里的.ssh文件夹里的SSH私钥与GitHub进行认证和通信了。打开Git Bash,执行命令:

ssh -T [email protected]

如果输出以下信息:

Hi yourusername! You've successfully authenticated, but GitHub does not provide shell access.

说明通过SSH秘钥与GitHub进行认证和通信设置成功。

参考

https://docs.github.com/cn/authentication/connecting-to-github-with-ssh https://docs.github.com/en/authentication/troubleshooting-ssh/error-permission-denied-publickey

Go语言build等工具详解

Go语言自带一套完整的命令行工具,你可以通过在命令行中执go命令来查看它们:

Go is a tool for managing Go source code.
Go是一个管理Go源代码的工具。

Usage:
用法

	go <command> [arguments]
	go <命令> [参数]

The commands are:
命令如下:

	bug         start a bug report 开始报告一个bug
	build       compile packages and dependencies 编译包和依赖项
	clean       remove object files and cached files 删除目标文件和缓存文件
	doc         show documentation for package or symbol 显示包或符号的文档
	env         print Go environment information 打印Go环境信息
	fix         update packages to use new APIs 更新软件包以使用新的API
	fmt         gofmt (reformat) package sources gofmt(重新格式化)包源
	generate    generate Go files by processing source 通过处理源生成Go文件
	get         add dependencies to current module and install them 将依赖项添加到当前模块并安装它们
	install     compile and install packages and dependencies 编译和安装包和依赖项
	list        list packages or modules 列出包或模块
	mod         module maintenance 模块维护
	work        workspace maintenance 工作空间维护
	run         compile and run Go program 编译并运行Go程序
	test        test packages 测试软件包
	tool        run specified go tool 运行指定的go工具
	version     print Go version 打印Go版本号
	vet         report likely mistakes in packages 报告包中可能出现的错误

Use "go help <command>" for more information about a command.
使用“go help <命令>”获取有关命令的更多信息。

Additional help topics:
其他帮助主题:

	buildconstraint build constraints 构建约束
	buildmode       build modes 构建模式
	c               calling between Go and C Go和C之间的调用
	cache           build and test caching 构建和测试缓存
	environment     environment variables 环境变量
	filetype        file types 文件类型
	go.mod          the go.mod file go.mod文件
	gopath          GOPATH environment variable GOPATH环境变量
	gopath-get      legacy GOPATH go get 遗留的GOPATH模式的go get命令
	goproxy         module proxy protocol 模块代理协议
	importpath      import path syntax 导入路径的语法
	modules         modules, module versions, and more 模块、模块版本等
	module-get      module-aware go get 模块模式的go get命令
	module-auth     module authentication using go.sum 使用go.sum进行模块认证
	packages        package lists and patterns 软件包的清单和模式
	private         configuration for downloading non-public code 下载非公开代码的配置
	testflag        testing flags 测试标志
	testfunc        testing functions 测试函数
	vcs             controlling version control with GOVCS 使用GOVCS进行版本控制

Use "go help <topic>" for more information about that topic.
使用“go help <主题>”获取有关该主题的更多信息。

以上是Go 1.18版本的go命令的输出。

我们使用这些工具开发Go语言项目,因此有必要熟识和掌握这些工具的使用。

go help 查看指定命令或主题的帮助文档

使用go help <命令>go help <主题>查看这个命令或主题的帮助文档,例如使用go help build查看go build命令详细信息。

go bug开始报告一个bug

$ go help bug
usage: go bug
用法:go bug

Bug opens the default browser and starts a new bug report.
Bug打开默认浏览器并开始一个新的bug报告。
The report includes useful system information.
该报告包括有用的系统信息。

go build编译包和依赖项

$ go help build
usage: go build [-o output] [build flags] [packages]
用法:go build [-o output] [build flags] [packages]

Build compiles the packages named by the import paths,
along with their dependencies, but it does not install the results.
Build编译由导入路径命名的包以及它们的依赖项,但它不会安装结果。

If the arguments to build are a list of .go files from a single directory,
build treats them as a list of source files specifying a single package.
如果构建参数是来自单个目录的.go文件的列表,则构建将它们视为指定的单个包的源文件列表。

When compiling packages, build ignores files that end in '_test.go'.
编译包时,build会忽略以'_test.go'结尾的文件。

When compiling a single main package, build writes
the resulting executable to an output file named after
the first source file ('go build ed.go rx.go' writes 'ed' or 'ed.exe')
or the source code directory ('go build unix/sam' writes 'sam' or 'sam.exe').
The '.exe' suffix is added when writing a Windows executable.
编译单个main包时,build将生成的可执行文件写入以第一个源文件命名的输出文件('go build ed.go rx.go'写入'ed'或'ed.exe')或源代码目录('go build unix/sam'写入'sam'或'sam.exe')。编写Windows可执行文件时会添加“.exe”后缀。

When compiling multiple packages or a single non-main package,
build compiles the packages but discards the resulting object,
serving only as a check that the packages can be built.
当编译多个包或单个非main包时,build编译包但丢弃生成的对象,仅用作检查包是否可以构建。

The -o flag forces build to write the resulting executable or object
to the named output file or directory, instead of the default behavior described
in the last two paragraphs. If the named output is an existing directory or
ends with a slash or backslash, then any resulting executables
will be written to that directory.
-o 标志强制构建将生成的可执行文件或对象写入指定的输出文件或目录,而不是最后两段中描述的默认行为。如果命名的输出是现有目录或以斜杠或反斜杠结尾,则任何生成的可执行文件都将写入该目录。

The -i flag installs the packages that are dependencies of the target.
-i 标志安装作为目标依赖项的包。
The -i flag is deprecated. Compiled packages are cached automatically.
-i 标志已弃用。编译的包会被自动缓存。

The build flags are shared by the build, clean, get, install, list, run,
and test commands:
构建标志由build,clean,get,install,list,run和test命令共享:

	-a
force rebuilding of packages that are already up-to-date. 强制重建已经是最新版本的包。
	-n
		print the commands but do not run them.打印命令但不运行它们。
	-p n
		the number of programs, such as build commands or
		test binaries, that can be run in parallel.
		The default is GOMAXPROCS, normally the number of CPUs available.
可以并行运行的程序的数量,例如构建命令或测试二进制文件。默认值为GOMAXPROCS,通常是可用的CPU数量。
	-race
		enable data race detection.
		Supported only on linux/amd64, freebsd/amd64, darwin/amd64, darwin/arm64, windows/amd64,
		linux/ppc64le and linux/arm64 (only for 48-bit VMA).
启用数据竞争检测。
仅在linux/amd64、freebsd/amd64、darwin/amd64、darwin/arm64、windows/amd64、linux/ppc64le和linux/arm64操作系统和CPU架构上受支持(仅适用于48位VMA)。
	-msan
		enable interoperation with memory sanitizer.
		Supported only on linux/amd64, linux/arm64
		and only with Clang/LLVM as the host C compiler.
		On linux/arm64, pie build mode will be used.
启用与内存清理程序的互操作。
仅在linux/amd64、linux/arm64和Clang/LLVM作为主机C编译器时受支持。
在linux/arm64上,将使用pie构建模式。
	-asan
		enable interoperation with address sanitizer.
		Supported only on linux/arm64, linux/amd64.
启用与地址清理程序的互操作。
仅在linux/arm64、linux/amd64上受支持。
	-v
		print the names of packages as they are compiled. 在编译时打印包的名称。
	-work
		print the name of the temporary work directory and
		do not delete it when exiting.
打印临时工作目录的名称,并在退出时不要删除它。
	-x
		print the commands. 打印命令。

	-asmflags '[pattern=]arg list'
arguments to pass on each go tool asm invocation. 传递给每个go tool asm调用的参数。
	-buildmode mode
build mode to use. See 'go help buildmode' for more. 要使用的构建模式。 有关更多信息,请参阅“go help buildmode”。
	-buildvcs
		Whether to stamp binaries with version control information
		("true", "false", or "auto"). By default ("auto"), version control
		information is stamped into a binary if the main package, the main module
		containing it, and the current directory are all in the same repository.
		Use -buildvcs=false to always omit version control information, or
		-buildvcs=true to error out if version control information is available but
		cannot be included due to a missing tool or ambiguous directory structure.
是否使用版本控制信息(“true”、“false”或“auto”)标记二进制文件。默认情况下(“auto”),如果main包、包含它的主模块和当前目录都在同一个存储库中,则版本控制信息被标记为二进制文件。
使用-buildvcs=false始终忽略版本控制信息,或-buildvcs=true如果版本控制信息可用但由于缺少工具或不明确的目录结构而无法包含,则输出错误信息。
	-compiler name
		name of compiler to use, as in runtime.Compiler (gccgo or gc). 要使用的编译器的名称,即runtime.Compiler(gccgo或gc)。
	-gccgoflags '[pattern=]arg list'
arguments to pass on each gccgo compiler/linker invocation. 传递给每个gccgo编译器/链接器调用的参数。
	-gcflags '[pattern=]arg list'
arguments to pass on each go tool compile invocation. 传递给每个go工具编译调用的参数。
	-installsuffix suffix
		a suffix to use in the name of the package installation directory,
		in order to keep output separate from default builds.
		If using the -race flag, the install suffix is automatically set to race
		or, if set explicitly, has _race appended to it. Likewise for the -msan
		and -asan flags. Using a -buildmode option that requires non-default compile
		flags has a similar effect.
在包安装目录的名称中使用的后缀,以便将输出与默认构建分开。
如果使用-race标志,安装后缀会自动设置为race,或者,如果明确设置,则会附加_race。-msan和-asan标志也是如此。使用需要非默认编译标志的-buildmode选项具有类似的效果。
	-ldflags '[pattern=]arg list'
arguments to pass on each go tool link invocation. 传递给每个go工具链接调用的参数。
	-linkshared
		build code that will be linked against shared libraries previously
		created with -buildmode=shared.
构建代码将链接到以前使用-buildmode=shared创建的共享库。
	-mod mode
		module download mode to use: readonly, vendor, or mod.
		By default, if a vendor directory is present and the go version in go.mod
		is 1.14 or higher, the go command acts as if -mod=vendor were set.
		Otherwise, the go command acts as if -mod=readonly were set.
		See https://golang.org/ref/mod#build-commands for details.
要使用的模块下载模式:readonly、vendor或mod。
默认情况下,如果存在vendor目录并且go.mod中的go版本为1.14或更高版本,则go命令的行为就像设置了-mod=vendor一样。
否则,go命令的行为就像设置了-mod=readonly一样。
有关详细信息,请参阅https://golang.org/ref/mod#build-commands。
	-modcacherw
		leave newly-created directories in the module cache read-write
		instead of making them read-only.
将新创建的目录保留在模块缓存中可读写,而不是使它们只读。
	-modfile file
		in module aware mode, read (and possibly write) an alternate go.mod
		file instead of the one in the module root directory. A file named
		"go.mod" must still be present in order to determine the module root
		directory, but it is not accessed. When -modfile is specified, an
		alternate go.sum file is also used: its path is derived from the
		-modfile flag by trimming the ".mod" extension and appending ".sum".
在模块感知模式下,读取(并可能写入)另一个go.mod文件,而不是模块根目录中的那个go.mod文件。一个名为“go.mod”的文件必须仍然存在才能确定模块根目录,但它不会被访问。当指定-modfile时,还使用备用go.sum文件:它的路径是从-modfile标志通过剪去“.mod”扩展名并附加“.sum”扩展名而得出的。
	-overlay file
		read a JSON config file that provides an overlay for build operations.
		The file is a JSON struct with a single field, named 'Replace', that
		maps each disk file path (a string) to its backing file path, so that
		a build will run as if the disk file path exists with the contents
		given by the backing file paths, or as if the disk file path does not
		exist if its backing file path is empty. Support for the -overlay flag
		has some limitations: importantly, cgo files included from outside the
		include path must be in the same directory as the Go package they are
		included from, and overlays will not appear when binaries and tests are
		run through go run and go test respectively.
读取一个为构建操作提供覆盖的JSON配置文件。
该文件是一个JSON结构,具有一个名为“Replace”的字段,它将每个磁盘文件路径(一个字符串)映射到其后备文件路径,以便构建将运行,就好像磁盘文件路径存在,其路径内容由后备文件路径给出,或者如果其后备文件路径为空,则好像磁盘文件路径不存在。对-overlay标志的支持有一些限制:重要的是,从包含路径之外包含的cgo文件必须与包含它们的Go包位于同一目录中,并且通过go run和go test分别运行二进制文件和测试时不会使用覆盖文件。
	-pkgdir dir
		install and load all packages from dir instead of the usual locations.
		For example, when building with a non-standard configuration,
		use -pkgdir to keep generated packages in a separate location.
从dir而不是通常的位置安装和加载所有包。
例如,使用非标准的配置进行构建时,使用-pkgdir将生成的包保存在单独的位置。
	-tags tag,list
		a comma-separated list of build tags to consider satisfied during the
		build. For more information about build tags, see the description of
		build constraints in the documentation for the go/build package.
		(Earlier versions of Go used a space-separated list, and that form
		is deprecated but still recognized.)
在构建过程中使用的构建标签的逗号分隔列表。有关构建标签的更多信息,请参阅go/build包文档中的构建约束描述。
(早期版本的Go使用空格分隔的列表,这种形式已被弃用但仍可识别。)
	-trimpath
		remove all file system paths from the resulting executable.
		Instead of absolute file system paths, the recorded file names
		will begin either a module path@version (when using modules),
		or a plain import path (when using the standard library, or GOPATH).
从生成的可执行文件中删除所有文件系统路径。
记录的文件名不是绝对文件系统路径,而是以模块路径@版本号(使用模块时)或普通导入路径(使用标准库或GOPATH时)开头。
	-toolexec 'cmd args'
		a program to use to invoke toolchain programs like vet and asm.
		For example, instead of running asm, the go command will run
		'cmd args /path/to/asm <arguments for asm>'.
		The TOOLEXEC_IMPORTPATH environment variable will be set,
		matching 'go list -f {{.ImportPath}}' for the package being built.
一个用于调用vet和asm等工具链程序的程序。
例如,go命令不会运行asm,而是运行'cmd args /path/to/asm <arguments for asm>'。
将设置TOOLEXEC_IMPORTPATH环境变量,匹配正在构建的包的“go list -f {{.ImportPath}}”。
The -asmflags, -gccgoflags, -gcflags, and -ldflags flags accept a
space-separated list of arguments to pass to an underlying tool
during the build. To embed spaces in an element in the list, surround
it with either single or double quotes. The argument list may be
preceded by a package pattern and an equal sign, which restricts
the use of that argument list to the building of packages matching
that pattern (see 'go help packages' for a description of package
patterns). Without a pattern, the argument list applies only to the
packages named on the command line. The flags may be repeated
with different patterns in order to specify different arguments for
different sets of packages. If a package matches patterns given in
multiple flags, the latest match on the command line wins.
For example, 'go build -gcflags=-S fmt' prints the disassembly
only for package fmt, while 'go build -gcflags=all=-S fmt'
prints the disassembly for fmt and all its dependencies.
-asmflags、-gccgoflags、-gcflags和-ldflags标志接受以空格分隔的参数列表,以在构建期间传递给底层工具。要在列表中的元素中嵌入空格,请用单引号或双引号将其括起来。参数列表前面可能有一个包模式和一个等号,这限制了该参数列表的使用以构建与该模式匹配的包(有关包模式的描述,请参见“go help packages”)。如果没有模式,参数列表仅适用于命令行上给出名字的包。这些标志可以以不同的模式重复,以便为不同的包集指定不同的参数。如果一个包与多个标志中给出的模式匹配,则命令行上的最新匹配项获胜。
例如,'go build -gcflags=-S fmt'仅打印包fmt的反汇编,而'go build -gcflags=all=-S fmt'打印fmt及其所有依赖项的反汇编。

For more about specifying packages, see 'go help packages'.
For more about where packages and binaries are installed,
run 'go help gopath'.
For more about calling between Go and C/C++, run 'go help c'.
有关指定包的更多信息,请参阅“go help packages”。
有关软件包和二进制文件安装位置的更多信息,请运行“go help gopath”。
有关Go和C/C++之间调用的更多信息,请运行“go help c”。

Note: Build adheres to certain conventions such as those described
by 'go help gopath'. Not all projects can follow these conventions,
however. Installations that have their own conventions or that use
a separate software build system may choose to use lower-level
invocations such as 'go tool compile' and 'go tool link' to avoid
some of the overheads and design decisions of the build tool.
注意:构建遵循某些约定,例如“go help gopath”所描述的约定。然而,并非所有项目都遵循这些约定。有自己的约定或使用单独的软件构建系统的安装可以选择使用较低级别的调用,例如“go tool compile”和“go tool link”,以避免构建工具的一些开销和设计决策。

See also: go install, go get, go clean.
另请参阅:go install, go get, go clean。

go clean删除目标文件和缓存文件

$ go help clean
usage: go clean [clean flags] [build flags] [packages]
用法:go clean [clean flags] [build flags] [packages]

Clean removes object files from package source directories.
The go command builds most objects in a temporary directory,
so go clean is mainly concerned with object files left by other
tools or by manual invocations of go build.
Clean从包源目录中删除对象文件。
go命令在临时目录中构建大多数对象,因此go clean主要涉及其他工具或手动调用go build留下的对象文件。

If a package argument is given or the -i or -r flag is set,
clean removes the following files from each of the
source directories corresponding to the import paths:
如果给定包参数或设置了-i或-r标志,则clean会从与导入路径对应的每个源目录中删除以下文件:

	_obj/            old object directory, left from Makefiles 旧对象目录,遗留自Makefiles
	_test/           old test directory, left from Makefiles 旧的测试目录,遗留自Makefiles
	_testmain.go     old gotest file, left from Makefiles 旧的gotest文件,遗留自Makefiles
	test.out         old test log, left from Makefiles 旧的测试日志,遗留自Makefiles
	build.out        old test log, left from Makefiles 旧的测试日志,遗留自Makefiles
	*.[568ao]        object files, left from Makefiles 目标文件,遗留自Makefiles

	DIR(.exe)        from go build 来自go build
	DIR.test(.exe)   from go test -c 来自go test -c
	MAINFILE(.exe)   from go build MAINFILE.go 来自go build MAINFILE.go
	*.so             from SWIG 来自SWIG

In the list, DIR represents the final path element of the
directory, and MAINFILE is the base name of any Go source
file in the directory that is not included when building
the package.
在列表中,DIR表示目录的最终路径元素,而MAINFILE是该目录中构建包时未包含的任何Go源文件的基本名称。

The -i flag causes clean to remove the corresponding installed
archive or binary (what 'go install' would create).
-i标志让clean删除相应的已安装存档或二进制文件(这些是'go install' 会创建的)。

The -n flag causes clean to print the remove commands it would execute,
but not run them.
-n标志让clean打印它将执行的删除命令,但不运行它们。

The -r flag causes clean to be applied recursively to all the
dependencies of the packages named by the import paths.
-r标志让clean递归地应用于导入路径给出名字的包的所有依赖项。

The -x flag causes clean to print remove commands as it executes them.
-x标志让clean在执行删除命令时打印它们。

The -cache flag causes clean to remove the entire go build cache.
-cache标志让clean删除整个go build缓存。

The -testcache flag causes clean to expire all test results in the
go build cache.
-testcache标志会导致clean使go-build缓存中的所有测试结果过期。

The -modcache flag causes clean to remove the entire module
download cache, including unpacked source code of versioned
dependencies.
-modcache标志会让clean删除整个模块下载缓存,包括带版本号的依赖项的未解包的源代码。

The -fuzzcache flag causes clean to remove files stored in the Go build
cache for fuzz testing. The fuzzing engine caches files that expand
code coverage, so removing them may make fuzzing less effective until
new inputs are found that provide the same coverage. These files are
distinct from those stored in testdata directory; clean does not remove
those files.
-fuzzcache标志会导致clean删除Go构建缓存中存储的用于模糊测试的文件。模糊引擎缓存文件扩展代码覆盖率测试,因此在找到提供相同覆盖率的新输入之前,删除这些文件可能会降低模糊的有效性。这些文件不同于存储在testdata目录中的文件;clean不会删除这些文件。

For more about build flags, see 'go help build'.
有关构建标志的详细信息,请参阅“go help build”。

For more about specifying packages, see 'go help packages'.
有关指定包的详细信息,请参阅“go help packages”。

go doc显示包或符号(symbol)的文档

$ go help doc
usage: go doc [doc flags] [package|[package.]symbol[.methodOrField]]
用法:go doc [doc flags] [package|[package.]symbol[.methodOrField]]

Doc prints the documentation comments associated with the item identified by its
arguments (a package, const, func, type, var, method, or struct field)
followed by a one-line summary of each of the first-level items "under"
that item (package-level declarations for a package, methods for a type,
etc.).
Doc打印与其参数给出的条目相关的文档注释(包,常量,函数,类型,变量,方法或结构字段),然后是每个第一级条目(软件包的包级声明,类型的方法等)“下”的单行注释。

Doc accepts zero, one, or two arguments.
Doc接收0个,1个或2个参数。

Given no arguments, that is, when run as
如果没有给出参数,即执行

	go doc

it prints the package documentation for the package in the current directory.
If the package is a command (package main), the exported symbols of the package
are elided from the presentation unless the -cmd flag is provided.
它打印输出当前目录中的软件包的包文档。
如果当前目录中的软件包是命令(main包),则除非提供-cmd标志,否则包的导出符号将从演示中省略。

When run with one argument, the argument is treated as a Go-syntax-like
representation of the item to be documented. What the argument selects depends
on what is installed in GOROOT and GOPATH, as well as the form of the argument,
which is schematically one of these:
当使用一个参数运行时,该参数被视为要输出文档的条目的类似于Go语法的表示。参数选择的内容取决于GOROOT和GOPATH中安装的内容以及参数的形式,是以下形式之一:

	go doc <pkg>
	go doc <sym>[.<methodOrField>]
	go doc [<pkg>.]<sym>[.<methodOrField>]
	go doc [<pkg>.][<sym>.]<methodOrField>

The first item in this list matched by the argument is the one whose documentation
is printed. (See the examples below.) However, if the argument starts with a capital
letter it is assumed to identify a symbol or method in the current directory.
该参数匹配的此列表中的第一个条目是打印文档的内容。(请参见下面的示例。)但是,如果参数以大写字母开头,则假定该参数是当前目录中的符号或方法。

For packages, the order of scanning is determined lexically in breadth-first order.
That is, the package presented is the one that matches the search and is nearest
the root and lexically first at its level of the hierarchy. The GOROOT tree is
always scanned in its entirety before GOPATH.
对于包,扫描顺序在词法上以广度优先确定。
也就是说,呈现的包是与搜索匹配的包,并且在搜索的层次结构的级别上最接近树根,词法上的第一个匹配。GOROOT树总是在GOPATH树之前全部扫描。

If there is no package specified or matched, the package in the current
directory is selected, so "go doc Foo" shows the documentation for symbol Foo in
the current package.
如果没有指定或匹配的软件包,则选择当前目录中的软件包,因此“go doc Foo”显示了当前软件包中符号FOO的文档。

The package path must be either a qualified path or a proper suffix of a
path. The go tool's usual package mechanism does not apply: package path
elements like . and ... are not implemented by go doc.
包装路径必须是合格的路径或路径的适当后缀。GO工具的常用的包机制不适用:包装路径元素像.和...未由go doc实现。

When run with two arguments, the first is a package path (full path or suffix),
and the second is a symbol, or symbol with method or struct field:
当给出两个参数运行时,第一个是一个包路径(完整路径或后缀),第二个是一个符号或带有方法或结构字段的符号:

	go doc <pkg> <sym>[.<methodOrField>]

In all forms, when matching symbols, lower-case letters in the argument match
either case but upper-case letters match exactly. This means that there may be
multiple matches of a lower-case argument in a package if different symbols have
different cases. If this occurs, documentation for all matches is printed.
在所有形式中,当匹配符号时,参数中的小写字母匹配任何一种大小写,但大写字母进行精确匹配。这意味着,如果不同的符号具有不同的大小写,则包中可能存在多个小写参数的匹配项。如果发生这种情况,将打印所有匹配项的文档。

Examples:
示例:
	go doc
		Show documentation for current package. 显示当前包的文档。
	go doc Foo
		Show documentation for Foo in the current package.
		(Foo starts with a capital letter so it cannot match
		a package path.)
在当前包中显示Foo的文档。
(Foo以大写字母开头,因此无法匹配包路径。)
	go doc encoding/json
		Show documentation for the encoding/json package. 显示encoding/json包的文档。
	go doc json
		Shorthand for encoding/json. encoding/json的速记形式。
	go doc json.Number (or go doc json.number)
		Show documentation and method summary for json.Number. 显示json.Number的文档和方法摘要。
	go doc json.Number.Int64 (or go doc json.number.int64)
		Show documentation for json.Number's Int64 method. 显示json.Number的Int64方法的文档。
	go doc cmd/doc
		Show package docs for the doc command. 显示doc命令的包文档。
	go doc -cmd cmd/doc
		Show package docs and exported symbols within the doc command. 在doc命令中显示包文档和导出的符号。
	go doc template.new
		Show documentation for html/template's New function.
		(html/template is lexically before text/template)
		显示html/template的New函数的文档。
		(html/template在词法上先于text/template)
	go doc text/template.new # One argument 一个参数
		Show documentation for text/template's New function. 显示text/template的New函数的文档。
	go doc text/template new # Two arguments 两个参数
		Show documentation for text/template's New function. 显示text/template的New函数的文档。

	At least in the current tree, these invocations all print the
	documentation for json.Decoder's Decode method:
至少在当前树中,这些调用都打印了json.Decoder的Decode方法的文档:

	go doc json.Decoder.Decode
	go doc json.decoder.decode
	go doc json.decode
	cd go/src/encoding/json; go doc decode

Flags:
标志:
	-all
		Show all the documentation for the package. 显示包的所有文档。
	-c
		Respect case when matching symbols. 匹配时区分大小写。
	-cmd
		Treat a command (package main) like a regular package.
		Otherwise package main's exported symbols are hidden
		when showing the package's top-level documentation.
将命令(main包)视为常规包。
否则,当显示包的顶级文档时,main包的导出符号将被隐藏。
	-short
		One-line representation for each symbol. 每个符号一行显示。
	-src
		Show the full source code for the symbol. This will
		display the full Go source of its declaration and
		definition, such as a function definition (including
		the body), type declaration or enclosing const
		block. The output may therefore include unexported
		details.
显示符号的完整源代码。这将显示其声明和定义的完整Go源代码,例如函数定义(包括主体)、类型声明或封闭的const块。因此,输出可能包括没有导出的详细信息。
	-u
		Show documentation for unexported as well as exported
		symbols, methods, and fields.
		显示未导出和导出的符号、方法和字段的文档。

go env打印Go环境信息

$ go help env
usage: go env [-json] [-u] [-w] [var ...]
用法:go env [-json] [-u] [-w] [var ...]

Env prints Go environment information.
env打印输出Go环境信息。

By default env prints information as a shell script
(on Windows, a batch file). If one or more variable
names is given as arguments, env prints the value of
each named variable on its own line.
默认情况下,env作为shell脚本打印输出信息(在Windows上为批处理文件)。如果一个或多个变量名称作为参数给出,env将每个给出名字的变量的值在对应的行上打印输出。

The -json flag prints the environment in JSON format
instead of as a shell script.
-json标志以JSON格式而不是作为shell脚本打印环境。

The -u flag requires one or more arguments and unsets
the default setting for the named environment variables,
if one has been set with 'go env -w'.
-u标志需要一个或多个参数,并取消设置给出名字的环境变量的默认设置(如果已使用“go env -w”设置)。

The -w flag requires one or more arguments of the
form NAME=VALUE and changes the default settings
of the named environment variables to the given values.
-w标志需要一个或多个NAME=VALUE形式的参数,并将命名环境变量的默认设置更改为给定值。

For more about environment variables, see 'go help environment'.
有关环境变量的更多信息,请参阅“go help environment”。

go fix更新软件包以使用新的API

$ go help fix
usage: go fix [-fix list] [packages]
用法:go fix [-fix list] [packages]

Fix runs the Go fix command on the packages named by the import paths.
fix在由导入路径给出名字的包上运行Go的fix命令。

The -fix flag sets a comma-separated list of fixes to run.
The default is all known fixes.
(Its value is passed to 'go tool fix -r'.)
-fix标志设置以逗号分隔的要运行的修复列表。
默认是所有已知的修复。
(它的值被传递给'go tool fix -r'。)

For more about fix, see 'go doc cmd/fix'.
For more about specifying packages, see 'go help packages'.
有关修复的更多信息,请参阅“go doc cmd/fix”。
有关指定包的更多信息,请参阅“go help packages”。

To run fix with other options, run 'go tool fix'.
要使用其他选项运行修复,请运行“go tool fix”。

See also: go fmt, go vet.
另请参阅:go fmt,go vet。

go fmt重新格式化包源

$ go help fmt
usage: go fmt [-n] [-x] [packages]
用法:go fmt [-n] [-x] [packages]

Fmt runs the command 'gofmt -l -w' on the packages named
by the import paths. It prints the names of the files that are modified.
fmt在由导入路径给出名字的包上运行命令“gofmt -l -w”。它会打印输出被修改的文件的名称。

For more about gofmt, see 'go doc cmd/gofmt'.
For more about specifying packages, see 'go help packages'.
有关gofmt的更多信息,请参阅“go doc cmd/gofmt”。
有关指定包的更多信息,请参阅“go help packages”。

The -n flag prints commands that would be executed.
The -x flag prints commands as they are executed.
-n标志打印将要执行的命令。
-x标志在执行命令时打印命令。

The -mod flag's value sets which module download mode
to use: readonly or vendor. See 'go help modules' for more.
-mod标志的值设置要使用的模块下载模式:只读或vendor模式。有关更多信息,请参阅“go help modules”。

To run gofmt with specific options, run gofmt itself.
要使用特定选项运行gofmt,请运行gofmt本身。

See also: go fix, go vet.
另请参阅:go fix, go vet。

go generate通过处理源文件生成Go文件

$ go help generate
usage: go generate [-run regexp] [-n] [-v] [-x] [build flags] [file.go... | packages]
用法:go generate [-run regexp] [-n] [-v] [-x] [build flags] [file.go... | packages]

Generate runs commands described by directives within existing
files. Those commands can run any process but the intent is to
create or update Go source files.
generate运行现有文件中的指令描述的命令。这些命令可以运行任何进程,但目的是创建或更新Go源文件。

Go generate is never run automatically by go build, go test,
and so on. It must be run explicitly.
go generate永远不会被go build、go test等自动运行。它必须显式运行。

Go generate scans the file for directives, which are lines of
the form,
go generate扫描文件中的指令,这些指令是以下形式的行,

	//go:generate command argument... go:生成命令参数

(note: no leading spaces and no space in "//go") where command
is the generator to be run, corresponding to an executable file
that can be run locally. It must either be in the shell path
(gofmt), a fully qualified path (/usr/you/bin/mytool), or a
command alias, described below.
(注意:没有前导空格并且“//go”中也没有空格),其中command是要运行的生成器,对应于可以在本地运行的可执行文件。它必须位于shell路径(gofmt)、完全限定路径(/usr/you/bin/mytool)或命令别名中,如下所述。

Note that go generate does not parse the file, so lines that look
like directives in comments or multiline strings will be treated
as directives.
请注意,go generate不会解析文件,因此在注释或多行字符串中看起来像指令的行将被视为指令。

The arguments to the directive are space-separated tokens or
double-quoted strings passed to the generator as individual
arguments when it is run.
指令的参数是空格分隔的标记或双引号包起来的字符串,在运行时作为单个参数传递给生成器。

Quoted strings use Go syntax and are evaluated before execution; a
quoted string appears as a single argument to the generator.
引号包起来的字符串使用Go语法,并在执行前进行评估;引号包起来的字符串作为生成器的单个参数。

To convey to humans and machine tools that code is generated,
generated source should have a line that matches the following
regular expression (in Go syntax):
为了向人和机器传达生成的代码,生成的源代码应该有一行匹配以下正则表达式(在Go语法中):

	^// Code generated .* DO NOT EDIT\.$

This line must appear before the first non-comment, non-blank
text in the file.
此行必须出现在文件中第一个非注释、非空白文本之前。

Go generate sets several variables when it runs the generator:
Go generate在运行生成器时设置了几个变量:

	$GOARCH
		The execution architecture (arm, amd64, etc.) 执行环境的架构(arm、amd64 等。)
	$GOOS
		The execution operating system (linux, windows, etc.) 执行环境的操作系统(linux、windows等。)
	$GOFILE
		The base name of the file. 文件的基本名称。
	$GOLINE
		The line number of the directive in the source file. 源文件中指令所在的行号。
	$GOPACKAGE
		The name of the package of the file containing the directive. 包含指令的文件的包的名字。
	$DOLLAR
		A dollar sign. 一个美元符号。

Other than variable substitution and quoted-string evaluation, no
special processing such as "globbing" is performed on the command
line.
除了变量替换和带引号的字符串求值外,在命令行上不执行诸如“globbing”之类的特殊处理。

As a last step before running the command, any invocations of any
environment variables with alphanumeric names, such as $GOFILE or
$HOME, are expanded throughout the command line. The syntax for
variable expansion is $NAME on all operating systems. Due to the
order of evaluation, variables are expanded even inside quoted
strings. If the variable NAME is not set, $NAME expands to the
empty string.
作为运行命令之前的最后一步,对任何具有字母数字名称的环境变量(例如$GOFILE或$HOME)的任何调用都会在整个命令行中展开。变量扩展的语法在所有操作系统上都是$NAME。由于求值的顺序,变量甚至在带引号的字符串中也会被扩展。如果未设置变量NAME,则$NAME将扩展为空字符串。

A directive of the form,
一个以下形式的指令,

	//go:generate -command xxx args...

specifies, for the remainder of this source file only, that the
string xxx represents the command identified by the arguments. This
can be used to create aliases or to handle multiword generators.
For example,
仅针对此源文件的其余部分,指定的字符串xxx表示由参数标识的命令。这可用于创建别名或处理多字生成器。
例如,

	//go:generate -command foo go tool foo

specifies that the command "foo" represents the generator
"go tool foo".
指定"foo"命令代表"go tool foo"生成器。

Generate processes packages in the order given on the command line,
one at a time. If the command line lists .go files from a single directory,
they are treated as a single package. Within a package, generate processes the
source files in a package in file name order, one at a time. Within
a source file, generate runs generators in the order they appear
in the file, one at a time. The go generate tool also sets the build
tag "generate" so that files may be examined by go generate but ignored
during build.
按照命令行上给定的顺序生成进程包,一次一个。如果命令行列出了单个目录中的.go文件,它们将被视为单个包。在包中,generate按文件名顺序处理包中的源文件,一次一个。在源文件中,generate按照它们在文件中出现的顺序运行生成器,一次一个。go generate工具还设置了构建标签“generate”,以便go generate可以检查文件,但在构建过程中会忽略这些文件。

For packages with invalid code, generate processes only source files with a
valid package clause.
对于具有无效代码的包,仅生成具有有效包子句的源文件。

If any generator returns an error exit status, "go generate" skips
all further processing for that package.
如果任何生成器返回错误退出状态,“go generate”会跳过该包的所有进一步的处理。

The generator is run in the package's source directory.
生成器在包的源目录中运行。

Go generate accepts one specific flag:
go generate接受一个特定的标志:

	-run=""
		if non-empty, specifies a regular expression to select
		directives whose full original source text (excluding
		any trailing spaces and final newline) matches the
		expression.
如果非空,则指定一个正则表达式以选择其完整的原始源文本(不包括任何尾随空格和最后的换行符)与该表达式匹配的指令。

It also accepts the standard build flags including -v, -n, and -x.
The -v flag prints the names of packages and files as they are
processed.
The -n flag prints commands that would be executed.
The -x flag prints commands as they are executed.
它还接受标准构建标志,包括-v、-n和-x。
-v标志在处理包和文件时打印它们的名称。
-n标志打印将要执行的命令。
-x标志在执行命令时打印命令。

For more about build flags, see 'go help build'.
有关构建标志的更多信息,请参阅“go help build”。

For more about specifying packages, see 'go help packages'.
有关指定包的更多信息,请参阅“go help packages”。

go get将依赖项添加到当前模块并安装它们

$ go help get
usage: go get [-t] [-u] [-v] [build flags] [packages]
用法:go get [-t] [-u] [-v] [build flags] [packages]

Get resolves its command-line arguments to packages at specific module versions,
updates go.mod to require those versions, and downloads source code into the
module cache.
get将其命令行参数解析为特定模块版本的包,更新go.mod以需求这些版本,并将源代码下载到模块缓存中。

To add a dependency for a package or upgrade it to its latest version:
要为软件包添加依赖项或将其升级到最新版本:

	go get example.com/pkg

To upgrade or downgrade a package to a specific version:
要将软件包升级或降级到特定版本:

	go get example.com/[email protected]

To remove a dependency on a module and downgrade modules that require it:
删除对某个模块的依赖并降级需求它的模块:

	go get example.com/mod@none

See https://golang.org/ref/mod#go-get for details.
有关详细信息,请参阅https://golang.org/ref/mod#go-get。

In earlier versions of Go, 'go get' was used to build and install packages.
Now, 'go get' is dedicated to adjusting dependencies in go.mod. 'go install'
may be used to build and install commands instead. When a version is specified,
'go install' runs in module-aware mode and ignores the go.mod file in the
current directory. For example:
在早期版本的Go中,“go get”用于构建和安装包。现在,'go get'专门用于调整go.mod中的依赖关系。'go install'可用于构建和安装命令。当指定版本时,“go install”以模块感知模式运行,并忽略当前目录中的go.mod 文件。例如:

	go install example.com/[email protected]
	go install example.com/pkg@latest

See 'go help install' or https://golang.org/ref/mod#go-install for details.
有关详细信息,请参阅“go help install”或https://golang.org/ref/mod#go-install。

'go get' accepts the following flags.
'go get'接受以下标志。

The -t flag instructs get to consider modules needed to build tests of
packages specified on the command line.
-t标志指示get考虑构建命令行上指定的包的测试所需的模块。

The -u flag instructs get to update modules providing dependencies
of packages named on the command line to use newer minor or patch
releases when available.
-u标志指示get更新提供包的依赖项的模块,以便在可用时使用更新次版本号或补丁版本号,这些模块在命令行上给出名字。

The -u=patch flag (not -u patch) also instructs get to update dependencies,
but changes the default to select patch releases.
-u=patch标志(不是-u patch)还指示get更新依赖项,但将默认值更改为选择补丁版本号。

When the -t and -u flags are used together, get will update
test dependencies as well.
当-t和-u标志一起使用时,get也会更新测试所需的依赖项。

The -x flag prints commands as they are executed. This is useful for
debugging version control commands when a module is downloaded directly
from a repository.
-x标志在执行命令时打印命令。当直接从存储库下载模块时,这对于调试版本控制命令很有用。

For more about modules, see https://golang.org/ref/mod.
有关模块的更多信息,请参阅https://golang.org/ref/mod。

For more about specifying packages, see 'go help packages'.
有关指定包的更多信息,请参阅“go help packages”。

This text describes the behavior of get using modules to manage source
code and dependencies. If instead the go command is running in GOPATH
mode, the details of get's flags and effects change, as does 'go help get'.
See 'go help gopath-get'.
本文描述了get使用模块来管理源代码和依赖项的行为。如果go命令在GOPATH模式下运行,则get的标志和效果的详细信息会发生变化,“go help get”也是如此。请参阅“go help gopath-get”。

See also: go build, go install, go clean, go mod.
另请参阅:go build, go install, go clean, go mod。

go install编译并安装包和依赖项

$ go help install
usage: go install [build flags] [packages]
用法:go install [build flags] [packages]

Install compiles and installs the packages named by the import paths.
install编译并安装由导入路径给出名字的包。

Executables are installed in the directory named by the GOBIN environment
variable, which defaults to $GOPATH/bin or $HOME/go/bin if the GOPATH
environment variable is not set. Executables in $GOROOT
are installed in $GOROOT/bin or $GOTOOLDIR instead of $GOBIN.
可执行文件安装在由GOBIN环境变量命名的目录中,默认为$GOPATH/bin,如果未设置GOPATH环境变量,则安装在$HOME/go/bin。$GOROOT中的可执行文件安装在$GOROOT/bin或$GOTOOLDIR而不是$GOBIN中。

If the arguments have version suffixes (like @latest or @v1.0.0), "go install"
builds packages in module-aware mode, ignoring the go.mod file in the current
directory or any parent directory, if there is one. This is useful for
installing executables without affecting the dependencies of the main module.
To eliminate ambiguity about which module versions are used in the build, the
arguments must satisfy the following constraints:
如果参数有版本号后缀(例如@latest或@v1.0.0),“go install”以模块感知模式构建包,忽略当前目录或任何父目录中的go.mod文件(如果有的话)。这对于在不影响主模块依赖关系的情况下安装可执行文件很有用。为了消除构建中使用的模块版本的歧义,参数必须满足以下约束:

- Arguments must be package paths or package patterns (with "..." wildcards).
They must not be standard packages (like fmt), meta-patterns (std, cmd,
all), or relative or absolute file paths.
参数必须是包路径或包模式(带有“...”通配符)。它们不能是标准包(例如fmt)、元模式(std、cmd、all)或相对或绝对文件路径。

- All arguments must have the same version suffix. Different queries are not
allowed, even if they refer to the same version.
所有参数必须具有相同的版本号后缀。不允许不同的查询,即使它们引用相同的版本。

- All arguments must refer to packages in the same module at the same version. 所有参数必须引用相同版本的相同模块中的包。

- Package path arguments must refer to main packages. Pattern arguments
will only match main packages.
包路径参数必须引用主包。模式参数只会匹配主包。

- No module is considered the "main" module. If the module containing
packages named on the command line has a go.mod file, it must not contain
directives (replace and exclude) that would cause it to be interpreted
differently than if it were the main module. The module must not require
a higher version of itself.
没有模块被视为“主”模块。如果包含在命令行中给出名字的包的模块有一个go.mod文件,则它不能包含replace和exclude指令,因为这两个指令会导致对它的解释与当它作为主模块时对它的解释不同。该模块不得需求其自身的更高版本。

- Vendor directories are not used in any module. (Vendor directories are not
included in the module zip files downloaded by 'go install'.)
Vendor目录不会在任何模块中使用。(Vendor目录不包含在“go install”下载的模块zip文件中。)

If the arguments don't have version suffixes, "go install" may run in
module-aware mode or GOPATH mode, depending on the GO111MODULE environment
variable and the presence of a go.mod file. See 'go help modules' for details.
If module-aware mode is enabled, "go install" runs in the context of the main
module.
如果参数没有版本号后缀,“go install”可能会在模块感知模式或GOPATH模式下运行,具体取决于GO111MODULE环境变量和go.mod文件的存在。有关详细信息,请参阅“go help modules”。如果启用了模块感知模式,“go install”将在主模块的上下文中运行。

When module-aware mode is disabled, other packages are installed in the
directory $GOPATH/pkg/$GOOS_$GOARCH. When module-aware mode is enabled,
other packages are built and cached but not installed.
当禁用模块感知模式时,其他包将安装在目录$GOPATH/pkg/$GOOS_$GOARCH中。当启用模块感知模式时,会生成和缓存其他包,但不会安装。

The -i flag installs the dependencies of the named packages as well.
The -i flag is deprecated. Compiled packages are cached automatically.
-i标志还安装命名包的依赖项。
-i标志已弃用。编译的包将自动缓存。

For more about the build flags, see 'go help build'.
For more about specifying packages, see 'go help packages'.
有关构建标志的详细信息,请参阅“go help build”。
有关指定包的详细信息,请参阅“go help packages”。

See also: go build, go get, go clean.
另请参阅:go build,go get,go clean。

go list列出当前全部安装的模块或包

$ go help list
usage: go list [-f format] [-json] [-m] [list flags] [build flags] [packages]
用法:go list [-f format] [-json] [-m] [list flags] [build flags] [packages]

List lists the named packages, one per line.
The most commonly-used flags are -f and -json, which control the form
of the output printed for each package. Other list flags, documented below,
control more specific details.
list列出命名的包,每行一个。
最常用的标志是-f和-json,它们控制为每个包打印输出的格式。下面记录的其他list标志控制更具体的细节。

The default output shows the package import path:
默认输出显示包的导入路径:

    bytes
    encoding/json
    github.com/gorilla/mux
    golang.org/x/net/html

The -f flag specifies an alternate format for the list, using the
syntax of package template. The default output is equivalent
to -f '{{.ImportPath}}'. The struct being passed to the template is:
-f标志使用包模板的语法指定list的替代格式。默认输出格式等效于-f '{{.ImportPath}}'。传递给模板的结构是:

    type Package struct {
        Dir           string   // directory containing package sources 包含包源代码的目录
        ImportPath    string   // import path of package in dir 包在dir里的导入路径
        ImportComment string   // path in import comment on package statement 包语句的导入注释中的路径
        Name          string   // package name 包名
        Doc           string   // package documentation string 包文档字符串
        Target        string   // install path 安装路径
        Shlib         string   // the shared library that contains this package (only set when -linkshared) 包含此包的共享库(仅在-linkshared时设置)
        Goroot        bool     // is this package in the Go root? 此包是否在Go安装目录里?
        Standard      bool     // is this package part of the standard Go library? 此包是Go标准库的一部分吗?
        Stale         bool     // would 'go install' do anything for this package? 'go install'是否会对此包做一些事情?
        StaleReason   string   // explanation for Stale==true 对Stale==true的解释
        Root          string   // Go root or Go path dir containing this package 包含此包的Go root或Go path目录
        ConflictDir   string   // this directory shadows Dir in $GOPATH 此目录隐藏了$GOPATH中的目录
        BinaryOnly    bool     // binary-only package (no longer supported) 只是二进制包(已经不再支持)
        ForTest       string   // package is only for use in named test 只用于测试的包
        Export        string   // file containing export data (when using -export) 包含导出数据的文件(使用-export时)
        BuildID       string   // build ID of the compiled package (when using -export) 编译包的构建ID(使用-export时)
        Module        *Module  // info about package's containing module, if any (can be nil) 关于包的包含模块的信息,如果有的话(可以是nil)
        Match         []string // command-line patterns matching this package 匹配此包的命令行模式
        DepOnly       bool     // package is only a dependency, not explicitly listed 此包只是一个依赖项,没有显式地被列出

        // Source files 源文件
        GoFiles         []string   // .go source files (excluding CgoFiles, TestGoFiles, XTestGoFiles) .go源文件(不包括CgoFiles、TestGoFiles、XTestGoFiles)
        CgoFiles        []string   // .go source files that import "C" 导入“C”的.go源文件
        CompiledGoFiles []string   // .go files presented to compiler (when using -compiled) 呈现给编译器的.go文件(使用-compiled时)
        IgnoredGoFiles  []string   // .go source files ignored due to build constraints 因构建约束而被忽略的.go源文件
        IgnoredOtherFiles []string // non-.go source files ignored due to build constraints 由于构建约束而被忽略的非.go源文件
        CFiles          []string   // .c source files .c源文件
        CXXFiles        []string   // .cc, .cxx and .cpp source files .cc,.cxx和.cpp源文件
        MFiles          []string   // .m source files .m源文件
        HFiles          []string   // .h, .hh, .hpp and .hxx source files .h,.hh,.hpp和.hxx源文件
        FFiles          []string   // .f, .F, .for and .f90 Fortran source files .f,.F,.for和.f90 Fortran源文件
        SFiles          []string   // .s source files .s源文件
        SwigFiles       []string   // .swig files .swig文件
        SwigCXXFiles    []string   // .swigcxx files .swigcxx文件
        SysoFiles       []string   // .syso object files to add to archive 要添加到文档的.syso目标文件
        TestGoFiles     []string   // _test.go files in package 包里的_test.go文件
        XTestGoFiles    []string   // _test.go files outside package 包外面的_test.go文件

        // Embedded files 内嵌的文件
        EmbedPatterns      []string // //go:embed patterns go:内嵌模式
        EmbedFiles         []string // files matched by EmbedPatterns 匹配EmbedPatterns的文件
        TestEmbedPatterns  []string // //go:embed patterns in TestGoFiles go:在TestGoFiles里内嵌的模式
        TestEmbedFiles     []string // files matched by TestEmbedPatterns 匹配TestEmbedPatterns的文件
        XTestEmbedPatterns []string // //go:embed patterns in XTestGoFiles go:在XTestGoFiles里内嵌的模式
        XTestEmbedFiles    []string // files matched by XTestEmbedPatterns 匹配XTestEmbedPatterns的文件

        // Cgo directives Cgo指令
        CgoCFLAGS    []string // cgo: flags for C compiler cgo:C编译器cgo的标志
        CgoCPPFLAGS  []string // cgo: flags for C preprocessor cgo:C预处理器的标志
        CgoCXXFLAGS  []string // cgo: flags for C++ compiler cgo:C++编译器的标志
        CgoFFLAGS    []string // cgo: flags for Fortran compiler cgo:Fortran编译器的标志
        CgoLDFLAGS   []string // cgo: flags for linker cgo:连接器的标志
        CgoPkgConfig []string // cgo: pkg-config names cgo:pkg-config的名字

        // Dependency information 依赖信息
        Imports      []string          // import paths used by this package 此包使用的导入路径
        ImportMap    map[string]string // map from source import to ImportPath (identity entries omitted) 从源导入映射到 ImportPath(省略标识条目)
        Deps         []string          // all (recursively) imported dependencies 所有(递归地)导入的依赖项
        TestImports  []string          // imports from TestGoFiles 从TestGoFiles的导入
        XTestImports []string          // imports from XTestGoFiles 从XTestGoFiles的导入

        // Error information 错误信息
        Incomplete bool            // this package or a dependency has an error 次包或一个依赖项有一个错误
        Error      *PackageError   // error loading package 加载包时出错
        DepsErrors []*PackageError // errors loading dependencies 加载依赖项时出错
    }

Packages stored in vendor directories report an ImportPath that includes the
path to the vendor directory (for example, "d/vendor/p" instead of "p"),
so that the ImportPath uniquely identifies a given copy of a package.
The Imports, Deps, TestImports, and XTestImports lists also contain these
expanded import paths. See golang.org/s/go15vendor for more about vendoring.
存储在vendor目录中的软件包报告一个ImportPath,其中包含vendor目录的路径(例如,“d/ivendor/p”而不是“p”),以便ImportPath唯一标识软件包的给定副本。
Imports、Deps、TestImports和XTestImports列表也包含这些扩展的导入路径。见golang.org/s/go15vendor了解更多关于vendor的信息。

The error information, if any, is
错误信息(如果有的话)是

    type PackageError struct {
        ImportStack   []string // shortest path from package named on command line to this one 在命令行给出名字的包到这个包的最短路径
        Pos           string   // position of error (if present, file:line:col) 错误位置(如果存在的话,文件名:行号:列号)
        Err           string   // the error itself 错误本身
    }

The module information is a Module struct, defined in the discussion
of list -m below.
模块信息是一个Module结构体,在下面list -m的讨论中定义。

The template function "join" calls strings.Join.
模板函数“join”调用strings.Join。

The template function "context" returns the build context, defined as:
模板函数“context”返回构建上下文,定义为:

    type Context struct {
        GOARCH        string   // target architecture 目标架构
        GOOS          string   // target operating system 目标操作系统
        GOROOT        string   // Go root Go语言安装路径
        GOPATH        string   // Go path Go语言包的查找路径
        CgoEnabled    bool     // whether cgo can be used 是否可以使用cgo
        UseAllFiles   bool     // use files regardless of +build lines, file names 无论+build行、文件名如何,都使用文件
        Compiler      string   // compiler to assume when computing target paths 计算目标路径时假定的编译器
        BuildTags     []string // build constraints to match in +build lines 用于匹配+build行的构建约束
        ToolTags      []string // toolchain-specific build constraints 特定于工具链的构建约束
        ReleaseTags   []string // releases the current release is compatible with 当前发布版本兼容的发布版本
        InstallSuffix string   // suffix to use in the name of the install dir 要在安装目录名称中使用的后缀
    }

For more information about the meaning of these fields see the documentation
for the go/build package's Context type.
有关这些字段含义的更多信息,请参阅go/build包的Context类型的文档。

The -json flag causes the package data to be printed in JSON format
instead of using the template format.
-json标志使包数据以JSON格式而不是使用模板格式打印。

The -compiled flag causes list to set CompiledGoFiles to the Go source
files presented to the compiler. Typically this means that it repeats
the files listed in GoFiles and then also adds the Go code generated
by processing CgoFiles and SwigFiles. The Imports list contains the
union of all imports from both GoFiles and CompiledGoFiles.
-compiled标志让list将CompiledGoFiles设置为呈现给编译器的Go源文件。通常这意味着它会重复GoFiles中列出的文件,然后还会添加通过处理CgoFiles和SwigFiles生成的Go代码。Imports列表包含来自GoFiles和CompiledGoFiles的所有导入的并集。

The -deps flag causes list to iterate over not just the named packages
but also all their dependencies. It visits them in a depth-first post-order
traversal, so that a package is listed only after all its dependencies.
Packages not explicitly listed on the command line will have the DepOnly
field set to true.
-deps标志导致list不仅遍历给出名字的包,还遍历它们的所有依赖项。它以深度优先的后序遍历方式访问它们,因此包仅在其所有依赖项之后列出。
将DepOnly字段设置为true的包不会在命令行上明确列出。

The -e flag changes the handling of erroneous packages, those that
cannot be found or are malformed. By default, the list command
prints an error to standard error for each erroneous package and
omits the packages from consideration during the usual printing.
With the -e flag, the list command never prints errors to standard
error and instead processes the erroneous packages with the usual
printing. Erroneous packages will have a non-empty ImportPath and
a non-nil Error field; other information may or may not be missing
(zeroed).
-e标志更改对错误包的处理方式,即那些无法找到或格式错误的包。默认情况下,list命令为每个错误的包打印一个错误到标准误,并在通常的打印过程中忽略这些包。
使用-e标志,list命令永远不会将错误打印到标准误,而是使用通常的打印来处理错误的包。错误的包将有一个非空的ImportPath和一个非nil的错误字段;其他信息可能会或可能不会丢失(归零)。

The -export flag causes list to set the Export field to the name of a
file containing up-to-date export information for the given package.
-export标志使list将Export字段设置为包含给定包的最新导出信息的文件名。

The -find flag causes list to identify the named packages but not
resolve their dependencies: the Imports and Deps lists will be empty.
-find标志让list识别给出名字的包但不解析它们的依赖关系:Imports和Deps的列表将为空。

The -test flag causes list to report not only the named packages
but also their test binaries (for packages with tests), to convey to
source code analysis tools exactly how test binaries are constructed.
The reported import path for a test binary is the import path of
the package followed by a ".test" suffix, as in "math/rand.test".
When building a test, it is sometimes necessary to rebuild certain
dependencies specially for that test (most commonly the tested
package itself). The reported import path of a package recompiled
for a particular test binary is followed by a space and the name of
the test binary in brackets, as in "math/rand [math/rand.test]"
or "regexp [sort.test]". The ForTest field is also set to the name
of the package being tested ("math/rand" or "sort" in the previous
examples).
-test标志让list不仅报告给出名字的包,还报告它们的测试二进制文件(对于带有测试的包),以准确地向源代码分析工具传达测试二进制文件的构建方式。
报告的测试二进制文件的导入路径是包的导入路径,后跟“.test”后缀,例如“math/rand.test”。
在构建测试时,有时需要专门为该测试重建某些依赖项(最常见的是测试包本身)。 为特定测试二进制文件重新编译的包的报告的导入路径后跟一个空格和方括号中的测试二进制文件的名称,例如“math/rand [math/rand.test]”或“regexp [sort.test]”。ForTest字段也设置为正在测试的包的名称(前面示例中的“math/rand”或“sort”)。

The Dir, Target, Shlib, Root, ConflictDir, and Export file paths
are all absolute paths.
Dir、Target、Shlib、Root、ConflictDir、Export的文件路径都是绝对路径。

By default, the lists GoFiles, CgoFiles, and so on hold names of files in Dir
(that is, paths relative to Dir, not absolute paths).
The generated files added when using the -compiled and -test flags
are absolute paths referring to cached copies of generated Go source files.
Although they are Go source files, the paths may not end in ".go".
默认情况下,GoFiles、CgoFiles等列表包含Dir中文件的名称(即相对于Dir的路径,而不是绝对路径)。
使用-compiled和-test标志时添加的生成文件使用绝对路径,指向的是生成的Go源文件的缓存副本。
虽然它们是Go源文件,但路径可能不会以“.go”结尾。

The -m flag causes list to list modules instead of packages.
-m标志让list列出模块而不是包。

When listing modules, the -f flag still specifies a format template
applied to a Go struct, but now a Module struct:
列出模块时,-f标志仍然指定应用于一个Go结构体的格式模板,但现在是一个模块(Module)结构:

    type Module struct {
        Path      string       // module path 模块路径
        Version   string       // module version 模块版本号
        Versions  []string     // available module versions (with -versions) 可用的模块版本(使用-versions选项)
        Replace   *Module      // replaced by this module 被这个模块替代
        Time      *time.Time   // time version was created 版本被创建的时刻
        Update    *Module      // available update, if any (with -u)  可用的更新,如果可用的话(使用-u选项)
        Main      bool         // is this the main module? 这是主模块吗?
        Indirect  bool         // is this module only an indirect dependency of main module? 这个模块只是主模块的一个间接依赖项吗?
        Dir       string       // directory holding files for this module, if any 包含这个模块的文件的目录,如果有的话
        GoMod     string       // path to go.mod file used when loading this module, if any 当加载这个模块的时候使用的go.mod文件的路径,如果有的话
        GoVersion string       // go version used in module 在模块里使用的go版本
        Retracted string       // retraction information, if any (with -retracted or -u) 撤回相关信息,如果有的话(使用-retracted或-u选项)
        Error     *ModuleError // error loading module 加载模块错误
    }

    type ModuleError struct {
        Err string // the error itself 错误本身
    }

The file GoMod refers to may be outside the module directory if the
module is in the module cache or if the -modfile flag is used.
如果模块在模块缓存中或使用了-modfile标志,则GoMod引用的文件可能位于模块目录之外。

The default output is to print the module path and then
information about the version and replacement if any.
For example, 'go list -m all' might print:
默认打印输出模块路径,然后是版本号和替换(如果有的话)相关的信息。
例如,“go-list-mall”可能会打印:

    my/main/module
    golang.org/x/text v0.3.0 => /tmp/text
    rsc.io/pdf v0.1.1

The Module struct has a String method that formats this
line of output, so that the default format is equivalent
to -f '{{.String}}'.
Module结构体有一个String方法来格式化这行输出,因此默认格式相当于-f '{{.String}}'。

Note that when a module has been replaced, its Replace field
describes the replacement module, and its Dir field is set to
the replacement's source code, if present. (That is, if Replace
is non-nil, then Dir is set to Replace.Dir, with no access to
the replaced source code.)
请注意,当模块被替换时,其Replace字段描述替换模块,并且其Dir字段设置为替换模块的源代码(如果存在)。(也就是说,如果Replace为非nil,则Dir设置为Replace.Dir,无法访问被替换的源代码。)

The -u flag adds information about available upgrades.
When the latest version of a given module is newer than
the current one, list -u sets the Module's Update field
to information about the newer module. list -u will also set
the module's Retracted field if the current version is retracted.
The Module's String method indicates an available upgrade by
formatting the newer version in brackets after the current version.
If a version is retracted, the string "(retracted)" will follow it.
For example, 'go list -m -u all' might print:
-u标志添加有关可用升级的信息。
当给定模块的最新版本比当前版本新时,list -u将模块的Update字段设置为有关较新模块的信息。如果当前版本被撤回,list -u还将设置模块的Retracted字段。
模块的String方法通过在当前版本之后的方括号中格式化新版本来指示可用的升级。
如果一个版本被撤回,字符串“(retracted)”将跟随它。
例如,'go list -m -u all'可能会打印:

    my/main/module
    golang.org/x/text v0.3.0 [v0.4.0] => /tmp/text
    rsc.io/pdf v0.1.1 (retracted) [v0.1.2]

(For tools, 'go list -m -u -json all' may be more convenient to parse.)
(对于工具,“go list -m -u -json all”的输出可能更便于解析。)

The -versions flag causes list to set the Module's Versions field
to a list of all known versions of that module, ordered according
to semantic versioning, earliest to latest. The flag also changes
the default output format to display the module path followed by the
space-separated version list.
-versions标志使list将Module的versions字段设置为该模块的所有已知版号本的列表,这些版本根据语义版本号从最早到最新进行排序。该标志还将更改默认输出格式,以显示模块路径,后跟空格分隔的版本号列表。

The -retracted flag causes list to report information about retracted
module versions. When -retracted is used with -f or -json, the Retracted
field will be set to a string explaining why the version was retracted.
The string is taken from comments on the retract directive in the
module's go.mod file. When -retracted is used with -versions, retracted
versions are listed together with unretracted versions. The -retracted
flag may be used with or without -m.
-retracted标志让list报告有关撤回的模块的版本信息。当-retracted与-f或-json一起使用时,Retracted字段将被设置为一个字符串,解释版本被撤回的原因。
该字符串取自模块的go.mod文件中retract指令的注释。当-retracted与-versions一起使用时,撤回的版本与未撤回的版本一起列出。-retracted标志可以与-m一起使用,也可以不与-m一起使用。

The arguments to list -m are interpreted as a list of modules, not packages.
The main module is the module containing the current directory.
The active modules are the main module and its dependencies.
With no arguments, list -m shows the main module.
With arguments, list -m shows the modules specified by the arguments.
Any of the active modules can be specified by its module path.
The special pattern "all" specifies all the active modules, first the main
module and then dependencies sorted by module path.
A pattern containing "..." specifies the active modules whose
module paths match the pattern.
A query of the form path@version specifies the result of that query,
which is not limited to active modules.
See 'go help modules' for more about module queries.
list -m的参数被解释为模块的列表,而不是包的列表。
主(main)模块是包含当前目录的模块。
活动(active)模块是主模块及其依赖项。
没有给出参数时,list -m显示主模块。
给出参数时,list -m显示参数指定的模块。
任何活动模块都可以通过其模块路径指定。
特殊模式“all”指定所有活动模块,首先是主模块,然后是按模块路径排序的依赖项。
包含“...”的模式指定其模块路径与该模式匹配的活动模块。
path@version形式的查询指定该查询的结果,它不限于活动模块。
有关模块查询的更多信息,请参阅“go help modules”。

The template function "module" takes a single string argument
that must be a module path or query and returns the specified
module as a Module struct. If an error occurs, the result will
be a Module struct with a non-nil Error field.
模板函数“module”接受一个字符串参数,该参数必须是模块路径或查询,并将指定的模块作为Module结构体实例返回。如果发生错误,结果将是一个带有非nil值的Error字段的Module结构体实例。

For more about build flags, see 'go help build'.
有关构建标志的详细信息,请参阅“go help build”。

For more about specifying packages, see 'go help packages'.
有关指定包的详细信息,请参阅“go help packages”。

For more about modules, see https://golang.org/ref/mod.
有关模块的更多信息,请参阅https://golang.org/ref/mod.

go mod模块维护

$ go help mod
Go mod provides access to operations on modules.
Go mod提供对模块操作的访问。

Note that support for modules is built into all the go commands,
not just 'go mod'. For example, day-to-day adding, removing, upgrading,
and downgrading of dependencies should be done using 'go get'.
See 'go help modules' for an overview of module functionality.
请注意,所有go命令都内置了对模块的支持,而不仅仅是“go mod”。例如,日常添加、删除、升级和降级依赖项应该使用“go get”来完成。
有关模块功能的概述,请参阅“go help modules”。

Usage:
用法:

	go mod <command> [arguments]

The commands are:
命令有:

	download    download modules to local cache 下载模块到本地缓存
	edit        edit go.mod from tools or scripts 从工具或脚本编辑go.mod
	graph       print module requirement graph 打印输出模块依赖图
	init        initialize new module in current directory 在当前目录下初始化一个新模块
	tidy        add missing and remove unused modules 添加缺少的模块并删除未被使用的模块
	vendor      make vendored copy of dependencies 拷贝依赖项到vendor目录
	verify      verify dependencies have expected content 验证依赖项是否具有预期的内容
	why         explain why packages or modules are needed 解释为什么需要这些包或模块

Use "go help mod <command>" for more information about a command.
对于其中某一个命令,使用"go help mod <command>"查看它的详细信息。

对于其中某一个命令,查看go.mod英文文文档或go.mod中文文档查看它的更详细的信息。

go work工作空间维护

$ go help work
Work provides access to operations on workspaces.
work提供对工作空间的操作的访问。

Note that support for workspaces is built into many other commands, not
just 'go work'.
请注意,对工作空间的支持内置于许多其他命令中,而不只是'go work'。

See 'go help modules' for information about Go's module system of which
workspaces are a part.
有关Go的模块系统的信息,请参阅“go help modules”,其中工作空间是其中的一部分。

See https://go.dev/ref/mod#workspaces for an in-depth reference on
workspaces.
有关工作空间的深入参考,请参阅https://go.dev/ref/mod#workspaces。

See https://go.dev/doc/tutorial/workspaces for an introductory
tutorial on workspaces.
有关工作空间的介绍性教程,请参阅https://go.dev/doc/tutorial/workspaces。

A workspace is specified by a go.work file that specifies a set of
module directories with the "use" directive. These modules are used as
root modules by the go command for builds and related operations.  A
workspace that does not specify modules to be used cannot be used to do
builds from local modules.
工作空间由go.work文件指定,该文件使用“use”指令指定一组模块目录。这些模块被go命令用作构建和相关操作的根模块。未指定要使用的本地模块的工作空间不能使用本地模块进行构建。

go.work files are line-oriented. Each line holds a single directive,
made up of a keyword followed by arguments. For example:
go.work文件是面向行的。每行包含一个指令,由关键字和参数组成。例如:

	go 1.18

	use ../foo/bar
	use ./baz

	replace example.com/foo v1.2.3 => example.com/bar v1.4.5

The leading keyword can be factored out of adjacent lines to create a block,
like in Go imports.
前导关键字可以从相邻行中规约出来以创建一个块,就像在Go import中一样。

	use (
	  ../foo/bar
	  ./baz
	)

The use directive specifies a module to be included in the workspace's
set of main modules. The argument to the use directive is the directory
containing the module's go.mod file.
use指令指定要包含在工作空间的主模块集合中的模块。use指令的参数是包含该模块的go.mod文件的目录的路径。

The go directive specifies the version of Go the file was written at. It
is possible there may be future changes in the semantics of workspaces
that could be controlled by this version, but for now the version
specified has no effect.
go指令指定编写文件时使用的Go版本。将来此版本控制的工作空间的语义可能发生变化,但目前指定的版本没有影响。

The replace directive has the same syntax as the replace directive in a
go.mod file and takes precedence over replaces in go.mod files.  It is
primarily intended to override conflicting replaces in different workspace
modules.
replace指令与go.mod文件中的replace指令具有相同的语法,并且优先于go.mod文件中的替换。它主要用于重写不同工作空间模块中的冲突的替换。

To determine whether the go command is operating in workspace mode, use
the "go env GOWORK" command. This will specify the workspace file being
used.
要确定go命令是否在工作空间模式下运行,请使用“go env GOWORK”命令。这将指定正在使用的工作空间文件。

Usage:
用法:

	go work <command> [arguments]

The commands are:
命令有:

	edit        edit go.work from tools or scripts 从工具或脚本编辑go.work
	init        initialize workspace file 初始化工作空间文件
	sync        sync workspace build list to modules 同步工作空间构建列表到模块
	use         add modules to workspace file 添加模块到工作空间文件

Use "go help work <command>" for more information about a command.
使用“go help work <command>”获取有关命令的更多信息。

syscall包

本文翻译自《The syscall package》。

作者:Rob Pike 日期:2014

状态:此提案[Go 1.4版本采用] (https://go.dev/doc/go1.4#major_library_changes)。

问题

现在的syscall包有几个问题:

1.膨胀。它包含许多系统调用和常量的定义,用于大量且不断增长的体系结构和操作系统。

2.测试。很少有接口有明确的测试,跨平台测试是不可能的。

3.管理。许多更改列表到来,以支持范围广泛的包和系统。这些变化的优点很难判断,所以基本上任何事情都会发生。该软件包是标准存储库中维护最差、测试最差、文档最差的软件包,并且还在继续恶化。

4.文档。称为syscall的单个包对于每个系统都不同,但godoc仅显示其本机环境的变体。此外,无论如何,文档都非常缺乏。大多数函数根本没有文档注释。

5.兼容性。尽管有最好的意图,但该软件包不符合Go 1兼容性保证,因为操作系统的变化方式超出了我们的控制范围。最近对FreeBSD的更改就是一个例子。

这个提议是试图改善这些问题。

提议

该提案有几个组成部分。没有特别的顺序:

1.Go 1的兼容性规则意味着我们不能直接解决问题,比如通过使包内部化。因此,我们建议从Go 1.3开始冻结该包,这意味着取消从那时起进行的一些更改。

2.支持Go未来版本所需的系统调用接口的任何更改都将通过为Go 1.4提议的内部包机制完成。

3.syscall包将不会在未来的版本中更新,甚至不会跟上它引用的操作系统的变化。例如,如果内核常量的值在未来的NetBSD版本中发生变化,则不会更新syscall包以反映这一点。

4.将创建一个新的子存储库go.sys

5.在go.sys内部,将有三个独立于syscall的包,分别称为plan9unixwindows,并且当前syscall包的内容将被适当地分解并安装在这些包中。(这种划分表达了系统之间的基本接口差异,允许一些源代码级别的可移植性,但在包中仍然需要构建标签来分离架构和变体(darwinlinux))。这些是我们希望所有外部Go包在需要支持系统调用时迁移到的包。因为它们是不同的,所以它们更容易管理,更容易使用godoc进行检查,并且可能更容易保持良好的文档记录。这种布局还使如何编写跨平台代码更加清晰:通过将系统相关元素分离为单独导入的组件。

6.go.sys存储库将随着操作系统的发展而更新。

7.标准syscall包的文档将引导用户访问新的存储库。尽管syscall包将继续存在并且可行,但所有新的公共开发都将在go.sys中进行。

8.核心存储库将不依赖于go.sys包,尽管某些子存储库(例如go.net)可能会依赖。

9.与任何标准存储库一样,go.sys存储库将由Go团队管理。将其从主存储库中分离出来使得自动化一些维护变得更加实际可行,例如通过对系统包含文件的详尽处理来自动创建包。

10.自1.3以来在syscall包中发生的任何非必要的提示更改都将迁移到go.sys子存储库。

请注意,由于兼容性保证,我们无法在任何有意义的范围内清理现有的syscall包。但是,我们可以冻结并实际上弃用它。

时间线

我们建议在Go 1.4的2014年9月1日截止日期之前完成这些更改。