Goopt: 基于结构体标签的声明式Golang CLI框架

Goopt是一个轻量级的Golang命令行工具框架，它利用结构体标签实现声明式的命令行参数定义，让开发者能够快速构建CLI应用。

基本使用

安装

go get github.com/kballard/goopt

基本示例

package main

import (
	"fmt"
	"github.com/kballard/goopt"
)

type Options struct {
	Name    string `goopt:"-n --name 姓名"`
	Age     int    `goopt:"-a --age 年龄"`
	Verbose bool   `goopt:"-v --verbose 显示详细信息"`
}

func main() {
	opts := &Options{}
	goopt.Parse(opts)
	
	fmt.Printf("姓名: %s\n", opts.Name)
	fmt.Printf("年龄: %d\n", opts.Age)
	fmt.Printf("详细模式: %v\n", opts.Verbose)
}

结构体标签语法

Goopt使用结构体标签定义命令行参数：

`goopt:"[短选项] [长选项] [描述] [默认值]"`

• 短选项：单个字母，前面加-，如-n
• 长选项：多个字母，前面加--，如--name
• 描述：参数的帮助信息
• 默认值：可选，格式为default=值

标签示例

type Config struct {
	Host     string `goopt:"-h --host 服务器地址 default=localhost"`
	Port     int    `goopt:"-p --port 端口号 default=8080"`
	Debug    bool   `goopt:"-d --debug 调试模式"`
	Timeout  int    `goopt:"--timeout 超时时间(秒)"`
}

高级功能

必需参数

type RequiredOptions struct {
	Input  string `goopt:"-i --input 输入文件 required"`
	Output string `goopt:"-o --output 输出文件 required"`
}

枚举值

type EnumOptions struct {
	LogLevel string `goopt:"-l --level 日志级别 [debug|info|warn|error] default=info"`
}

子命令

type Command struct {
	Init    *InitCommand    `goopt:"init 初始化"`
	Build   *BuildCommand   `goopt:"build 构建项目"`
	Version *VersionCommand `goopt:"version 显示版本"`
}

type InitCommand struct {
	Force bool `goopt:"-f --force 强制初始化"`
}

type BuildCommand struct {
	Output string `goopt:"-o --output 输出文件"`
}

type VersionCommand struct {
	Verbose bool `goopt:"-v --verbose 详细信息"`
}

func main() {
	cmd := &Command{}
	goopt.Parse(cmd)
	
	if cmd.Init != nil {
		fmt.Println("执行初始化命令", cmd.Init.Force)
	} else if cmd.Build != nil {
		fmt.Println("执行构建命令", cmd.Build.Output)
	} else if cmd.Version != nil {
		fmt.Println("显示版本信息", cmd.Version.Verbose)
	} else {
		goopt.Usage()
	}
}

自定义帮助信息

func main() {
	goopt.Description = "这是一个示例程序"
	goopt.Version = "1.0.0"
	goopt.Author = "Your Name"
	
	opts := &Options{}
	goopt.Parse(opts)
	
	// 程序逻辑...
}

验证参数

type ValidatedOptions struct {
	Port int `goopt:"-p --port 端口号"`
}

func (o *ValidatedOptions) Validate() error {
	if o.Port < 1 || o.Port > 65535 {
		return fmt.Errorf("端口号必须在1-65535之间")
	}
	return nil
}

func main() {
	opts := &ValidatedOptions{}
	goopt.Parse(opts)
	
	if err := opts.Validate(); err != nil {
		fmt.Println("参数错误:", err)
		goopt.Usage()
		return
	}
	
	// 程序逻辑...
}

总结

Goopt通过结构体标签提供了一种简洁的方式来定义命令行参数，主要特点包括：

1. 声明式参数定义
2. 支持短选项和长选项
3. 自动生成帮助信息
4. 支持子命令
5. 内置参数验证

这种基于结构体的方式使得CLI应用的开发更加直观和类型安全，适合中小型命令行工具的开发。