将 cobra 子命令源代码放入独立文件夹的方法

最近发现不少小伙伴都对Golang很感兴趣，所以今天继续给大家介绍Golang相关的知识，本文《将 cobra 子命令源代码放入独立文件夹的方法》主要内容涉及到等等知识点，希望能帮到你！当然如果阅读本文时存在不同想法，可以在评论中表达，但是请勿使用过激的措辞~

我是 go 初学者，我正在尝试使用 cobra 创建 cli。为了引导该项目，我使用了 cobra generator，生成了一个命令、一个子命令，一切正常。

我现在有这种类型的布局：

cli
├── cmd
│   ├── command.go
│   ├── root.go
│   ├── subcommand.go
├── go.mod
├── go.sum
└── main.go

这不适合我，假设我的项目打算有很多命令，或者很多命令命名空间，每个命令都由不同的团队拥有，它会变得非常混乱并且难以维护。我更喜欢这样的布局：

cli
├── cmd
│   ├── command
│   │   ├── command.go
│   │   └── subcommand.go
│   └── root.go
├── go.mod
├── go.sum
└── main.go

现在，我对 go 中如何完成包和导入的方式缺乏一些了解（即使在阅读了这里和那里的文档之后），但据我所知，只要满足以下条件，就可以跨多个 go 源文件访问资源它们属于同一个包。但正如文档中所述，“实现可能要求包的所有源文件都位于同一目录中。”，因此要实现我想要的布局，我需要有多个包，例如每个命令命名空间都有一个，我认为这很好（或者至少，我不明白这样做有什么问题）。这就是我尝试过的：

• 在 cmd 目录中创建一个 command 目录
• 将 command.go 文件移至 command 目录内
• 将 package 子句从 command.go 文件更改为 command
• 对 subcommand.go 执行相同的操作

这构建得很好，但是找不到命令（error：“cli” 的未知命令“command”）。我以为是因为我从来没有导入过那个新的command包，所以我把它导入到main.go文件中，其中导入了cmd包。

构建失败，告诉我 undefined: rootcmd 在 command.go 文件中。我猜测command包无法看到cmd中的资源，所以我在command.go文件中导入了cmd包，并将rootcmd替换为cmd.rootcmd （rootcmd 是在 cli/cmd/root.txt 文件中创建的变量） go 文件，cobra 生成器提供的文件的一部分）。这次我确实抱有希望，但结果还是一样（undefined: cmd.rootcmd），现在我迷失了。

我是否正在尝试做一些 cobra 做不到的事情？

我是否正在尝试做一些可以用 cobra 实现但不使用 cobra 生成器的事情？

我是否试图做一些根本不应该做的事情（比如 go 试图保护我免受不良设计的影响）？

如果没有，我该如何进行？

正确答案

您无法使用 cobra-cli 命令获得所需的布局，但您当然可以手动进行设置。让我们从 cobra-cli 布局开始：

$ go mod init example
$ cobra-cli init

并添加几个命令：

$ cobra-cli add foo
$ cobra-cli add bar

这让我们：

.
├── cmd
│   ├── bar.go
│   ├── foo.go
│   └── root.go
├── go.mod
├── go.sum
├── license
└── main.go

让我们首先将命令移动到子目录中，这样我们就有了所需的布局。这让我们：

.
├── cmd
│   ├── bar
│   │   └── bar.go
│   ├── foo
│   │   └── foo.go
│   └── root.go
├── go.mod
├── go.sum
├── license
└── main.go

现在我们需要对代码进行一些更改才能使其正常工作。

1. 由于我们的子命令现在位于单独的包中，因此我们需要重命名 rootcmd 以便可以导出。

   find cmd -name '*.go' -print | xargs sed -i 's/rootcmd/rootcmd/g'

2. 我们需要每个子命令都位于自己的包中，因此我们将 cmd/foo/foo.go 顶部的 package cmd 替换为 package foo，并替换为 cmd/bar/bar 中的 package bar。 go。

3. 我们需要子命令来导入根命令，以便它们可以调用 rootcmd.addcommand。这意味着在 cmd/foo/foo.go 和 cmd/bar/bar.go 中，我们需要将 example/cmd 添加到 import 部分（回想一下，我们通过 go mod init 命名了顶级包 example命令）。这意味着每个文件将以：

   package foo
   
   import (
           "fmt"
   
           "example/cmd"
           "github.com/spf13/cobra"
   )

   作为此更改的一部分，我们还需要更新对 addcommand 的引用以使用显式包名称：

   func init() {
     cmd.rootcmd.addcommand(foocmd)
   }

4. 最后，我们需要将子命令导入到某个地方。现在，我们从不导入 foo 或 bar 包，因此代码实际上是不可见的（尝试在这些文件之一中引入严重的语法错误 - 您将看到 go build 将成功，因为这些文件在任何地方都没有引用）。

   我们可以在顶级 main.go 文件中执行此操作：

   package main
   
   import (
     "example/cmd"
     _ "example/cmd/bar"
     _ "example/cmd/foo"
   )
   
   func main() {
     cmd.execute()
   }

现在，如果我们构建并运行代码，我们会看到 foo 和 bar 命令可用：

$ go build
$ ./example
A longer description that spans multiple lines and likely contains
examples and usage of using your application. For example:

Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.

Usage:
  example [command]

Available Commands:
  bar         A brief description of your command
  completion  Generate the autocompletion script for the specified shell
  foo         A brief description of your command
  help        Help about any command

Flags:
  -h, --help     help for example
  -t, --toggle   Help message for toggle

Use "example [command] --help" for more information about a command.

今天关于《将 cobra 子命令源代码放入独立文件夹的方法》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！