Golang flag包的具體使用
在 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)境為 ubuntu 18.04。
入門 demo
在 Go workspace 的 src 目錄下創(chuàng)建 flagdemo 目錄，并在目錄下創(chuàng)建 main.go 文件，編輯其內(nèi)容如下：
package main
import "flag"
import "fmt"
// 定義命令行參數(shù)對(duì)應(yīng)的變量，這三個(gè)變量都是指針類型
var cliName = flag.String("name", "nick", "Input Your Name")
var cliAge = flag.Int("age", 28, "Input Your Age")
var cliGender = flag.String("gender", "male", "Input Your Gender")
// 定義一個(gè)值類型的命令行參數(shù)變量，在 Init() 函數(shù)中對(duì)其初始化
// 因此，命令行參數(shù)對(duì)應(yīng)變量的定義和初始化是可以分開的
var cliFlag int
func Init() {
flag.IntVar(&cliFlag, "flagname", 1234, "Just for demo")
}
func main() {
// 初始化變量 cliFlag
Init()
// 把用戶傳遞的命令行參數(shù)解析為對(duì)應(yīng)變量的值
flag.Parse()
// flag.Args() 函數(shù)返回沒(méi)有被解析的命令行參數(shù)
// func NArg() 函數(shù)返回沒(méi)有被解析的命令行參數(shù)的個(gè)數(shù)
fmt.Printf("args=%s, num=%d\n", flag.Args(), flag.NArg())
for i := 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，返回指針類型的變量：
var cliAge = flag.Int("age", 28, "Input Your Age")創(chuàng)建值類型的參數(shù)變量，并在 Init() 函數(shù)中對(duì)其初始化(注意這里調(diào)用的是 flag.IntVar 方法)：
var cliFlag int
func Init() {
flag.IntVar(&cliFlag, "flagname", 1234, "Just for demo")
}通過(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)) -age x (一個(gè) - 符號(hào)，使用空格) --age=x (兩個(gè) - 符號(hào)，使用等號(hào)) --age x (兩個(gè) - 符號(hào)，使用空格)
運(yùn)行 demo
在 flagdemo 目錄下執(zhí)行 go build 命令編譯 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 接口
type Value interface {
String() string
Set(string) error
}
// Flag 類型
type Flag struct {
Name string // name as it appears on command line
Usage string // help message
Value Value // value as set 是個(gè) interface，因此可以是不同類型的實(shí)例。
DefValue string // default value (as text); for usage message
}intValue 等類型實(shí)現(xiàn)了 Value 接口，因此可以賦值給 Flag 類型中的 Value 字段，下面是 intValue 類型的定義：
// -- int Value
type intValue int
func newIntValue(val int, p *int) *intValue {
*p = val
return (*intValue)(p)
}
func (i *intValue) Set(s string) error {
v, err := strconv.ParseInt(s, 0, strconv.IntSize)
*i = intValue(v)
return err
}
func (i *intValue) Get() interface{} { return int(*i) }
func (i *intValue) String() string { return strconv.Itoa(int(*i)) }所有的參數(shù)被保存在 FlagSet 類型的實(shí)例中，F(xiàn)lagSet 類型的定義如下：
// A FlagSet represents a set of defined flags.
type FlagSet struct {
Usage func()
name string
parsed bool
actual map[string]*Flag // 中保存從命令行參數(shù)中解析到的參數(shù)實(shí)例
formal map[string]*Flag // 中保存定義的命令行參數(shù)實(shí)例(實(shí)例中包含了默認(rèn)值)
args []string // arguments after flags
errorHandling ErrorHandling
output io.Writer // nil means stderr; use out() accessor
}Flag 包被導(dǎo)入時(shí)創(chuàng)建了 FlagSet 類型的對(duì)象 CommandLine：
var CommandLine = NewFlagSet(os.Args[0], ExitOnError)
在程序中定義的所有命令行參數(shù)變量都會(huì)被加入到 CommandLine 的 formal 屬性中，其具體的調(diào)用過(guò)程如下：
var cliAge = flag.Int("age", 28, "Input Your Age")
func Int(name string, value int, usage string) *int {
return CommandLine.Int(name, value, usage)
}
func (f *FlagSet) Int(name string, value int, usage string) *int {
p := new(int)
f.IntVar(p, name, value, usage)
return p
}
func (f *FlagSet) IntVar(p *int, name string, value int, usage string) {
f.Var(newIntValue(value, p), name, usage)
}
func (f *FlagSet) Var(value Value, name string, usage string) {
// Remember the default value as a string; it won't change.
flag := &Flag{name, usage, value, value.String()}
_, alreadythere := f.formal[name]
if alreadythere {
var msg string
if f.name == "" {
msg = fmt.Sprintf("flag redefined: %s", name)
} else {
msg = fmt.Sprintf("%s flag redefined: %s", f.name, name)
}
fmt.Fprintln(f.Output(), msg)
panic(msg) // Happens only if flags are declared with identical names
}
if f.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ò)程大致如下：
func Parse() {
CommandLine.Parse(os.Args[1:])
}
func (f *FlagSet) Parse(arguments []string) error {
f.parsed = true
f.args = arguments
for {
seen, err := f.parseOne()
if seen {
continue
}
if err == nil {
break
}
switch f.errorHandling {
case ContinueOnError:
return err
case ExitOnError:
os.Exit(2)
case PanicOnError:
panic(err)
}
}
return nil
}最終由 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 包的基本用法，并進(jìn)一步分析了其主要的代碼邏輯。其實(shí) flag 包還支持用戶自定義類型的命令行參數(shù)，本文不再贅述，有興趣的朋友請(qǐng)參考官方 demo。
參考：
package flag
Go by Example: Command-Line Flags
USING COMMAND LINE FLAGS IN GO
Golang之使用Flag和Pflag
Go語(yǔ)言學(xué)習(xí)之flag包(The way to go)
Golang flag demo
作者：sparkdev
出處：http://www.cnblogs.com/sparkdev/
到此這篇關(guān)于Golang flag包的具體使用的文章就介紹到這了,更多相關(guān)Golang flag包內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
平時(shí)在項(xiàng)目開發(fā)過(guò)程中少不了對(duì)錯(cuò)誤的處理,一個(gè)好用的系統(tǒng)首先要確保其健壯性,不能經(jīng)常發(fā)生錯(cuò)誤就卡死之類的情況,為了讓我們的程序更加健壯,我們就需要知道golang里的錯(cuò)誤處理機(jī)制是怎么樣的,這篇文章帶大家一起學(xué)習(xí),需要的朋友跟著小編一起來(lái)看看吧2024-05-05
Go語(yǔ)言通過(guò)WaitGroup實(shí)現(xiàn)控制并發(fā)的示例詳解
Channel能夠很好的幫助我們控制并發(fā)，但是在開發(fā)習(xí)慣上與顯示的表達(dá)不太相同，所以在Go語(yǔ)言中可以利用sync包中的WaitGroup實(shí)現(xiàn)并發(fā)控制，本文就來(lái)和大家詳細(xì)聊聊WaitGroup如何實(shí)現(xiàn)控制并發(fā)2023-01-01
golang 網(wǎng)絡(luò)框架之gin的使用方法
這篇文章主要介紹了golang 網(wǎng)絡(luò)框架之gin的使用方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-11-11
教你一分鐘配置好Go語(yǔ)言開發(fā)環(huán)境(多種操作系統(tǒng))
在這篇文章中,我們從頭到尾一步步指導(dǎo)你配置Golang開發(fā)環(huán)境,并編寫你的第一個(gè)"Hello,?World!"程序,我們?cè)敿?xì)解釋了在多種操作系統(tǒng)（包括Windows、Linux和macOS）下的安裝過(guò)程、環(huán)境變量設(shè)置以及如何驗(yàn)證安裝是否成功2023-09-09
從淺入深帶你掌握Golang數(shù)據(jù)結(jié)構(gòu)map
在?Go?語(yǔ)言中，map?是一種非常常見(jiàn)的數(shù)據(jù)類型，它可以用于快速地檢索數(shù)據(jù)。本篇文章將介紹?Go?語(yǔ)言中的?map，包括?map?的定義、初始化、操作和優(yōu)化，需要的可以參考一下2023-04-04
這篇文章主要為大家介紹了Go errors默認(rèn)加堆棧信息作用分析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-12-12
Go語(yǔ)言編程中判斷文件是否存在是創(chuàng)建目錄的方法
這篇文章主要介紹了Go語(yǔ)言編程中判斷文件是否存在是創(chuàng)建目錄的方法,示例都是使用os包下的函數(shù),需要的朋友可以參考下2015-10-10
Go初學(xué)者踩坑之go?mod?init與自定義包的使用
go?mod是go的一個(gè)模塊管理工具,用來(lái)代替?zhèn)鹘y(tǒng)的GOPATH方案,下面這篇文章主要給大家介紹了關(guān)于Go初學(xué)者踩坑之go?mod?init與自定義包的使用,需要的朋友可以參考下2022-10-10
這篇文章主要介紹了Go語(yǔ)言中的函數(shù)式編程實(shí)踐,主要講解Go語(yǔ)言中的函數(shù)式編程概念和使用。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-05-05
本文將深入探討 Go 語(yǔ)言中的日志記錄,包括 Go 的標(biāo)準(zhǔn)日志庫(kù)的使用、流行的第三方日志庫(kù)以及如何在實(shí)際項(xiàng)目中實(shí)現(xiàn)有效的日志管理2023-11-11