Go语言命令行利器cobra使用教程

cobra是一个提供简单接口来创建强大的现代CLI界面的库类似git git tools，cobra也是一个应用程序，它会生成你的应用程序的脚手架来快速开发基于cobra的应用程序

创新互联提供成都网站制作、成都网站建设、网页设计，成都品牌网站建设，广告投放等致力于企业网站建设与公司网站制作，十载的网站开发和建站经验,助力企业信息化建设，成功案例突破近千家,是您实现网站建设的好选择.

cobra提供：

cobra建立在命令、参数、标志的结构之上

commands代表动作，args是事物，flags是动作的修饰符

最好的应用程序在使用时读起来就像句子，因此，用户直观地知道如何与它们交互

模式如下：APPNAME VERB NOUN --ADJECTIVE. or APPNAME COMMAND ARG --FLAG（APPNAME 动词 名词 形容词 或者 APPNAME 命令 参数 标志）

一些真实世界的好例子可以更好地说明这一点

kubectl 命令更能体现APPNAME 动词 名词 形容词

如下的例子，server 是command，port是flag

这个命令中，我们告诉git 克隆url

命令是应用程序的中心点，应用程序支持的每一个交互都包含在一个命令中，命令可以有子命令，也可以运行操作

在上面的例子中，server是命令

更多关于cobra.Command

flag是一种修改命令行为的方式，cobra支持完全兼容POSIX标志，也支持go flag package，cobra可以定义到子命令上的标志，也可以仅对该命令可用的标志

在上面的命令中，port是标志

标志的功能由 pflag library 提供，pflag library是flag标准库的一个分支，在添加POSIX兼容性的同时维护相同的接口。

使用cobra很简单，首先，使用go get按照最新版本的库，这个命令会安装cobra可执行程序以及库和依赖项

下一步，引入cobra到应用程序中

虽然欢迎您提供自己的组织，但通常基于Cobra的应用程序将遵循以下组织结构：

在Cobra应用程序中，main.go文件通常非常简单。它有一个目的：初始化Cobra。

使用cobra生成器

cobra提供了程序用来创建你的应用程序然后添加你想添加的命令，这是将cobra引入应用程序最简单的方式

这儿 你可以发现关于cobra的更多信息

要手动实现cobra，需要创建一个main.go 和rootCmd文件，可以根据需要提供其他命令

Cobra不需要任何特殊的构造器。只需创建命令。

理想情况下，您可以将其放在app/cmd/root.go中：

在init（）函数中定义标志和处理配置

例子如下，cmd/root.go:

创建main.go

使用root命令，您需要让主函数执行它。为清楚起见，Execute应该在根目录下运行，尽管它可以在任何命令上调用。

在Cobra应用程序中，main.go文件通常非常简单。它有一个目的：初始化Cobra。

可以定义其他命令，通常每个命令在cmd/目录中都有自己的文件。

如果要创建版本命令，可以创建cmd/version.go并用以下内容填充它：

如果希望将错误返回给命令的调用者，可以使用RunE。

然后可以在execute函数调用中捕获错误。

标志提供修饰符来控制操作命令的操作方式。

由于标志是在不同的位置定义和使用的，因此我们需要在外部定义一个具有正确作用域的变量来分配要使用的标志。

有两种不同的方法来分配标志。

标志可以是“持久”的，这意味着该标志将可用于分配给它的命令以及该命令下的每个命令。对于全局标志，在根上指定一个标志作为持久标志。

也可以在本地分配一个标志，该标志只应用于该特定命令。

默认情况下，Cobra只解析目标命令上的本地标志，而忽略父命令上的任何本地标志。通过启用Command.TraverseChildren，Cobra将在执行目标命令之前解析每个命令上的本地标志。

使用viper绑定标志

在本例中，持久标志author与viper绑定。注意：当用户未提供--author标志时，变量author将不会设置为config中的值。

更多关于 viper的文档

Flags默认是可选的，如果希望命令在未设置标志时报告错误，请根据需要进行标记：

持久性Flags

可以使用命令的Args字段指定位置参数的验证。

内置了以下验证器：

在下面的示例中，我们定义了三个命令。两个是顶级命令，一个（cmdTimes）是顶级命令之一的子命令。在这种情况下，根是不可执行的，这意味着需要一个子命令。这是通过不为“rootCmd”提供“Run”来实现的。

我们只为一个命令定义了一个标志。

有关标志的更多文档，请访问

对于一个更完整的例子更大的应用程序，请检查 Hugo 。

当您有子命令时，Cobra会自动将help命令添加到应用程序中。当用户运行“应用程序帮助”时，将调用此函数。此外，help还支持所有其他命令作为输入。例如，您有一个名为“create”的命令，没有任何附加配置；调用“app help create”时，Cobra将起作用。每个命令都会自动添加“-help”标志。

以下输出由Cobra自动生成。除了命令和标志定义之外，不需要任何东西。

帮助就像其他命令一样。它周围没有特殊的逻辑或行为。事实上，你可以提供你想提供的。

您可以为默认命令提供自己的帮助命令或模板，以用于以下功能：

当用户提供无效的标志或无效的命令时，Cobra通过向用户显示“用法”来响应。

你可以从上面的帮助中认识到这一点。这是因为默认帮助将用法作为其输出的一部分嵌入。

您可以提供自己的使用函数或模板供Cobra使用。与帮助一样，函数和模板也可以通过公共方法重写：

如果在root命令上设置了version字段，Cobra会添加一个顶级的'--version'标志。运行带有“-version”标志的应用程序将使用版本模板将版本打印到标准输出。可以使用cmd.SetVersionTemplate（s string）函数自定义模板。

可以在命令的主运行函数之前或之后运行函数。PersistentPreRun和PreRun函数将在运行之前执行。PersistentPostRun和PostRun将在运行后执行。如果子函数不声明自己的函数，则它们将继承Persistent*Run函数。这些函数按以下顺序运行：

输出：

当发生“未知命令”错误时，Cobra将打印自动建议。这使得Cobra在发生拼写错误时的行为类似于git命令。例如：

基于注册的每个子命令和Levenshtein距离的实现，建议是自动的。匹配最小距离2（忽略大小写）的每个已注册命令都将显示为建议。

如果需要在命令中禁用建议或调整字符串距离，请使用：

or

您还可以使用SuggestFor属性显式设置将为其建议给定命令的名称。这允许对在字符串距离方面不接近的字符串提供建议，但在您的一组命令中是有意义的，并且对于某些您不需要别名的字符串。例子：

Cobra可以基于子命令、标志等生成文档。请在 docs generation文档 中阅读更多关于它的信息。

Cobra可以为以下shell生成shell完成文件：bash、zsh、fish、PowerShell。如果您在命令中添加更多信息，这些补全功能将非常强大和灵活。在 Shell Completions 中阅读更多关于它的信息。

Cobra is released under the Apache 2.0 license. See LICENSE.txt

GO语言（十一）：开始使用多模块工作区

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

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

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

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

1、打开命令提示符并切换到您的主目录。

在 Linux 或 Mac 上：

在 Windows 上：

2、在命令提示符下，为您的代码创建一个名为工作区的目录。

3、初始化模块

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

创建你好模块：

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

在 hello 目录下创建 hello.go，内容如下：

现在，运行 hello 程序：

在这一步中，我们将创建一个go.work文件来指定模块的工作区。

在workspace目录中，运行：

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

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

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

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

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

所以在模块的任何子目录中workspace都会被激活。

2、运行工作区目录下的程序

在workspace目录中，运行：

Go 命令包括工作区中的所有模块作为主模块。这允许我们在模块中引用一个包，即使在模块之外。在模块或工作区之外运行go run命令会导致错误，因为该go命令不知道要使用哪些模块。

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

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

1、克隆存储库

在工作区目录中，运行git命令来克隆存储库：

2、将模块添加到工作区

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

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

这将允许我们使用我们将在模块副本中编写的新代码，而不是使用命令stringutil下载的模块缓存中的模块版本。

3、添加新功能。

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

将新文件夹添加到workspace/example/stringutil包含以下内容的目录：

4、修改hello程序以使用该功能。

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

从工作区目录，运行

Go 命令在go.work文件指定的hello目录中查找命令行中指定的example.com/hello模块 ，同样使用go.work文件解析导入golang.org/x/example。

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

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

现在，要正确发布这些模块，我们需要发布golang.org/x/example 模块，例如在v0.1.0. 这通常通过在模块的版本控制存储库上标记提交来完成。发布完成后，我们可以增加对 golang.org/x/example模块的要求hello/go.mod：

这样，该go命令可以正确解析工作区之外的模块。

GO语言（十五）：泛型入门（下）-

在本节中，您将添加通用函数调用的修改版本，进行小的更改以简化调用代码。您将删除在这种情况下不需要的类型参数。

当 Go 编译器可以推断您要使用的类型时，您可以在调用代码中省略类型参数。编译器从函数参数的类型推断类型参数。

请注意，这并不总是可能的。例如，如果您需要调用没有参数的泛型函数，则需要在函数调用中包含类型参数。

在 main.go 中，在您已有的代码下方，粘贴以下代码。

在此代码中：

（1）调用泛型函数，省略类型参数。

从包含 main.go 的目录中的命令行，运行代码。

接下来，您将通过将整数和浮点数的并集捕获到您可以重用的类型约束（例如从其他代码中）来进一步简化函数。

正如您将在本节中看到的，约束接口也可以引用特定类型。

1、编写代码

在此代码中：

b.在您已有的函数下方，粘贴以下通用 SumNumbers函数。

在此代码中：

c.在 main.go 中，在您已有的代码下方，粘贴以下代码。

在此代码中：

（1）调用SumNumbers打印每个map的总和。

与上一节一样，在调用泛型函数时省略了类型参数（方括号中的类型名称）。Go 编译器可以从其他参数推断类型参数。

从包含 main.go 的目录中的命令行，运行代码。

做得很好！您刚刚学习了 Go 中的泛型。

GO语言（二十五）：管理依赖项（上）-

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

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

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

下面列出了最常见的依赖项管理步骤。

在 Go 中，您将依赖项作为包含您导入的包的模块来管理。此过程由以下机构支持：

您可以搜索pkg.go.dev以查找具有您可能觉得有用的功能的软件包。

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

在您的代码导入包后，启用依赖项跟踪并获取包的代码进行编译。

要跟踪和管理您添加的依赖项，您首先要将代码放入其自己的模块中。这会在源代码树的根目录创建一个 go.mod 文件。您添加的依赖项将列在该文件中。

要将您的代码添加到它自己的模块中，请使用 go mod init命令。例如，从命令行切换到代码的根目录，然后按照以下示例运行命令：

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

如果一开始您不知道模块的最终存储库位置，请使用安全的替代品。这可能是您拥有的域的名称或您控制的另一个名称（例如您的公司名称），以及来自模块名称或源目录的路径。

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

添加依赖项时，Go 工具还会创建一个 go.sum 文件，其中包含您所依赖的模块的校验和。Go 使用它来验证下载的模块文件的完整性，特别是对于在您的项目上工作的其他开发人员。

在代码中包含存储库中的 go.mod 和 go.sum 文件。

当您运行go mod init创建用于跟踪依赖项的模块时，您指定一个模块路径作为模块的名称。模块路径成为模块中包的导入路径前缀。一定要指定一个不会与其他模块的模块路径冲突的模块路径。

至少，一个模块路径只需要表明它的来源，例如公司或作者或所有者名称。但是路径也可能更能描述模块是什么或做什么。

模块路径通常采用以下形式：

1、Go 工具可以在其中找到模块源代码的存储库的位置。

例如，它可能是github.com/ /.

如果您认为您可能会发布模块供其他人使用，请使用此最佳实践。

2、一个你控制的名字。

如果您不使用存储库名称，请务必选择一个您确信不会被其他人使用的前缀。一个不错的选择是您公司的名称。避免使用常用术语，例如widgets、utilities或 app。

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

1、test– 您可以将test用作模块路径前缀以便代码用于在另一个模块中本地测试功能进行测试。

使用test作为模块路径前缀是测试的一部分。例如，您的测试本身可能会运行go mod init test，然后以某种特定方式设置该模块，以便使用 Go 源代码分析工具进行测试。

2、example– 在某些 Go 文档中用作模块路径前缀，例如在创建模块以跟踪依赖关系的教程中。

请注意，Go 文档还用于example.com说明示例何时可能是已发布的模块。

GO语言（二十七）：管理依赖项（下）-

当您对外部模块的存储库进行了 fork （例如修复模块代码中的问题或添加功能）时，您可以让 Go 工具将您的 fork 用于模块的源代码。这对于测试您自己的代码的更改很有用。

为此，您可以使用go.mod 文件中的replace指令将外部模块的原始模块路径替换为存储库中 fork 的路径。这指示 Go 工具在编译时使用替换路径（fork 的位置），例如，同时允许您保留import 原始模块路径中的语句不变。

在以下 go.mod 文件示例中，当前模块需要外部模块example.com/theirmodule。然后该replace指令将原始模块路径替换为example.com/myfork/theirmodule模块自己的存储库的分支。

设置require/replace对时，使用 Go 工具命令确保文件描述的需求保持一致。使用go list命令获取当前模块正在使用的版本。然后使用go mod edit命令将需要的模块替换为fork：

注意： 当您使用该replace指令时，Go 工具不会像添加依赖项中所述对外部模块进行身份验证。

您可以使用go get命令从其存储库中的特定提交为模块添加未发布的代码。

为此，您使用go get命令，用符号@指定您想要的代码 。当您使用go get时，该命令将向您的 go.mod 文件添加一个 需要外部模块的require指令，使用基于有关提交的详细信息的伪版本号。

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

当您的代码不再使用模块中的任何包时，您可以停止将该模块作为依赖项进行跟踪。

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

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

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

当您使用 Go 工具处理模块时，这些工具默认从 proxy.golang.org（一个公共的 Google 运行的模块镜像）或直接从模块的存储库下载模块。您可以指定 Go 工具应该使用另一个代理服务器来下载和验证模块。

如果您（或您的团队）已经设置或选择了您想要使用的不同模块代理服务器，您可能想要这样做。例如，有些人设置了模块代理服务器，以便更好地控制依赖项的使用方式。

要为 Go 工具指定另一个模块代理服务器，请将GOPROXY 环境变量设置为一个或多个服务器的 URL。Go 工具将按照您指定的顺序尝试每个 URL。默认情况下，GOPROXY首先指定一个公共的 Google 运行模块代理，然后从模块的存储库直接下载（在其模块路径中指定）：

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

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

GOPRIVATE或环境变量可以设置为匹配模块前缀的全局模式列表，这些GONOPROXY前缀是私有的，不应从任何代理请求。例如：

分享名称：go语言的go命令 go语言的方法
网页地址：http://pwwzsj.com/article/hjisid.html