这篇文章主要介绍“Golang中的flag标准库如何使用”，在日常操作中，相信很多人在Golang中的flag标准库如何使用问题上存在疑惑，小编查阅了各式资料，整理出简单好用的操作方法，希望对大家解答”Golang中的flag标准库如何使用”的疑惑有所帮助！接下来，请跟着小编一起来学习吧！

1.使用

1.1示例

flag 基本使用示例代码如下：

package main
import (
	"flag"
	"fmt"
)
type flagVal struct {
	val string
}
func (v *flagVal) String() string {
	return v.val
}
func (v *flagVal) Set(s string) error {
	v.val = s
	return nil
}
func main() {
	// 1. 使用 flag.Type() 返回  *int 类型命令行参数
	var nFlag = flag.Int("n", 1234, "help message for flag n")
	// 2. 使用 flag.TypeVar() 绑定命令行参数到 int 类型变量
	var flagvar int
	flag.IntVar(&flagvar, "flagvar", 1234, "help message for flagvar")
	// 3. 使用 flag.Var() 绑定命令行参数到实现了 flag.Value 接口的自定义类型变量
	val := flagVal{}
	flag.Var(&val, "val", "help message for val")
	// 解析命令行参数
	flag.Parse()
	fmt.Printf("nFlag: %d
", *nFlag)
	fmt.Printf("flagvar: %d
", flagvar)
	fmt.Printf("val: %+v
", val)
	fmt.Printf("NFlag: %v
", flag.NFlag()) // 返回已设置的命令行标志个数
	fmt.Printf("NArg: %v
", flag.NArg())   // 返回处理完标志后剩余的参数个数
	fmt.Printf("Args: %v
", flag.Args())   // 返回处理完标志后剩余的参数列表
	fmt.Printf("Arg(1): %v
", flag.Arg(1)) // 返回处理完标志后剩余的参数列表中第 i 项
}

可以通过指定

--help/-h

$ go run main.go -h
Usage of ./main:
-flagvar int
help message for flagvar (default 1234)
-n int
help message for flag n (default 1234)
-val value
help message for val

这个程序接收三个命令行参数：

• int

  类型的

  -flagvar

  ，默认值为

  2134

  。

• int

  类型的

  -n

  ，默认值为

  2134

  。

• value

  类型的

  -val

  ，无默认值。

我们可以将

-flagvar

-n

-val

flag

这三个参数在示例代码中，分别使用了三种不同形式来指定：

flag.Type()

-n

var nFlag = flag.Int("n", 1234, "help message for flag n")

flag.Int

func Int(name string, value int, usage string) *int

flag.Int

*int

除了使用

flag.Int

int

flag.String

string

flag.TypeVar()

-flagvar

flag.IntVar(&flagvar, "flagvar", 1234, "help message for flagvar")

flag.IntVar

func IntVar(p *int, name string, value int, usage string)

与

flag.Int

flag.IntVar

p *int

除了使用

flag.IntVar

int

flag.StringVar

string

flag.Var()

-val

flag.Var(&val, "val", "help message for val")

flag.Var

func Var(value Value, name string, usage string)

flag.Var

value

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

我们可以自定义类型，只要实现了

flag.Value

flag.Var

定义完三个标志，我们还需要使用

flag.Parse()

nFlag

flagvar

val

在

main

flag.NFlag()

flag.NArg()

flag.Args()

flag.Arg(1)

现在我们尝试给这个命令行程序传递几个参数并执行它，看下输出结果：

$ go run main.go -n 100 -val test a b c d
nFlag: 100
flagvar: 1234
val: {val:test}
NFlag: 2
NArg: 4
Args: [a b c d]
Arg(1): b

我们通过

-n 100

-n

100

nFlag

由于没有指定

flagvar

flagvar

1234

接着，我们又通过

-val test

-val

test

flagVal

val

因为只设置了

-n

-val

flag.NFlag()

a b c d

flag.NArg()

flag.Args()

a b c d

flag.Arg(1)

1

b

1.2标志类型

在上面的示例中，我们展示了

int

flag.Value

除了支持几种 Go 默认的原生类型外，如果我们想实现其他类型标志的定义，都可以通过

flag.Value

bool

int

flag.Value

1.3标志语法

命令行标志支持多种语法：

-

cmd -x *

flag 解析参数时会在第一个非标志参数之前（单独的一个

-

--

2.源码解读

注意：本文以 Go 1.19.4 源码为例，其他版本可能存在差异。

熟悉了 flag 包的基本使用，接下来我们就要深入到 flag 的源码，来探究其内部是如何实现。

阅读 flag 包的源码，我们可以从使用 flag 包的流程来入手。

2.1定义标志

在

main

-n

var nFlag = flag.Int("n", 1234, "help message for flag n")

flag.Int

func Int(name string, value int, usage string) *int {
	return CommandLine.Int(name, value, usage)
}

可以发现，

flag.Int

CommandLine

Int

来看看

CommandLine

var CommandLine = NewFlagSet(os.Args[0], ExitOnError)
func NewFlagSet(name string, errorHandling ErrorHandling) *FlagSet {
	f := &FlagSet{
		name:          name,
		errorHandling: errorHandling,
	}
	f.Usage = f.defaultUsage
	return f
}

CommandLine

NewFlagSet

FlagSet

FlagSet

os.Args[0]

ExitOnError

我们知道

os.Args

os.Args[0]

ExitOnError

error

ExitOnError

error

来看下

FlagSet

type FlagSet struct {
	Usage func()
	name          string
	parsed        bool
	actual        map[string]*Flag
	formal        map[string]*Flag
	args          []string // arguments after flags
	errorHandling ErrorHandling
	output        io.Writer // nil means stderr; use Output() accessor
}

Usage

--help/-h

parsed

flag.Parse()

actual

formal

map

Flag

FlagSet

Flag

args

errorHandling

error

output

--help/-h

现在来看下

Flag

type Flag struct {
	Name     string // 标志名称
	Usage    string // 帮助信息
	Value    Value  // 标志所对应的命令行参数值
	DefValue string // 用来记录字符串类型的默认值，它不会被改变
}

Flag

可以说

Flag

FlagSet

标志所对应的命令行参数值为

flag.Value

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

之所以使用接口，是为了能够存储任何类型的值，除了 flag 包默认支持的内置类型，用户也可以定义自己的类型，只要实现了

Value

如我们在前文示例程序中定义的

flagVal

现在

CommandLine

CommandLine

Int

func (f *FlagSet) Int(name string, value int, usage string) *int {
	p := new(int)
	f.IntVar(p, name, value, usage)
	return p
}

Int

f.IntVar()

func (f *FlagSet) IntVar(p *int, name string, value int, usage string) {
	f.Var(newIntValue(value, p), name, usage)
}

IntVar

f.Var()

Var

newIntValue(value, p)

newIntValue

type intValue int
func newIntValue(val int, p *int) *intValue {
	*p = val
	return (*intValue)(p)
}
func (i *intValue) Set(s string) error {
	v, err := strconv.ParseInt(s, 0, strconv.IntSize)
	if err != nil {
		err = numError(err)
	}
	*i = intValue(v)
	return err
}
func (i *intValue) Get() any { return int(*i) }
func (i *intValue) String() string { return strconv.Itoa(int(*i)) }

newIntValue

intValue

intValue

int

定义

intValue

flag.Value

再来看下

Var

func (f *FlagSet) Var(value Value, name string, usage string) {
	// Flag must not begin "-" or contain "=".
	if strings.HasPrefix(name, "-") {
		panic(f.sprintf("flag %q begins with -", name))
	} else if strings.Contains(name, "=") {
		panic(f.sprintf("flag %q contains =", name))
	}
	// Remember the default value as a string; it won't change.
	flag := &Flag{name, usage, value, value.String()}
	_, alreadythere := f.formal[name]
	if alreadythere {
		var msg string
		if f.name == "" {
			msg = f.sprintf("flag redefined: %s", name)
		} else {
			msg = f.sprintf("%s flag redefined: %s", f.name, name)
		}
		panic(msg) // Happens only if flags are declared with identical names
	}
	if f.formal == nil {
		f.formal = make(map[string]*Flag)
	}
	f.formal[name] = flag
}

name

Var

-

=

接着，根据参数创建了一个

Flag

最后将

Flag

formal

到这里，整个函数调用关系就结束了，我们来梳理一下代码执行流程：

flag.Int

CommandLine.Int

CommandLine.IntVar

CommandLine.Var

经过这个调用过程，我们就得到了一个

Flag

n

1234

intValue

help message for flag n

Flag

CommandLine

FlagSet

formal

我们在示例程序中还使用了另外两种方式定义标志。

使用

flag.IntVar(&flagvar, "flagvar", 1234, "help message for flagvar")

-flagvar

flag.IntVar

func IntVar(p *int, name string, value int, usage string) {
	CommandLine.Var(newIntValue(value, p), name, usage)
}

可以发现，

flag.IntVar

CommandLine.Int

CommandLine.IntVar

CommandLine.Var

另外，我们还使用

flag.Var(&val, "val", "help message for val")

-val

flag.Var

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

flag.Var

CommandLine.Var

value

Value

newIntValue

Value

2.2解析标志参数

命令行参数定义完成了，终于到了解析部分，可以使用

flag.Parse()

flag.Parse

func Parse() {
	CommandLine.Parse(os.Args[1:])
}

内部同样是调用

CommandLine

Parse

Parse

func (f *FlagSet) Parse(arguments []string) error {
	f.parsed = true
	f.args = arguments
	for {
		seen, err := f.parseOne()
		if seen {
			continue
		}
		if err == nil {
			break
		}
		switch f.errorHandling {
		case ContinueOnError:
			return err
		case ExitOnError:
			if err == ErrHelp {
				os.Exit(0)
			}
			os.Exit(2)
		case PanicOnError:
			panic(err)
		}
	}
	return nil
}

首先将

f.parsed

true

f.Parsed()

func (f *FlagSet) Parsed() bool {
	return f.parsed
}

接着又将

arguments

f.args

然后就是循环解析命令行参数的过程，每调用一次

f.parseOne()

error

parseOne

func (f *FlagSet) parseOne() (bool, error) {
	if len(f.args) == 0 {
		return false, nil
	}
	s := f.args[0]
	if len(s) < 2 || s[0] != '-' {
		return false, nil
	}
	numMinuses := 1
	if s[1] == '-' {
		numMinuses++
		if len(s) == 2 { // "--" terminates the flags
			f.args = f.args[1:]
			return false, nil
		}
	}
	name := s[numMinuses:]
	if len(name) == 0 || name[0] == '-' || name[0] == '=' {
		return false, f.failf("bad flag syntax: %s", s)
	}
	// it's a flag. does it have an argument?
	f.args = f.args[1:]
	hasValue := false
	value := ""
	for i := 1; i < len(name); i++ { // equals cannot be first
		if name[i] == '=' {
			value = name[i+1:]
			hasValue = true
			name = name[0:i]
			break
		}
	}
	m := f.formal
	flag, alreadythere := m[name] // BUG
	if !alreadythere {
		if name == "help" || name == "h" { // special case for nice help message.
			f.usage()
			return false, ErrHelp
		}
		return false, f.failf("flag provided but not defined: -%s", name)
	}
	if fv, ok := flag.Value.(boolFlag); ok && fv.IsBoolFlag() { // special case: doesn't need an arg
		if hasValue {
			if err := fv.Set(value); err != nil {
				return false, f.failf("invalid boolean value %q for -%s: %v", value, name, err)
			}
		} else {
			if err := fv.Set("true"); err != nil {
				return false, f.failf("invalid boolean flag %s: %v", name, err)
			}
		}
	} else {
		// It must have a value, which might be the next argument.
		if !hasValue && len(f.args) > 0 {
			// value is the next arg
			hasValue = true
			value, f.args = f.args[0], f.args[1:]
		}
		if !hasValue {
			return false, f.failf("flag needs an argument: -%s", name)
		}
		if err := flag.Value.Set(value); err != nil {
			return false, f.failf("invalid value %q for flag -%s: %v", value, name, err)
		}
	}
	if f.actual == nil {
		f.actual = make(map[string]*Flag)
	}
	f.actual[name] = flag
	return true, nil
}

parseOne

首先对

f.args

-

numMinuses

接下来取出参数

value

-help/-h

parseOne

ErrHelp

f.Parse

ErrHelp

os.Exit(0)

其中

f.usage()

最后就是根据参数值是否为

bool

f.actual

以上步骤都执行完成后，在执行

fmt.Printf("nFlag: %d
", *nFlag)

nFlag

至此，flag 包源码的整体脉络都已经清晰了。

2.3其他代码

在我们的示例代码最后，还打印了

NFlag()

NArg()

Args()

Arg(1)

这几个函数实现非常简单，代码如下：

func NFlag() int { return len(CommandLine.actual) }
func NArg() int { return len(CommandLine.args) }
func Args() []string { return CommandLine.args }
func Arg(i int) string {
	return CommandLine.Arg(i)
}

由于代码过于简单，我就不进行解释了，相信通过上面的讲解，这几个函数的作用你也能做到一目了然。

flag 包还有一些其他类型，如

stringValue

float64Value