golang flag 用法-Golang-PHP中文网

golang flag 用法

PHPz

发布： 2023-05-21 18:35:07

原创

1462 人浏览过

golang中的flag包提供了一种简单的方式来处理命令行参数。通过使用flag包，我们可以在运行Go程序时轻松地传递和处理各种指令。本篇文章将介绍flag包的用法及其实现方式。

golang flag包概述

flag包提供了处理命令行参数的功能。该包的目的是为Go语言提供一个简单而优雅的方法，以便于您可以轻松的在您的Go应用中支持命令行参数。通过使用该包，您将不必为处理命令行参数而去手写复杂的解析逻辑，仅需按照固定的格式定制flag即可。

flag包常用函数介绍

flag包中有四个常用的函数，它们分别是：

flag.String()：该函数定义一个字符串类型的flag，并将其名称、默认值、使用提示信息作为参数。例如，我们可以通过如下方式来定义一个名为“name”的字符串类型的flag：

name := flag.String("name", "default", "Input String")

登录后复制

上述代码中的第一个参数是标志的名称，第二个参数是默认值，第三个参数是用法信息。我们还可以通过“flag.Parse()”进行使用解析。

flag.Bool()：该函数定义一个布尔类型的flag，并将其名称、默认值、使用提示信息作为参数。例如，我们可以通过如下方式来定义一个名为“is_config”的布尔类型的flag：

isConfig := flag.Bool("is_config", false, "Is Config Set")

登录后复制

上述代码中的第一个参数是标志的名称，第二个参数是默认值，第三个参数是用法信息。我们还可以通过“flag.Parse()”进行解析。

flag.Int()：该函数定义一个整型类型的flag，并将其名称、默认值、使用提示信息作为参数。例如，我们可以通过如下方式来定义一个名为“count”的整型类型的flag：

count := flag.Int("count", 1, "input count")

登录后复制

上述代码中的第一个参数是标志的名称，第二个参数是默认值，第三个参数是用法信息。我们还可以通过“flag.Parse()”进行解析。

flag.Parse()：该函数是用来读取保存在flag的所有参数，将命令行参数解析成相应类型和值，并赋值给flag对应的变量。例如，我们可以通过如下代码来解析上述flag：

flag.Parse()

登录后复制

flag包使用实例

我们假设现在要使用flag包实现以下命令行参数：

./example -c config.yml -t 20 -v

登录后复制

具体的代码实现如下：

package main

import (
    "flag"
    "fmt"
)

func main() {
    config := flag.String("c", "default.yml", "Input config file name")
    timeout := flag.Int("t", 10, "Maximum waiting time (seconds)")
    verbose := flag.Bool("v", false, "Print verbose log")
    flag.Parse()

    fmt.Println("config file:", *config)
    fmt.Println("timeout:", *timeout)
    fmt.Println("verbose log:", *verbose)
}

登录后复制

上述代码使用了三个flag分别表示“c”、“t”和“v”，分别表示config文件名、最长等待时间和是否输出详细的日志信息。我们可以通过调用“flag.Parse()”来解析命令行参数，在执行时，输出结果如下：

config file: config.yml
timeout: 20
verbose log: true

登录后复制

我们可以看到，flag包已经成功地将我们在命令行中指定的参数赋值给相应的变量。需要注意的是，我们可以将一个flag同时映射到多个变量上。这些变量必须是相同类型的。例子如下：

package main

import (
    "flag"
    "fmt"
)

func main() {
  var name string
  flag.StringVar(&name, "name", "default", "input name")
  flag.Parse()
  fmt.Println(name)
}

登录后复制

运行该程序并传递命令行参数将输出传递的参数，否则将输出默认值“default”。

golang flag包的优缺点

优点：