golang命令行参数解析插件库getopt的使用

简介

getopt包提供了一个零依赖的Go实现，用于解析Unix风格的命令行选项。它支持POSIX约定，包括短选项(如-a)和选项参数，同时也支持GNU扩展，如长选项(如--option)、可选参数和重新排列非选项参数。

安装

go get github.com/jonathonwebb/getopt

使用示例

基本用法

package main

import (
	"fmt"
	"os"
	"github.com/jonathonwebb/getopt"
)

func main() {
	// 创建新的解析状态
	state := getopt.NewState(os.Args)
	
	// 配置选项字符串：
	// a - 无参数选项
	// b: - 必须带参数的选项
	// c:: - 可选参数的选项
	config := getopt.Config{Opts: getopt.OptStr(`ab:c::`)}
	
	// 解析所有选项
	opts, err := state.Parse(config)
	if err != nil {
		fmt.Printf("Error parsing options: %v\n", err)
		return
	}
	
	// 处理解析结果
	for _, opt := range opts {
		switch opt.Char {
		case 'a':
			fmt.Println("Found option a")
		case 'b':
			fmt.Printf("Found option b with argument: %s\n", opt.OptArg)
		case 'c':
			if opt.OptArg != "" {
				fmt.Printf("Found option c with argument: %s\n", opt.OptArg)
			} else {
				fmt.Println("Found option c without argument")
			}
		}
	}
}

迭代式解析

package main

import (
	"fmt"
	"os"
	"github.com/jonathonwebb/getopt"
)

func main() {
	state := getopt.NewState(os.Args)
	config := getopt.Config{Opts: getopt.OptStr(`ab:c::`)}

	// 逐个解析选项
	for opt, err := range state.All(config) {
		if err != nil {
			fmt.Printf("Error: %v\n", err)
			break
		}
		
		switch opt.Char {
		case 'a':
			fmt.Println("Found option a")
		case 'b':
			fmt.Printf("Found option b with argument: %s\n", opt.OptArg)
		case 'c':
			if opt.OptArg != "" {
				fmt.Printf("Found option c with argument: %s\n", opt.OptArg)
			} else {
				fmt.Println("Found option c without argument")
			}
		}
	}
}

行为模式

getopt支持多种解析模式：

• ModeGNU: 启用默认行为(GNU风格)
• ModePosix: 启用POSIX兼容模式，禁用参数重新排列并在第一个非选项参数处停止解析
• ModeInOrder: 按顺序处理所有参数

功能选项

可以配置不同的解析函数：

• FuncGetOpt: 仅解析传统的POSIX短选项(如-a)
• FuncGetOptLong: 解析短选项和GNU扩展的长选项(如--option)
• FuncGetOptLongOnly: 解析短选项和长选项，但允许长选项以单破折号开头

注意事项

与GNU libc的getopt相比，此包有以下不同：

1. 接受短选项和长选项定义中的多字节字符
2. 不实现与GNU libc完全相同的参数重新排列

完整示例

下面是一个完整的示例，展示如何使用getopt解析命令行参数：

package main

import (
	"fmt"
	"os"
	"github.com/jonathonwebb/getopt"
)

func main() {
	// 定义长选项
	longOpts := []getopt.LongOpt{
		{Name: "help", HasArg: getopt.NoArgument, Val: 'h'},
		{Name: "version", HasArg: getopt.NoArgument, Val: 'v'},
		{Name: "output", HasArg: getopt.RequiredArgument, Val: 'o'},
		{Name: "verbose", HasArg: getopt.OptionalArgument, Val: 'V'},
	}

	// 创建解析状态
	state := getopt.NewState(os.Args)
	
	// 配置解析选项
	config := getopt.Config{
		Opts:    getopt.OptStr("hvo::V::"), // 短选项
		LongOpt: longOpts,                  // 长选项
		Mode:    getopt.ModeGNU,            // GNU模式
		Func:    getopt.FuncGetOptLong,     // 启用长选项解析
	}

	// 解析选项
	for opt, err := range state.All(config) {
		if err != nil {
			fmt.Printf("Error: %v\n", err)
			continue
		}

		switch opt.Char {
		case 'h':
			fmt.Println("Help message")
		case 'v':
			fmt.Println("Version 1.0.0")
		case 'o':
			fmt.Printf("Output file: %s\n", opt.OptArg)
		case 'V':
			if opt.OptArg != "" {
				fmt.Printf("Verbose level: %s\n", opt.OptArg)
			} else {
				fmt.Println("Verbose mode enabled")
			}
		default:
			fmt.Printf("Unknown option: %c\n", opt.Char)
		}
	}

	// 处理剩余的非选项参数
	args := state.Args()
	if len(args) > 0 {
		fmt.Println("Non-option arguments:")
		for _, arg := range args {
			fmt.Printf("- %s\n", arg)
		}
	}
}

这个示例展示了如何同时使用短选项和长选项，并处理可选和必需的参数。