概述

在运行命令行程序时，通常需要通过命令行参数对程序的运行进行配置。在 Go 语言中，可以使用 flag 包来快速构建命令行程序。对于程序的使用者而言，只需声明所需的命令行参数即可。

使用示例

创建命令行程序的过程可以分为两个步骤：

1. 声明命令行参数
2. 运行 flag.Parse：对参数进行解析

解析完成后，就可以读取命令行参数了。以下示例展示了如何创建一个简单的命令行程序，允许用户通过 --foo 和 --bar 参数传递值：

package main

import (
    "flag"
    "fmt"
)

func main() {
    foo := flag.String("foo", "", "Foo description")
    bar := flag.String("bar", "", "Bar description")

    flag.Parse()
    fmt.Println("foo:", *foo)
    fmt.Println("bar:", *bar)
}

例如，运行 demo --foo hello --bar world 会输出：

foo: hello
bar: world

VarXXX 和 XXX

flag 包中提供了两类用于声明命令行参数的函数。以 String 类型为例，下面是两个函数的声明：

func String(name string, value string, usage string) *string
func StringVar(p *string, name string, value string, usage string)

• String 函数接收三个参数：

  • name：命令行参数名，即 --<name>
  • value：参数的默认值
  • usage：参数描述，会在帮助信息中显示
  • 返回值：一个指向参数值的指针

• StringVar 与 String 的区别在于，它将返回值改为函数参数，即直接将解析结果存入提供的变量指针中。

除了 String 类型外，flag 包还提供了多个类似的函数用于解析不同类型的参数，这些函数的名称可以通过替换类型名称来得到，例如：

• Int，Int64，Uint
• Bool
• Float
• Duration

其他

上述内容涵盖了使用 flag 包的大部分功能。flag 包中还提供了一些函数，可以直接对其底层实现进行操作，但在普通命令行程序中不常用。

在实际使用中，建议将参数声明部分放到 var 代码段中，以便结构更清晰，易于维护。修改后的代码如下所示：

package main

import (
    "flag"
    "fmt"
)

var (
    foo = flag.String("foo", "", "Foo description")
    bar = flag.String("bar", "", "Bar description")
)

func main() {
    flag.Parse()
    fmt.Println("foo:", *foo)
    fmt.Println("bar:", *bar)
}

这种组织方式更符合 Go 代码的惯例，使参数的定义和使用更加清晰明了。

这样，通过 flag 包，你可以轻松地为 Go 程序添加命令行参数支持，从而使你的程序更具灵活性和可配置性。