Go Flag 包詳解
介紹
flag 包是 Go 語言標(biāo)準(zhǔn)庫中的一個(gè)包，用于解析命令行參數(shù)。它提供了一種方便的方式來定義和解析命令行參數(shù)，使得開發(fā)命令行工具和應(yīng)用程序更加簡(jiǎn)單和靈活。
flag 包的主要功能包括：
定義命令行參數(shù)的類型和默認(rèn)值
解析命令行參數(shù)，并將其賦值給對(duì)應(yīng)的變量
提供幫助信息和用法說明
簡(jiǎn)單例子
下面是一個(gè)示例，假設(shè)我們要編寫一個(gè)簡(jiǎn)單的命令行工具，用于計(jì)算兩個(gè)整數(shù)的和。我們可以使用 flag 包來定義并解析命令行參數(shù)。
package main
import (
"flag"
"fmt"
)
func main() {
// 定義命令行參數(shù)
num1 := flag.Int("num1", 0, "第一個(gè)整數(shù)")
num2 := flag.Int("num2", 0, "第二個(gè)整數(shù)")
// 解析命令行參數(shù)
flag.Parse()
// 計(jì)算和
sum := *num1 + *num2
// 輸出結(jié)果
fmt.Println("和:", sum)
}
在上面的示例中，我們首先使用 flag.Int 函數(shù)定義了兩個(gè)命令行參數(shù) num1 和 num2，分別表示兩個(gè)整數(shù)。這些參數(shù)的默認(rèn)值為 0，而第三個(gè)參數(shù)是用于幫助信息的描述。
接下來，我們調(diào)用 flag.Parse() 函數(shù)來解析命令行參數(shù)。它會(huì)在命令行中查找定義的參數(shù)，并將相應(yīng)的值賦給對(duì)應(yīng)的變量。
最后，我們將兩個(gè)整數(shù)相加，并輸出結(jié)果。
現(xiàn)在我們可以在命令行中運(yùn)行該程序，并指定命令行參數(shù)：
$ go run main.go -num1=10 -num2=20
和: 30
以上示例演示了如何使用 flag 包來定義和解析命令行參數(shù)，使得我們可以靈活地通過命令行來控制程序的行為。我們可以通過flag包進(jìn)一步開發(fā)自己的命令行工具和應(yīng)用程序。
flag 包還支持以下幾種常用的命令行參數(shù)類型：
布爾類型（
bool）：用法：
flag.Bool(name string, value bool, usage string) *bool示例：
verbose := flag.Bool("verbose", false, "顯示詳細(xì)信息")描述：布爾類型的命令行參數(shù)用于表示某個(gè)選項(xiàng)是否開啟或關(guān)閉。如果命令行中指定了該選項(xiàng)，則對(duì)應(yīng)的布爾變量會(huì)被設(shè)置為
true，否則為false。整數(shù)類型（
int）：用法：
flag.Int(name string, value int, usage string) *int示例：
count := flag.Int("count", 0, "重試次數(shù)")描述：整數(shù)類型的命令行參數(shù)用于表示整數(shù)值。通過命令行指定的整數(shù)值會(huì)被解析并賦值給對(duì)應(yīng)的整數(shù)變量。
字符串類型（
string）：用法：
flag.String(name string, value string, usage string) *string示例：
name := flag.String("name", "", "姓名")描述：字符串類型的命令行參數(shù)用于表示文本字符串。命令行中指定的字符串值會(huì)被解析并賦值給對(duì)應(yīng)的字符串變量。
浮點(diǎn)數(shù)類型（
float64）：用法：
flag.Float64(name string, value float64, usage string) *float64示例：
price := flag.Float64("price", 0.0, "價(jià)格")描述：浮點(diǎn)數(shù)類型的命令行參數(shù)用于表示浮點(diǎn)數(shù)值。命令行中指定的浮點(diǎn)數(shù)值會(huì)被解析并賦值給對(duì)應(yīng)的浮點(diǎn)數(shù)變量。
其他類型：
Int64、Uint、Uint64：類似于整數(shù)類型，但是支持更大的整數(shù)范圍。Duration：用于表示時(shí)間段的類型，可以解析包含時(shí)間單位的字符串，如"10s"、"1h30m"。IP、IPMask：用于表示 IP 地址和 IP 子網(wǎng)掩碼的類型。Var：用于自定義類型的命令行參數(shù)，需要實(shí)現(xiàn)flag.Value接口。
通過使用這些不同類型的命令行參數(shù)，可以滿足各種不同類型數(shù)據(jù)的需求，并且 flag 包提供了簡(jiǎn)單易用的方法來解析和處理這些命令行參數(shù)。
以下是一個(gè)示例，展示了 flag 包中常用的命令行參數(shù)類型：
package main
import (
"flag"
"fmt"
)
func main() {
// 定義命令行參數(shù)
verbose := flag.Bool("verbose", false, "顯示詳細(xì)信息")
count := flag.Int("count", 0, "重試次數(shù)")
name := flag.String("name", "", "姓名")
price := flag.Float64("price", 0.0, "價(jià)格")
// 解析命令行參數(shù)
flag.Parse()
// 輸出解析后的命令行參數(shù)
fmt.Println("Verbose:", *verbose)
fmt.Println("Count:", *count)
fmt.Println("Name:", *name)
fmt.Println("Price:", *price)
}
在上述示例中，我們定義了四個(gè)不同類型的命令行參數(shù)：
verbose是一個(gè)布爾類型的參數(shù)，用于表示是否顯示詳細(xì)信息。count是一個(gè)整數(shù)類型的參數(shù)，用于表示重試次數(shù)。name是一個(gè)字符串類型的參數(shù)，用于表示姓名。price是一個(gè)浮點(diǎn)數(shù)類型的參數(shù)，用于表示價(jià)格。
通過使用 flag.Bool、flag.Int、flag.String 和 flag.Float64 函數(shù)，我們定義了這些不同類型的命令行參數(shù)，并為每個(gè)參數(shù)指定了名稱、默認(rèn)值和幫助信息。
接下來，我們調(diào)用 flag.Parse() 函數(shù)來解析命令行參數(shù)。然后，我們使用指針解引用的方式獲取每個(gè)命令行參數(shù)的值，并將其打印出來。
現(xiàn)在我們可以在命令行中運(yùn)行該程序，并指定不同的命令行參數(shù)：
$ go run main.go -verbose -count=3 -name=John -price=9.99
Verbose: true
Count: 3
Name: John
Price: 9.99
通過修改命令行參數(shù)的值，你可以嘗試不同類型的參數(shù)并觀察輸出結(jié)果。
Var形式
flag不僅僅支持直接類型的形式解析，還支持直接解析覆蓋值的形式來解析命令行數(shù)據(jù)，比如BoolVar。
示例
package main
import (
"flag"
"fmt"
)
func main() {
// 定義命令行參數(shù)
var verbose bool
flag.BoolVar(&verbose, "verbose", false, "顯示詳細(xì)信息")
var count int
flag.IntVar(&count, "count", 0, "重試次數(shù)")
// 解析命令行參數(shù)
flag.Parse()
// 輸出解析后的命令行參數(shù)
fmt.Println("Verbose:", verbose)
fmt.Println("Count:", count)
}
在上述示例中，我們使用 BoolVar 和 IntVar 函數(shù)創(chuàng)建了布爾類型和整數(shù)類型的命令行參數(shù)。
BoolVar 函數(shù)用于創(chuàng)建一個(gè)布爾類型的命令行參數(shù)，并將解析后的值存儲(chǔ)在對(duì)應(yīng)的布爾變量中。它的參數(shù)包括一個(gè)布爾變量的指針，命令行參數(shù)的名稱，命令行參數(shù)的默認(rèn)值以及對(duì)該命令行參數(shù)的簡(jiǎn)短描述。
IntVar 函數(shù)用于創(chuàng)建一個(gè)整數(shù)類型的命令行參數(shù)，并將解析后的值存儲(chǔ)在對(duì)應(yīng)的整數(shù)變量中。它的參數(shù)包括一個(gè)整數(shù)變量的指針，命令行參數(shù)的名稱，命令行參數(shù)的默認(rèn)值以及對(duì)該命令行參數(shù)的簡(jiǎn)短描述。
通過調(diào)用 flag.Parse() 函數(shù)，我們可以解析命令行參數(shù)并將其賦值給相應(yīng)的變量。
下面是在命令行中運(yùn)行該程序并指定不同的命令行參數(shù)的示例：
$ go run main.go -verbose -count=3
Verbose: true
Count: 3
通過修改命令行參數(shù)的值，您可以嘗試不同的布爾值和整數(shù)值，并觀察輸出結(jié)果。這將幫助您更好地理解和使用 flag 包中的 BoolVar 和 IntVar 函數(shù)。
自定義類型解析
flag.TypeVar 是 flag 包中用于自定義類型的命令行參數(shù)的函數(shù)。通過實(shí)現(xiàn) flag.Value 接口，我們可以創(chuàng)建自己的類型，并在命令行參數(shù)中使用。
flag.Value接口：
type Value interface {
String() string
Set(string) error
}
以下是一個(gè)示例，展示了如何使用 flag.TypeVar 創(chuàng)建自定義類型的命令行參數(shù)：
flag.TypeVar 是 flag 包中用于自定義類型的命令行參數(shù)的函數(shù)。通過實(shí)現(xiàn) flag.Value 接口，我們可以創(chuàng)建自己的類型，并在命令行參數(shù)中使用。
package main
import (
"flag"
"fmt"
"strconv"
)
// CustomType 是自定義的類型
type CustomType int
// String 返回 CustomType 的字符串表示
func (c CustomType) String() string {
return strconv.Itoa(int(c))
}
// Set 解析命令行參數(shù)并設(shè)置 CustomType 的值
func (c *CustomType) Set(value string) error {
// 在這里可以進(jìn)行自定義類型的解析和處理
// 這里簡(jiǎn)單地將命令行參數(shù)轉(zhuǎn)換為整數(shù)并賦值給 CustomType
num, err := strconv.Atoi(value)
if err != nil {
return err
}
*c = CustomType(num)
return nil
}
func main() {
// 定義命令行參數(shù)
var custom CustomType
flag.Var(&custom, "custom", "自定義參數(shù)")
// 解析命令行參數(shù)
flag.Parse()
// 輸出解析后的命令行參數(shù)
fmt.Println("Custom:", custom)
}
在上面的示例中，我們定義了一個(gè)名為 CustomType 的自定義類型，并實(shí)現(xiàn)了 flag.Value 接口的兩個(gè)方法：String 和 Set。
String 方法用于返回自定義類型 CustomType 的字符串表示，這里我們將其轉(zhuǎn)換為整數(shù)類型的字符串。
Set 方法用于解析命令行參數(shù)并設(shè)置自定義類型 CustomType 的值。在這個(gè)示例中，我們將命令行參數(shù)轉(zhuǎn)換為整數(shù)，并將其賦值給 CustomType 變量。
接下來，我們使用 flag.Var 函數(shù)注冊(cè)自定義類型的命令行參數(shù)。通過傳入一個(gè)實(shí)現(xiàn)了 flag.Value 接口的變量的指針，我們告訴 flag 包應(yīng)該如何解析和處理該類型的命令行參數(shù)。
最后，我們調(diào)用 flag.Parse() 函數(shù)來解析命令行參數(shù)。在解析完成后，我們可以通過直接訪問自定義類型的變量來獲取解析后的值，并將其打印出來。
現(xiàn)在我們可以在命令行中運(yùn)行該程序，并指定自定義類型的命令行參數(shù)：
$ go run main.go -custom=42
Custom: 42
當(dāng)然如果你只是想獲得命令行參數(shù)，就不需要flag包了，os.Args就可以解決：
os.Args 是一個(gè)字符串切片，用于訪問命令行參數(shù)。它存儲(chǔ)了程序啟動(dòng)時(shí)傳遞給程序的所有命令行參數(shù)，包括程序名稱本身。
以下是一個(gè)示例，展示了如何使用 os.Args 來獲取和遍歷命令行參數(shù)：
package main
import (
"fmt"
"os"
)
func main() {
// 獲取命令行參數(shù)
args := os.Args
// 遍歷命令行參數(shù)
for index, arg := range args {
fmt.Printf("參數(shù) %d: %s\\\\n", index, arg)
}
}
在上述示例中，我們使用 os.Args 獲取了所有的命令行參數(shù)，并將它們存儲(chǔ)在 args 變量中。
然后，我們使用 range 循環(huán)遍歷 args 切片，獲取每個(gè)命令行參數(shù)的索引和值。通過 %d 和 %s 占位符，我們將參數(shù)的索引和值打印出來。
現(xiàn)在我們可以在命令行中運(yùn)行該程序，并指定不同的命令行參數(shù)：
$ go run main.go arg1 arg2 arg3
參數(shù) 0: main.go
參數(shù) 1: arg1
參數(shù) 2: arg2
參數(shù) 3: arg3
在上面的示例中，main.go 是程序的名稱，arg1、arg2 和 arg3 是用戶傳遞給程序的自定義命令行參數(shù)。通過遍歷 os.Args 切片，我們可以獲取和處理這些命令行參數(shù)。
使用 os.Args 可以訪問和處理命令行參數(shù)，從而根據(jù)程序的需求來執(zhí)行相應(yīng)的邏輯操作。
