Golang 标准命令行扩展：子命令插件库 cmd 使用指南

在 Go 语言中，标准库 flag 提供了基本的命令行参数解析功能，但对于复杂的命令行应用（特别是支持子命令的应用）来说可能不够灵活。cmd 并不是 Go 标准库的一部分，但我们可以使用标准库 flag 结合一些模式来实现子命令功能，或者使用第三方库如 cobra 或 urfave/cli。

使用标准库实现子命令

下面是一个使用标准库实现子命令的示例：

package main

import (
	"flag"
	"fmt"
	"os"
)

func main() {
	// 定义顶级命令
	addCmd := flag.NewFlagSet("add", flag.ExitOnError)
	listCmd := flag.NewFlagSet("list", flag.ExitOnError)

	// 检查子命令
	if len(os.Args) < 2 {
		fmt.Println("expected 'add' or 'list' subcommands")
		os.Exit(1)
	}

	switch os.Args[1] {
	case "add":
		// 为 add 命令定义标志
		addName := addCmd.String("name", "", "Name to add")
		addAge := addCmd.Int("age", 0, "Age of the person")
		addCmd.Parse(os.Args[2:])
		fmt.Printf("Adding %s, age %d\n", *addName, *addAge)
	case "list":
		// 为 list 命令定义标志
		listAll := listCmd.Bool("all", false, "List all items")
		listCmd.Parse(os.Args[2:])
		if *listAll {
			fmt.Println("Listing all items")
		} else {
			fmt.Println("Listing recent items")
		}
	default:
		fmt.Println("expected 'add' or 'list' subcommands")
		os.Exit(1)
	}
}

使用第三方库 cobra

cobra 是一个流行的 Go 命令行库，广泛用于 Kubernetes、Docker 等知名项目。

安装 cobra

go get -u github.com/spf13/cobra/cobra

示例代码

package main

import (
	"fmt"
	"github.com/spf13/cobra"
	"os"
)

func main() {
	// 根命令
	var rootCmd = &cobra.Command{
		Use:   "myapp",
		Short: "My application is a demo for cobra",
		Long:  `A longer description of my application that spans multiple lines`,
		Run: func(cmd *cobra.Command, args []string) {
			fmt.Println("Hello from the root command")
		},
	}

	// 添加子命令
	var addCmd = &cobra.Command{
		Use:   "add",
		Short: "Add a new item",
		Long:  `Add a new item to the list`,
		Run: func(cmd *cobra.Command, args []string) {
			name, _ := cmd.Flags().GetString("name")
			age, _ := cmd.Flags().GetInt("age")
			fmt.Printf("Adding %s, age %d\n", name, age)
		},
	}

	// 为 add 命令添加标志
	addCmd.Flags().StringP("name", "n", "", "Name of the item")
	addCmd.Flags().IntP("age", "a", 0, "Age of the person")
	addCmd.MarkFlagRequired("name")

	// list 子命令
	var listCmd = &cobra.Command{
		Use:   "list",
		Short: "List all items",
		Run: func(cmd *cobra.Command, args []string) {
			all, _ := cmd.Flags().GetBool("all")
			if all {
				fmt.Println("Listing all items")
			} else {
				fmt.Println("Listing recent items")
			}
		},
	}

	listCmd.Flags().BoolP("all", "a", false, "List all items")

	// 将子命令添加到根命令
	rootCmd.AddCommand(addCmd, listCmd)

	// 执行命令
	if err := rootCmd.Execute(); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}
}

使用 urfave/cli 库

urfave/cli (原 codegangsta/cli) 是另一个流行的 Go 命令行库。

安装 cli

go get -u github.com/urfave/cli/v2

示例代码

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/urfave/cli/v2"
)

func main() {
	app := &cli.App{
		Name:  "myapp",
		Usage: "demonstrate subcommands",
		Commands: []*cli.Command{
			{
				Name:    "add",
				Aliases: []string{"a"},
				Usage:   "add a new item",
				Flags: []cli.Flag{
					&cli.StringFlag{
						Name:     "name",
						Aliases:  []string{"n"},
						Usage:    "name of the item",
						Required: true,
					},
					&cli.IntFlag{
						Name:    "age",
						Aliases: []string{"a"},
						Usage:   "age of the person",
						Value:   0,
					},
				},
				Action: func(c *cli.Context) error {
					fmt.Printf("Adding %s, age %d\n", c.String("name"), c.Int("age"))
					return nil
				},
			},
			{
				Name:    "list",
				Aliases: []string{"l"},
				Usage:   "list items",
				Flags: []cli.Flag{
					&cli.BoolFlag{
						Name:    "all",
						Aliases: []string{"a"},
						Usage:   "list all items",
						Value:   false,
					},
				},
				Action: func(c *cli.Context) error {
					if c.Bool("all") {
						fmt.Println("Listing all items")
					} else {
						fmt.Println("Listing recent items")
					}
					return nil
				},
			},
		},
	}

	err := app.Run(os.Args)
	if err != nil {
		log.Fatal(err)
	}
}

总结

1. 标准库 flag：适合简单场景，需要手动处理子命令逻辑
2. cobra：功能强大，适合复杂命令行应用，支持自动生成帮助文档、bash 补全等
3. urfave/cli：API 简洁，适合快速开发中等复杂度的命令行应用

对于大多数项目，推荐使用 cobra 或 urfave/cli，它们提供了更丰富的功能和更好的开发体验。