Golang实现POSIX/GNU风格命令行参数解析插件库pflag的使用

pflag是Go语言flag包的一个替代品，实现了POSIX/GNU风格的--flags命令行参数解析。

安装

使用标准go get命令安装pflag：

go get github.com/spf13/pflag

运行测试：

go test github.com/spf13/pflag

使用

pflag可以作为Go原生flag包的替代品。如果你以"flag"名称导入pflag，那么所有代码无需更改即可继续工作。

import flag "github.com/spf13/pflag"

定义标志

使用flag.String(), Bool(), Int()等函数定义标志。

// 定义一个整数标志-flagname，存储在指针ip中，类型为*int
var ip *int = flag.Int("flagname", 1234, "help message for flagname")

或者你可以使用Var()函数将标志绑定到变量：

var flagvar int
func init() {
    flag.IntVar(&flagvar, "flagname", 1234, "help message for flagname")
}

对于自定义标志，你可以实现Value接口(使用指针接收器)，并通过以下方式将其与标志解析耦合：

flag.Var(&flagVal, "name", "help message for flagname")

解析标志

在所有标志定义后调用：

flag.Parse()

将命令行参数解析到已定义的标志中。

使用标志

标志可以直接使用。如果你使用标志本身，它们都是指针；如果你绑定到变量，它们是值。

fmt.Println("ip has value ", *ip)
fmt.Println("flagvar has value ", flagvar)

简写标志

pflag定义了一些新的函数，这些函数不在flag包中，它们为标志提供单字母简写。你可以通过在定义标志的任何函数名称后附加’P’来使用这些函数。

var ip = flag.IntP("flagname", "f", 1234, "help message")
var flagvar bool
func init() {
    flag.BoolVarP(&flagvar, "boolname", "b", true, "help message")
}
flag.VarP(&flagVal, "varname", "v", "help message")

完整示例

package main

import (
    "fmt"
    "github.com/spf13/pflag"
)

var (
    port     = pflag.IntP("port", "p", 8080, "server port")
    enable   = pflag.BoolP("enable", "e", false, "enable server")
    name     = pflag.StringP("name", "n", "default", "server name")
    timeout  = pflag.DurationP("timeout", "t", 30*time.Second, "connection timeout")
)

func main() {
    pflag.Parse()
    
    fmt.Printf("Server Configuration:\n")
    fmt.Printf("  Port: %d\n", *port)
    fmt.Printf("  Enable: %v\n", *enable)
    fmt.Printf("  Name: %s\n", *name)
    fmt.Printf("  Timeout: %v\n", *timeout)
    
    // 获取非标志参数
    fmt.Printf("Arguments: %v\n", pflag.Args())
}

运行示例：

go run main.go --port=9090 -e --name=test --timeout=1m arg1 arg2

其他功能

设置无选项默认值

var ip = flag.IntP("flagname", "f", 1234, "help message")
flag.Lookup("flagname").NoOptDefVal = "4321"

标志名称规范化

func wordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
    from := []string{"-", "_"}
    to := "."
    for _, sep := range from {
        name = strings.Replace(name, sep, to, -1)
    }
    return pflag.NormalizedName(name)
}

myFlagSet.SetNormalizeFunc(wordSepNormalizeFunc)

弃用标志

// 弃用一个标志
flags.MarkDeprecated("badflag", "please use --good-flag instead")

// 弃用一个标志的简写
flags.MarkShorthandDeprecated("noshorthandflag", "please use --noshorthandflag only")

隐藏标志

// 隐藏一个标志
flags.MarkHidden("secretFlag")

禁用标志排序

flags.BoolP("verbose", "v", false, "verbose output")
flags.String("coolflag", "yeaah", "it's really cool flag")
flags.Int("usefulflag", 777, "sometimes it's very useful")
flags.SortFlags = false
flags.PrintDefaults()

支持Go标志

import (
    goflag "flag"
    flag "github.com/spf13/pflag"
)

var ip *int = flag.Int("flagname", 1234, "help message for flagname")

func main() {
    flag.CommandLine.AddGoFlagSet(goflag.CommandLine)
    flag.Parse()
}

pflag提供了丰富的功能来解析命令行参数，支持POSIX/GNU风格的标志语法，是构建命令行工具的强力助手。