对子命令进行分组：利用 go_flags 包的分组功能

**文章首段摘要** 在使用 go-flags 包时，可以使用分组功能对子命令进行分类。默认情况下，分组应用于子命令中的选项，而不是子命令本身。通过将子命令拆分为单独的包并使用 AddCommand 函数，可以将分组应用于子命令。这种方法允许在帮助消息中以分组方式清晰地显示子命令，从而提高可用性和可理解性。

我正在使用 https://github.com/jessevdk/go-flags 并尝试使用结构字段中的顶级选项“group”对子命令进行分组。但它实际上不是对子命令进行分组，而是对子命令中的选项进行分组。这是我的代码：

type Cmd1 struct {
    Opt1         string `long:"opt1" description:"first opt" required:"true"`
    Opt2         int    `long:"opt2" description:"second opt" default:"10"`
}

type Cmd2 struct {
    OptA string `long:"optA" description:"opt a" default:":8080"`
    OptB string `long:"optB" description:"opt b" default:"debug"`
}

type MainCmd struct {
    Cmd1      Cmd1      `group:"group1" namespace:"group1" env-namespace:"group1"`
    Cmd2     Cmd2     `group:"group2" namespace:"group2" env-namespace:"group2"`
}

func main() {
    var mainCmd MainCmd
    parser := flags.NewParser(&mainCmd, flags.Default) 
    if _, err := parser.Parse(); err != nil {
        if err, ok := err.(*flags.Error); ok {
            if err.Type == flags.ErrHelp {
                os.Exit(0)
            }
            parser.WriteHelp(os.Stdout)
        }
        os.Exit(1)
    }
}

我正在寻找的是当我运行主函数时，它将使用分组的子命令打印帮助消息，例如：

组1： --命令1 组2： --命令2

但是它对子命令的选项进行分组，例如：

组1： --group1.opt1= --group1.opt2= 组2： --group2.opta= --group2.optb=

有什么想法或帮助吗？谢谢！

正确答案

您可以使用函数addcommand，也可以将包group1和group2分开，以便更好地分类。

代码：

package main

import (
    "fmt"
    "os"

    "github.com/jessevdk/go-flags"
)

// package group 1
type Group1 struct {
    Opt1 string `long:"opt1" description:"first opt" required:"true"`
    Opt2 int    `long:"opt2" description:"second opt" default:"10"`
}

var group1Command Group1
var group1 = "group1"

func (g *Group1) Execute(args []string) error {
    fmt.Printf("Option (opt1=%v, opt2=%v): \n", g.Opt1, g.Opt2)
    return nil
}

// package group 2
type Group2 struct {
    OptA string `long:"optA" description:"opt a" default:":8080"`
    OptB string `long:"optB" description:"opt b" default:"debug"`
}

var group2Command Group2
var group2 = "group2"

func (g *Group2) Execute(args []string) error {
    fmt.Printf("Option (opt1=%v, opt2=%v): \n", g.OptA, g.OptB)
    return nil
}

var parser = flags.NewParser(nil, flags.Default)

func init() {
    parser.AddCommand(group1,
        "Group 1 summary",
        "Long description of group 1",
        &group1Command)

    parser.AddCommand(group2,
        "Group 2 summary",
        "Long description of group 2",
        &group2Command)
}

func main() {
    if _, err := parser.Parse(); err != nil {
        switch flagsErr := err.(type) {
        case flags.ErrorType:
            if flagsErr == flags.ErrHelp {
                os.Exit(0)
            }
            os.Exit(1)
        default:
            os.Exit(1)
        }
    }
}

结果

进一步阅读

Docs

本篇关于《对子命令进行分组：利用 go_flags 包的分组功能》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于Golang的相关知识，请关注golang学习网公众号！