### 歡迎訪問我的GitHub
> 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)

### 本篇概覽
- 開發命令列程式時，經常需要接受命令列傳入的引數，flag包提供了引數處理的功能，官方文件地址：https://golang.google.cn/pkg/flag/
### demo簡介
- 寫個使用flag包的demo，用於接收命令列引數並列印出來，如果命令列沒有輸入該引數則提供預設值，go的版本是1.11.5；

### 實戰原始碼
- 在GOPAHT目錄下建立目錄**src/hello**，在此新建檔案**hello.go**，內容如下：

```go
package main

import (
  "flag"
  "fmt"
)

//宣告變數用於接收命令列傳入的引數值
var (
  name string
  age int
  address *string
  id *int
)

func init() {
  //透過傳入變數地址的方式，繫結命令列引數到string變數
  flag.StringVar(&name,   //第一個引數：存放值的引數地址
                 "name",  //第二個引數：命令列引數的名稱
                "匿名",    //第三個引數：命令列不輸入時的預設值
                "您的姓名") //第四個引數：該引數的描述資訊，help命令時會顯示
  
  //透過傳入變數地址的方式，繫結命令列引數到int變數
  flag.IntVar(&age,        //第一個引數：存放值的引數地址
              "age",       //第二個引數：命令列引數的名稱
              -1,          //第三個引數：命令列不輸入時的預設值
              "您的年齡")   //第四個引數：該引數的描述資訊，help命令時會顯示
  
  //和前面兩個變數的獲取方式不同，這個api沒有傳入變數地址，而是把命令列引數值的地址返回了
  address = flag.String("address", //第一個引數：命令列引數的名稱
                           "未知",     //第二個引數：命令列不輸入時的預設值
                          "您的住址")   //第三個引數：該引數的描述資訊，help命令時會顯示

id = flag.Int("id", //第一個引數：命令列引數的名稱
                           -1,     //第二個引數：命令列不輸入時的預設值
                          "身份ID")   //第三個引數：該引數的描述資訊，help命令時會顯示
}

func main() {
  //處理入參
  flag.Parse()

//入參已經被賦值給各個變數，可以使用了
  fmt.Printf("%s您好, 您的年齡:%d, 您的住址:%s, 您的ID:%d\n\n", name, age, *address, *id)

fmt.Println("---遍歷有輸入的引數（開始）---")

//Visit方法會遍歷有輸入的引數，flag.Flag可以將引數的名稱、值、預設值、描述等內容取到
  flag.Visit(func(f *flag.Flag){
    fmt.Printf("引數名[%s], 引數值[%s], 預設值[%s], 描述資訊[%s]\n", f.Name, f.Value, f.DefValue, f.Usage)
  })
  fmt.Println("---遍歷有輸入的引數（結束）---\n")

fmt.Println("---遍歷所有的引數（開始）---")
  //VisitAll方法會遍歷所有定義的引數(包括沒有在命令列輸入的)，flag.Flag可以將引數的名稱、值、預設值、描述等內容取到
  flag.VisitAll(func(f *flag.Flag){
    fmt.Printf("引數名[%s], 引數值[%s], 預設值[%s], 描述資訊[%s]\n", f.Name, f.Value, f.DefValue, f.Usage)
  })
  fmt.Println("---遍歷所有的引數（結束）---\n")
}
```

- 由以上程式碼可見，將命令列輸入的引數傳遞到程式碼中的變數主要有兩種方式：
- 第一種：**StringVar**和**IntVar**等方法，第一個引數是變數的地址；
- 第二種：**String**和**Int**等方法，將入參的值存入一個變數中，再將此變數的地址作為返回值返回；

### 遍歷入參
- flag提供Visit方法，用於遍歷每個有傳入值的引數，Visit方法的入參是個自定義方法，用於接收和出入命令列的傳入值；
- flag提供VisitAll方法，用於遍歷所有在程式碼中宣告過的命令列引數，VisitAll方法的入參是個自定義方法，用於接收和出入命令列的傳入值；

### 執行驗證
- 在hello.go所在目錄執行命令**go run hello.go -name 超人 -address 深圳 -id 101**，控制檯輸出如下，可見除了age引數沒有輸入，列印的是預設值，其他的引數都被繫結到正確的變數上了，並且有輸入的引數和所有引數都能被遍歷到：

```shell
超人您好, 您的年齡:-1, 您的住址:深圳, 您的ID:101

---遍歷有輸入的引數（開始）---
引數名[address], 引數值[深圳], 預設值[未知], 描述資訊[您的住址]
引數名[id], 引數值[101], 預設值[-1], 描述資訊[身份ID]
引數名[name], 引數值[超人], 預設值[匿名], 描述資訊[您的姓名]
---遍歷有輸入的引數（結束）---

---遍歷所有的引數（開始）---
引數名[address], 引數值[深圳], 預設值[未知], 描述資訊[您的住址]
引數名[age], 引數值[-1], 預設值[-1], 描述資訊[您的年齡]
引數名[id], 引數值[101], 預設值[-1], 描述資訊[身份ID]
引數名[name], 引數值[超人], 預設值[匿名], 描述資訊[您的姓名]
---遍歷所有的引數（結束）---
```

- 輸入命令**go run hello.go --help**，可以看到幫助資訊如下，程式碼中設定的描述資訊也輸出了：

```shell
Usage of /var/folders/l7/nk5tjlsx4118k9tjg3n6248r0000gn/T/go-build071933964/b001/exe/hello:
  -address string
    	您的住址 (default "未知")
  -age int
    	您的年齡 (default -1)
  -id int
    	身份ID (default -1)
  -name string
    	您的姓名 (default "匿名")
exit status 2
```

### 原始碼下載
- 原始碼已經上傳到github，地址是：https://github.com/zq2599/blog_demos/tree/master/godemo/src/hello

- 以上就是flag包常用API的實戰了，golang的學習剛剛開始，讀者您如果發現文章中的問題，還請及時指正，謝謝！

### 歡迎關注ITpub：程式設計師欣宸
> [學習路上，你不孤單，欣宸原創一路相伴...](http://blog.itpub.net/70017844/)

golang實戰之flag包

相關文章