Golangflag包的具體使用

第Golangflag包的具體使用目錄入門demo運(yùn)行demo解讀flag包源碼總結(jié)在Golang程序中有很多種方法來(lái)處理命令行參數(shù)。簡(jiǎn)單的情況下可以不使用任何庫(kù)，直接處理os.Args；其實(shí)Golang的標(biāo)準(zhǔn)庫(kù)提供了flag包來(lái)處理命令行參數(shù)；還有第三方提供的處理命令行參數(shù)的庫(kù)，比如Pflag等。本文將介紹Golang標(biāo)準(zhǔn)庫(kù)中flag包的用法。本文的演示環(huán)境為ubuntu18.04。

入門demo

在Goworkspace的src目錄下創(chuàng)建flagdemo目錄，并在目錄下創(chuàng)建main.go文件，編輯其內(nèi)容如下：

packagemain

import"flag"

import"fmt"

//定義命令行參數(shù)對(duì)應(yīng)的變量，這三個(gè)變量都是指針類型

varcliName=flag.String("name","nick","InputYourName")

varcliAge=flag.Int("age",28,"InputYourAge")

varcliGender=flag.String("gender","male","InputYourGender")

//定義一個(gè)值類型的命令行參數(shù)變量，在Init()函數(shù)中對(duì)其初始化

//因此，命令行參數(shù)對(duì)應(yīng)變量的定義和初始化是可以分開的

varcliFlagint

funcInit(){

flag.IntVar(cliFlag,"flagname",1234,"Justfordemo")

funcmain(){

//初始化變量cliFlag

Init()

//把用戶傳遞的命令行參數(shù)解析為對(duì)應(yīng)變量的值

flag.Parse()

//flag.Args()函數(shù)返回沒(méi)有被解析的命令行參數(shù)

//funcNArg()函數(shù)返回沒(méi)有被解析的命令行參數(shù)的個(gè)數(shù)

fmt.Printf("args=%s,num=%d\n",flag.Args(),flag.NArg())

fori:=0;i!=flag.NArg();i++{

fmt.Printf("arg[%d]=%s\n",i,flag.Arg(i))

//輸出命令行參數(shù)

fmt.Println("name=",*cliName)

fmt.Println("age=",*cliAge)

fmt.Println("gender=",*cliGender)

fmt.Println("flagname=",cliFlag)

}

使用flag包前要通過(guò)import命令導(dǎo)入該包：

import"flag"

定義一個(gè)整型的參數(shù)age，返回指針類型的變量：

varcliAge=flag.Int("age",28,"InputYourAge")

創(chuàng)建值類型的參數(shù)變量，并在Init()函數(shù)中對(duì)其初始化(注意這里調(diào)用的是flag.IntVar方法)：

varcliFlagint

funcInit(){

flag.IntVar(cliFlag,"flagname",1234,"Justfordemo")

}

通過(guò)flag.Parse()函數(shù)接下命令行參數(shù)，解析函數(shù)將會(huì)在碰到第一個(gè)非flag命令行參數(shù)時(shí)停止：

flag.Parse()

命令行傳參的格式：

-isbool(一個(gè)-符號(hào)，布爾類型該寫法等同于-isbool=true)

-age=x(一個(gè)-符號(hào)，使用等號(hào))

-agex(一個(gè)-符號(hào)，使用空格)

--age=x(兩個(gè)-符號(hào)，使用等號(hào))

--agex(兩個(gè)-符號(hào)，使用空格)

運(yùn)行demo

在flagdemo目錄下執(zhí)行g(shù)obuild命令編譯demo生成可執(zhí)行文件flagdemo。

不傳遞命令行參數(shù)

此時(shí)輸出的命令行參數(shù)都是定義的默認(rèn)值。

傳遞命令行參數(shù)

傳遞的命令行參數(shù)會(huì)覆蓋默認(rèn)值。

傳遞多余的命令行參數(shù)

可以通過(guò)flag.Args()和flag.NArg()函數(shù)獲取未能解析的命令行參數(shù)。

傳遞錯(cuò)誤的命令行參

如果通過(guò)-xx傳入未定義的命令行參數(shù)，則會(huì)直接報(bào)錯(cuò)退出，并輸出幫助信息。

查看幫助信息

通過(guò)命令行參數(shù)-h或--help可以查看幫助信息：

解讀flag包源碼

flag包支持的類型有Bool、Duration、Float64、Int、Int64、String、Uint、Uint64。這些類型的參數(shù)被封裝到其對(duì)應(yīng)的后端類型中，比如Int類型的參數(shù)被封裝為intValue，String類型的參數(shù)被封裝為stringValue。這些后端的類型都實(shí)現(xiàn)了Value接口，因此可以把一個(gè)命令行參數(shù)抽象為一個(gè)Flag類型的實(shí)例。下面是Value接口和Flag類型的代碼：

//Value接口

typeValueinterface{

String()string

Set(string)error

//Flag類型

typeFlagstruct{

Namestring//nameasitappearsoncommandline

Usagestring//helpmessage

ValueValue//valueasset是個(gè)interface，因此可以是不同類型的實(shí)例。

DefValuestring//defaultvalue(astext);forusagemessage

}

intValue等類型實(shí)現(xiàn)了Value接口，因此可以賦值給Flag類型中的Value字段，下面是intValue類型的定義：

//--intValue

typeintValueint

funcnewIntValue(valint,p*int)*intValue{

*p=val

return(*intValue)(p)

func(i*intValue)Set(sstring)error{

v,err:=strconv.ParseInt(s,0,strconv.IntSize)

*i=intValue(v)

returnerr

func(i*intValue)Get()interface{}{returnint(*i)}

func(i*intValue)String()string{returnstrconv.Itoa(int(*i))}

所有的參數(shù)被保存在FlagSet類型的實(shí)例中，F(xiàn)lagSet類型的定義如下：

//AFlagSetrepresentsasetofdefinedflags.

typeFlagSetstruct{

Usagefunc()

namestring

parsedbool

actualmap[string]*Flag//中保存從命令行參數(shù)中解析到的參數(shù)實(shí)例

formalmap[string]*Flag//中保存定義的命令行參數(shù)實(shí)例(實(shí)例中包含了默認(rèn)值)

args[]string//argumentsafterflags

errorHandlingErrorHandling

outputio.Writer//nilmeansstderr;useout()accessor

}

Flag包被導(dǎo)入時(shí)創(chuàng)建了FlagSet類型的對(duì)象CommandLine：

varCommandLine=NewFlagSet(os.Args[0],ExitOnError)

在程序中定義的所有命令行參數(shù)變量都會(huì)被加入到CommandLine的formal屬性中，其具體的調(diào)用過(guò)程如下：

varcliAge=flag.Int("age",28,"InputYourAge")

funcInt(namestring,valueint,usagestring)*int{

returnCommandLine.Int(name,value,usage)

func(f*FlagSet)Int(namestring,valueint,usagestring)*int{

p:=new(int)

f.IntVar(p,name,value,usage)

returnp

func(f*FlagSet)IntVar(p*int,namestring,valueint,usagestring){

f.Var(newIntValue(value,p),name,usage)

func(f*FlagSet)Var(valueValue,namestring,usagestring){

//Rememberthedefaultvalueasastring;itwon'tchange.

flag:=Flag{name,usage,value,value.String()}

_,alreadythere:=f.formal[name]

ifalreadythere{

varmsgstring

if==""{

msg=fmt.Sprintf("flagredefined:%s",name)

}else{

msg=fmt.Sprintf("%sflagredefined:%s",,name)

fmt.Fprintln(f.Output(),msg)

panic(msg)//Happensonlyifflagsaredeclaredwithidenticalnames

iff.formal==nil{

f.formal=make(map[string]*Flag)

//把命令行參數(shù)對(duì)應(yīng)的變量添加到formal中

f.formal[name]=flag

}

命令行參數(shù)的解析過(guò)程則由flag.Parse()函數(shù)完成，其調(diào)用過(guò)程大致如下：

funcParse(){

CommandLine.Parse(os.Args[1:])

func(f*FlagSet)Parse(arguments[]string)error{

f.parsed=true

f.args=arguments

for{

seen,err:=f.parseOne()

ifseen{

continue

iferr==nil{

break

switchf.errorHandling{

caseContinueOnError:

returnerr

caseExitOnError:

os.Exit(2)

casePanicOnError:

panic(err)

returnnil

}

最終由FlagSet的parseOne()方法執(zhí)行解析任務(wù)：

func(f*FlagSet)parseOne()(bool,error){

flag.Value.Set(value)

f.actual[name]=flag

}

總結(jié)

本文介紹了Golang標(biāo)準(zhǔn)庫(kù)中flag包的基本用