golang 包之flag包

在golang中有很多方法来处理命令行参数，简单情况下可以不使用任何库，直接使用os.Args；但是golang标准库提供了flag包来处理命令行参数；还有第三方提供的处理命令行参数的库cobra、cli。

flag包绑定解析参数有三种定义方式
flag.xxx() 例如：flag.Int, flag.String, 返回解析变量类型的指针

package main

import (
    "flag"
    "fmt"
)

func main() {
    host := flag.String("host", "127.0.0.1", "请输入host地址")
    port := flag.Int("port", 3306, "请输入端口号")
    flag.Parse() // 解析参数
    fmt.Printf("%s:%d\n", *host, *port)
}

执行: go run main.go -host=127.0.0.1 -port=3306
输出：127.0.0.1:3306
当然你也可以直接执行go run main.go, 这时候就会使用你的默认值

flag.XxxVar() 例如：flag.IntVar, flag.StringVar

package main

import (
    "flag"
    "fmt"
)
var host string
var port int

func init() { // 每个文件会自动执行的函数
    flag.StringVar(&host, "host", "127.0.0.1", "请输入host地址")
    flag.IntVar(&port, "port", 3306, "请输入端口号")
}

func main() {
    flag.Parse() // 解析参数
    fmt.Printf("%s:%d\n", host, port)
}

两个flag共享同一个变量，一般用于同时实现完整flag参数和对应简化版flag参数，需要注意初始化顺序和默认值

var gopherType string

func init() {
  const (
    defaultGopher = "pocket"
    usage         = "the variety of gopher"
  )
  flag.StringVar(&gopherType, "gopher_type", defaultGopher, usage)
  flag.StringVar(&gopherType, "g", defaultGopher, usage+"(shorthand)")
}

执行结果同上

3.自定义参数解析flag.Var(), 我们可以看下flag.go源码:

func Var(value Value, name string, usage string) {
CommandLine.Var(value, name, usage)
}

type Value interface {
String() string
Set(string) error
}


使用flag.Var函数第一个参数我们需要传入一个Value类型的值，Value是一个接口类型，定义了两个方法，接下来我们去实现这两个方法：

package main

import (
    "flag"
    "fmt"
    "strings"
)

// 自定义类型
type HandsomeBoys []string

// 实现String()方法
func (h *HandsomeBoys) String() string {
    return fmt.Sprintf("%v", *h)
}

// 实现Set方法,Set接口决定了如何解析flag的值
func (h *HandsomeBoys) Set(s string) error {
    for _, v := range strings.Split(s, ",") {
        *h = append(*h, v)
    }
    return nil
}

// 定义一个HandsomeBoys类型的变量
var boys HandsomeBoys

func init() {
    // 绑定变量boys
    flag.Var(&boys, "boys", "请输入一组帅气的男孩名称：-boys=彭于晏,吴彦祖")
}

func main() {
    flag.Parse()
    fmt.Println(boys)
}

首先需要理解FlagSet的概念，FlagSet的官方定义如下：

A FlagSet represents a set of defined flags.

直译就是FlagSet代表一个flag的集合。

在具备FlagSet概念之后，我们再来回顾Flag的使用。

• 设置阶段，就是往FlagSet中插入一条flag记录，返回一个指向flag所代表的值的指针，flag记录中包括默认值，flag名称，用法；
• 解析阶段，根据程序实际运行时参数的指定，覆盖默认值；
• 使用阶段，根据设置阶段返回的指针，来获取flag的值。

参考链接：https://blog.csdn.net/weixin_42278305/article/details/110133125