快捷導(dǎo)航

golang flag包的使用教程

更新時(shí)間：2023年09月10日 08:46:18 作者：阿兵云原生

golang 的 flag 包是用于處理命令行參數(shù)的工具包,我們可以基于這個(gè)包來開發(fā)自定義的命令行工具,下面小編就來為大家介紹一下flag包的具體使用吧

前言

說起 golang 的 flag 個(gè)包，我們第一反應(yīng)的是什么呢？至少我曾經(jīng)第一次看到 flag 包的時(shí)候，第一反應(yīng)是想起寫 C 語言的時(shí)候咱們用于定義一個(gè)表示的，我們一般會(huì)命名為 flag 變量

實(shí)際上 golang 的 flag 包是用于處理命令行參數(shù)的工具包，我們可以基于這個(gè)包來開發(fā)自定義的命令行工具

對于命令行，相信大家都不陌生吧，學(xué)過 C 的就知道，如下代碼是否很熟悉

int?main(int?argc,char?**argv)
{
????//?打印?agrc??和?argv
????????return?0;
}

其中 argc 表示命令行的參數(shù)個(gè)數(shù)， argv 二級(jí)指針表示實(shí)際的命令參數(shù)

那么，對于咱們的 golang 是如何玩的，咱們先寫個(gè) demo 看看效果

main.go

func?main()?{
???if?len(os.Args)?>?0?{
??????fmt.Println("len(os.Args)?==?",?len(os.Args))
??????for?_,?v?:=?range?os.Args?{
?????????fmt.Println(v)
??????}
???}
}

效果如下：

咱們 go build 輸出程序名為 testFlag 的可執(zhí)行程序，如下運(yùn)行即可

當(dāng)然需要看非常詳細(xì)和全面的關(guān)于 flag 包的內(nèi)容，可以直接查看官方文檔，此處咱們是對 flag 包的介紹，平常都會(huì)使用到的一些功能，以及注意事項(xiàng)，分別從如下 3 個(gè)小點(diǎn)介紹一下常用的功能

注冊 flag 和 Flag 解析支持的數(shù)據(jù)類型
綁定 flag 變量
flag.Parse() 的使用方式

注冊 flag 和 Flag 解析支持的數(shù)據(jù)類型

我們可以看到上述簡單 demo 演示的是咱們運(yùn)行可執(zhí)行程序的時(shí)候追加我們期望的參數(shù)

實(shí)際上我們使用的比較多的是在程序內(nèi)部去設(shè)置 flag，例如一般寫 web 服務(wù)器的時(shí)候，就會(huì)去使用 flag 包設(shè)置端口

咱們在程序中使用 flag 包，定義一個(gè)端口

通過效果，我們可看到，咱們使用 flag 包來設(shè)置命令行參數(shù)時(shí)，實(shí)際上返回的是一個(gè)指針，這個(gè)地方可別弄錯(cuò)了

在我們的代碼中，我們可以看到 flag 包他支持這么多數(shù)據(jù)類型的注冊，如下：

基本的 int，int64，uint，uint64 ，整數(shù)的 flag 支持這些進(jìn)制的：1234、0664、0x1234
布爾值，bool ，布爾值可以這樣來寫：1, 0, t, f, T, F, true, false, TRUE, FALSE, True, False
浮點(diǎn)數(shù)，float，float64
字符串，string
時(shí)間段 duration 也是支持的很好的，例如：我們可以設(shè)置為 100ms，1h，1us，1h25m 等等都是可以的

那么對應(yīng)到咱們?nèi)ピO(shè)置各種數(shù)據(jù)類型的命令行參數(shù)的時(shí)候，我們就可以簡單的使用 flag 包對應(yīng)的函數(shù)即可，如：

port?:=?flag.Int("port",?8866,?"端口")
name?:=?flag.String("name",?"小豬",?"姓名")
money?:=?flag.Float64("money",10.36,"錢")

其他的照葫蘆畫瓢就可以了，這些函數(shù)的參數(shù)都是一樣的效果

參數(shù)1 flag 名稱
參數(shù)2 默認(rèn)值
參數(shù)3 幫助信息

這里再來敲一下黑板，上述的 port，name，money 都是指針類型的哦

綁定 flag 變量

如果用不習(xí)慣上述方式來注冊 flag 的話，我們也是可以先定義一個(gè)變量，然后將命令行參數(shù)綁定到變量上，如：

var?city?string
var?food?string
var?age?int
flag.StringVar(&city,"city","beijing","城市")
flag.StringVar(&food,"food","roast?duck","美食")
flag.IntVar(&age,"age",18,"年齡")

在 flag 包中，我們可以看到也有一堆關(guān)于各種數(shù)據(jù)類型綁定變量的函數(shù)