Golang命令行参数解析库Flaggy使用指南

Flaggy是一个强大且符合Go语言习惯的命令行参数解析库，它提供了比标准库flag更丰富的功能，同时保持了简单易用的特点。

Flaggy主要特性

1. 支持子命令(subcommands)
2. 自动生成帮助信息
3. 支持位置参数
4. 支持必选参数
5. 支持参数验证
6. 支持默认值设置

基本用法示例

package main

import (
	"fmt"
	"github.com/integrii/flaggy"
)

func main() {
	// 创建一个新的Flaggy实例
	flaggy.SetName("MyApp")
	flaggy.SetDescription("A simple application to demonstrate flaggy usage")
	flaggy.SetVersion("1.0.0")

	// 添加全局选项
	var verbose bool
	flaggy.Bool(&verbose, "v", "verbose", "Enable verbose output")

	// 添加位置参数
	var inputFile string
	flaggy.AddPositionalValue(&inputFile, "input", 1, true, "Input file to process")

	// 解析参数
	flaggy.Parse()

	// 使用参数
	fmt.Printf("Verbose mode: %v\n", verbose)
	fmt.Printf("Input file: %s\n", inputFile)
}

子命令支持

Flaggy对子命令的支持非常出色：

package main

import (
	"fmt"
	"github.com/integrii/flaggy"
)

func main() {
	// 创建主命令
	flaggy.SetName("MyApp")
	flaggy.SetDescription("A CLI with subcommands")

	// 创建子命令
	createCmd := flaggy.NewSubcommand("create")
	createCmd.Description = "Create a new resource"
	
	var createName string
	createCmd.String(&createName, "n", "name", "Name of the resource to create")

	// 另一个子命令
	deleteCmd := flaggy.NewSubcommand("delete")
	deleteCmd.Description = "Delete a resource"
	
	var forceDelete bool
	deleteCmd.Bool(&forceDelete, "f", "force", "Force deletion without confirmation")

	// 添加子命令
	flaggy.AttachSubcommand(createCmd, 1)
	flaggy.AttachSubcommand(deleteCmd, 1)

	// 解析参数
	flaggy.Parse()

	// 根据子命令执行不同逻辑
	switch {
	case createCmd.Used:
		fmt.Printf("Creating resource with name: %s\n", createName)
	case deleteCmd.Used:
		fmt.Printf("Deleting resource (force=%v)\n", forceDelete)
	default:
		flaggy.ShowHelpAndExit("No command specified")
	}
}

高级特性

参数验证

var port int
flaggy.Int(&port, "p", "port", "Port number")
flaggy.DefaultPort = 8080

// 自定义验证函数
flaggy.AddValidator("port", func(val interface{}) error {
    p := val.(int)
    if p < 1 || p > 65535 {
        return fmt.Errorf("port must be between 1 and 65535")
    }
    return nil
})

必选参数

var requiredOption string
flaggy.String(&requiredOption, "r", "required", "This option is required")
flaggy.SetRequired("required")

默认值

var timeout int
flaggy.Int(&timeout, "t", "timeout", "Operation timeout in seconds")
flaggy.DefaultTimeout = 30

帮助信息定制

Flaggy允许你自定义帮助信息：

flaggy.SetHelpTemplate(`{{.ShortDescription}}

Usage:
  {{.CommandPath}} [flags] [subcommand] [args]

Subcommands:{{range .Subcommands}}
  {{.Name}}{{ "\t" }}{{.Description}}{{end}}

Flags:
{{.Flags}}
`)

最佳实践

1. 清晰的命令结构：合理组织子命令，使CLI直观易用
2. 详细的帮助信息：为每个命令和选项提供有意义的描述
3. 参数验证：尽早验证输入，提供友好的错误信息
4. 默认值：为常用选项设置合理的默认值
5. 必选参数：明确标记必选参数，避免运行时错误

Flaggy通过其简洁的API和强大的功能，成为了Go语言中处理命令行参数的一个优秀选择，特别适合需要子命令支持的复杂CLI应用程序。