go package flag解析

Posted on   |   In   |  

go解析命令行参数

资料

go 命令行参数解析

1
pg_ctl -D /home/manu/DB_data/ -l /home/manu/DB_data/postgres_manu.log   start
1
server starting
这种情况下我们更需要的是解析各个参数的意义，比如-D选项 是通知pg_ctl pgdata的路径在那，-l选项告知的是log记录到那个文件，start相当于子命令，告知action。对于这种命令，我们都知道C语言有getopt及其getopt_long来解决。go语言怎么解决？
go语言提供了flag这个package。来应对这种入参的解析。
flag支持的语言格式如下：
-flag     // bool类型only
-flag=x
-flag x  //not bool 类型
很自然，这个flag能够解析 -D /home/manu/DB_data,对应第二种类型，我们知道pg_ctl有-W选项，属于一个开关性质的bool型的选项

-W do not wait until operation completes
自然对应第一种类型，也可以解析。第二种也很好理解。
下面我给出一个例子，简单的解析这个pg_ctl的命令：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
package main
import (
    "fmt"
    "flag"
)

func main(){

    data_path := flag.String("D","/home/manu/sample/","DB data path")
    log_file := flag.String("l","/home/manu/sample.log","log file")
    nowait_flag :=flag.Bool("W",false,"do not wait until operation completes")

    flag.Parse()

    var cmd string = flag.Arg(0);

    fmt.Printf("action   : %s\n",cmd)
    fmt.Printf("data path: %s\n",*data_path)
    fmt.Printf("log file : %s\n",*log_file)
    fmt.Printf("nowait     : %v\n",*nowait_flag)

    fmt.Printf("-------------------------------------------------------\n")

    fmt.Printf("there are %d non-flag input param\n",flag.NArg())
    for i,param := range flag.Args(){
        fmt.Printf("#%d    :%s\n",i,param)
    }
}

我们看到了，解析出了data_path,log_file无论 -l -D出现的顺序如何，只要正常的出现了，就能正常的解析。
但是晴朗的天空中也有一片乌云，start不是这种 -key=alue 或则-option的类型，flag是解析不了的。我们称这种参数为non-flag参数，flag解析遇到non-flag参数就停止了：

1
2
3
4
s := f.args[0]
if len(s) == 0 || s[0] != '-' || len(s) == 1 {
    return false, nil
}

所以如果我们将non-flag参数放在最前面，flag什么也不会解析，因为flag遇到了这个就停止解析了。

1
2
3
4
5
6
7
8
9
10
11
12
manu@manu-hacks:~/code/go/self$ go run pg_ctl_parse.go  start -l=/home/manu/DB_data/postgres_manu.log -W -D /home/manu/DB_data/  
action   : start
data path: /home/manu/sample
log file : /home/manu/sample.log
nowait   : false
-------------------------------------------------------
there are 5 non-flag input param
#0	:start
#1	:-l=/home/manu/DB_data/postgres_manu.log
#2	:-W
#3	:-D
#4	:/home/manu/DB_data/
OK，flag提供了Arg(i),Args()来获取non-flag参数，NArg()来获取non-flag的个数。正如我们们sample 代码看到的。    

1
2
3
4
fmt.Printf("there are %d non-flag input param\n",flag.NArg())
    for i,param := range flag.Args(){
        fmt.Printf("#%d :%s\n",i,param)
    }
flag还提供了NFlag()获取那些匹配上的参数的个数。
从例子上看，flag package很有用，但是并没有强大到解析一切的程度。
如果你有类似-option或者-key =value这种参数，不妨试试 flag。如果你的入参解析非常复杂，flag可能捉襟见肘。