介绍
- 编写命令行程序时,需要对命令参数进行解析。
- 在Go语言中的 flag 包中,提供了命令行参数解析的功能,以下为支持的参数类型:
flag 参数 | 有效值 |
---|---|
string | 合法字符串 |
int、int64、uint、uint64 | 1234、0664、0x1234 等类型,也可以是负数 |
float64 | 合法浮点数 |
bool | 1、0、t、f、T、F、true、false、TRUE、FALSE、True、False |
duration | 任何合法的时间段字符串,如“300ms”、“-1.5h”、“2h45m”, 合法的单位有“ns”、“us”、“µs”、“ms”、“s”、“m”、“h” |
使用
flag.Type()
介绍
Type 可以是上面类型表格中的类型,返回值为对应类型的指针。
flag.Type(flag 名, 默认值, 帮助信息) *Type
示例
name := flag.String("name", "张三", "姓名")
age := flag.Int("age", 18, "年龄")
married := flag.Bool("married", false, "婚否")
delay := flag.Duration("d", 0, "时间间隔")
flag.TypeVar()
介绍
Type 可以是上面类型表格中的类型,其功能为将 flag 绑定到对应类型的指针上。
flag.TypeVar(Type 指针, flag 名, 默认值, 帮助信息)
示例
var name string
flag.StringVar(&name, "name", "张三", "姓名")
var age int
flag.IntVar(&age, "age", 18, "年龄")
var married bool
flag.BoolVar(&married, "married", false, "婚否")
var delay time.Duration
flag.DurationVar(&delay, "d", 0, "时间间隔")
flag.Parse()
通过以上两种方法定义好命令行 flag 参数后,需要通过调用 flag.Parse() 来对命令行参数进行解析。
支持的命令行参数格式有以下几种:
-flag=x | 支持所有类型 (推荐) |
---|---|
-flag:x | 只支持 bool 类型 |
-flag x | 只支持非 bool 类型 |
package main
import (
"flag"
"fmt"
)
var Input_pstrName = flag.String("name", "gerry", "input ur name")
var Input_piAge = flag.Int("age", 20, "input ur age")
var Input_flagvar int
func Init() {
flag.IntVar(&Input_flagvar, "flagname", 1234, "help message for flagname")
}
func main() {
Init()
flag.Parse()
fmt.Println("name=", *Input_pstrName)
fmt.Println("age=", *Input_piAge)
fmt.Println("flagname=", Input_flagvar)
}
运行:
$ go run main.go -name "aaa" -age=123 -flagname=999
name= aaa
age= 123
flagname= 999
flag.Var()
我们还可以创建自定义 flag,只要实现 flag.Value 接口即可,这时候可以通过如下方式定义该 flag:
flag.Var(value Value, name string, usage string)
flag.Var(&flagVal, "name", "help message for flagname")
示例
package main
import (
"flag"
"fmt"
"strings"
)
/*
Value接口:
type Value interface {
String() string
Set(string) error
}
实现flag包中的Value接口,将命令行接收到的值用,分隔存到slice里
*/
type sliceValue []string
func newSliceValue(vals []string, p *[]string) *sliceValue {
*p = vals
return (*sliceValue)(p)
}
func (s *sliceValue) Set(val string) error {
*s = strings.Split(val, ",")
return nil
}
//flag为slice的默认值default is me,和return返回值没有关系
func (s *sliceValue) String() string {
*s = strings.Split("default is me", ",")
return "It's none of my business"
}
/*
可执行文件名 -slice="java,go" 最后将输出[java,go]
可执行文件名 最后将输出[default is me]
*/
func main(){
var languages []string
flag.Var(newSliceValue([]string{}, &languages), "slice", "I like programming `languages`")
flag.Parse()
//打印结果slice接收到的值
fmt.Println(languages)
}
通过-slice go,php
这样的形式传递参数,languages 得到的就是 [go, php],如果不加-slice
参数则打印默认值[default is me]
$ go run main.go -slice go,php,java
[go php java]
flag 中对 Duration 这种非基本类型的支持,使用的就是类似这样的方式,即同样实现了 Value 接口