Go语言标准库之flag

狗仗人势 發表於 2019-5-19 11:48:00

<h1 class="post-title">Go语言flag包基本使用</h1>
<div class="post-content">
Go语言内置的<code>flag</code>包实现了命令行参数的解析，<code>flag</code>包使得开发命令行工具更为简单。
<h1 id="os-args">os.Args</h1>
如果你只是简单的想要获取命令行参数，可以像下面的代码示例一样使用<code>os.Args</code>来获取命令行参数。
<div class="cnblogs_code">
<pre>package main

import (
"fmt"
"os"
)

//os.Args demo
func main() {
//os.Args是一个[]string
if len(os.Args) > 0 {
 for index, arg := range os.Args {
 fmt.Printf("args[%d]=%v\n", index, arg)
 }
}
}</pre>
</div>
将上面的代码执行<code>go build -o "args_demo"</code>编译之后，执行：
<div class="cnblogs_code">
<pre>$ ./args_demo a b c d
args[0]=./args_demo
args[1]=a
args[2]=b
args[3]=c
args[4]=d</pre>
</div>
<code>os.Args</code>是一个存储命令行参数的字符串切片，它的第一个元素是执行文件的名称。
<h1 id="flag包基本使用">flag包基本使用</h1>
本文介绍了flag包的常用函数和基本用法，更详细的内容请查看官方文档。
<h2 id="导入flag包">导入flag包</h2>
<div class="cnblogs_code">
<pre>import flag</pre>
</div>
<h2>flag参数类型</h2>
flag包支持的命令行参数类型有<code>bool</code>、<code>int</code>、<code>int64</code>、<code>uint</code>、<code>uint64</code>、<code>float</code><code>float64</code>、<code>string</code>、<code>duration</code>。
<table>
<thead>
<tr><th>flag参数</th><th>有效值</th></tr>
</thead>
<tbody>
<tr>
<td>字符串flag</td>
<td>合法字符串</td>
</tr>
<tr>
<td>整数flag</td>
<td>1234、0664、0x1234等类型，也可以是负数。</td>
</tr>
<tr>
<td>浮点数flag</td>
<td>合法浮点数</td>
</tr>
<tr>
<td>bool类型flag</td>
<td>1, 0, t, f, T, F, true, false, TRUE, FALSE, True, False。</td>
</tr>
<tr>
<td>时间段flag</td>
<td>任何合法的时间段字符串。如”300ms”、”-1.5h”、”2h45m”。 合法的单位有”ns”、”us” /“µs”、”ms”、”s”、”m”、”h”。</td>

</tr>

</tbody>

</table>
<h2 id="定义命令行flag参数">定义命令行flag参数</h2>
有以下两种常用的定义命令行<code>flag</code>参数的方法。
<h3 id="flag-type">flag.Type()</h3>
基本格式如下：
<code>flag.Type(flag名, 默认值, 帮助信息)*Type</code>
例如我们要定义姓名、年龄、婚否三个命令行参数，我们可以按如下方式定义：
<div class="cnblogs_code">
<pre>name := flag.String("name", "张三", "姓名")
age := flag.Int("age", 18, "年龄")
married := flag.Bool("married", false, "婚否")
delay := flag.Duration("d", 0, "时间间隔")</pre>
</div>
需要注意的是，此时<code>name</code>、<code>age</code>、<code>married</code>、<code>delay</code>均为对应类型的指针。
<h3 id="flag-typevar">flag.TypeVar()</h3>
基本格式如下： <code>flag.TypeVar(Type指针, flag名, 默认值, 帮助信息)</code> 例如我们要定义姓名、年龄、婚否三个命令行参数，我们可以按如下方式定义：
<div class="cnblogs_code">
<pre>var name string
var age int
var married bool
var delay time.Duration
flag.StringVar(&name, "name", "张三", "姓名")
flag.IntVar(&age, "age", 18, "年龄")
flag.BoolVar(&married, "married", false, "婚否")
flag.DurationVar(&delay, "d", 0, "时间间隔")</pre>
</div>
<h2>flag.Parse()</h2>
通过以上两种方法定义好命令行flag参数后，需要通过调用<code>flag.Parse()</code>来对命令行参数进行解析。
支持的命令行参数格式有以下几种：
<ul>
<li><code>-flag xxx</code> （使用空格，一个<code>-</code>符号）</li>
<li><code>--flag xxx</code> （使用空格，两个<code>-</code>符号）</li>
<li><code>-flag=xxx</code> （使用等号，一个<code>-</code>符号）</li>
<li><code>--flag=xxx</code> （使用等号，两个<code>-</code>符号）</li>
</ul>
其中，布尔类型的参数必须使用等号的方式指定。
Flag解析在第一个非flag参数（单个”-“不是flag参数）之前停止，或者在终止符”–“之后停止。
<h2 id="flag其他函数">flag其他函数</h2>
<div class="cnblogs_code">
<pre>flag.Args()////返回命令行参数后的其他参数，以[]string类型
flag.NArg()//返回命令行参数后的其他参数个数
flag.NFlag() //返回使用的命令行参数个数</pre>
</div>
<h2>完整示例</h2>
<h3 id="定义">定义</h3>
<div class="cnblogs_code">
<pre>func main() {
//定义命令行参数方式1
var name string
var age int
var married bool
var delay time.Duration
flag.StringVar(&name, "name", "张三", "姓名")
flag.IntVar(&age, "age", 18, "年龄")
flag.BoolVar(&married, "married", false, "婚否")
flag.DurationVar(&delay, "d", 0, "延迟的时间间隔")

//解析命令行参数
 flag.Parse()
fmt.Println(name, age, married, delay)
//返回命令行参数后的其他参数
 fmt.Println(flag.Args())
//返回命令行参数后的其他参数个数
 fmt.Println(flag.NArg())
//返回使用的命令行参数个数
 fmt.Println(flag.NFlag())
}</pre>
</div>
<h3>使用</h3>
命令行参数使用提示：
<div class="cnblogs_code">
<pre>$ ./flag_demo -help
Usage of ./flag_demo:
-age int
 年龄 (default 18)
-d duration
 时间间隔
-married
 婚否
-name string
 姓名 (default "张三")</pre>
</div>
正常使用命令行flag参数：
<pre><code class="language-bash">$ ./flag_demo -name 小明 --age 18 -married=false -d=1h30m
小明 18 false 1h30m0s
[]
0
4
</code></pre>
使用非flag命令行参数：
<pre><code class="language-bash">$ ./flag_demo a b c
张三 18 false 0s

3
0
</code></pre>
</div> 
来源：https://www.cnblogs.com/aaronthon/p/10883711.html

頁: [1]

琼殿技术论坛's Archiver

Go语言标准库之flag