Go語言核心36講（Go語言基礎知識二）–學習筆記
- 2021 年 10 月 13 日
- 筆記
- 【016】Go語言核心36講
02 | 命令源碼文件
我們已經知道，環境變量 GOPATH 指向的是一個或多個工作區，每個工作區中都會有以代碼包為基本組織形式的源碼文件。
這裡的源碼文件又分為三種，即：命令源碼文件、庫源碼文件和測試源碼文件，它們都有着不同的用途和編寫規則。
對於 Go 語言學習者來說，你在學習階段中，也一定會經常編寫可以直接運行的程序。這樣的程序肯定會涉及命令源碼文件的編寫，而且，命令源碼文件也可以很方便地用go run命令啟動。
那麼，我今天的問題就是：命令源碼文件的用途是什麼，怎樣編寫它？
這裡，我給出你一個參考的回答：命令源碼文件是程序的運行入口，是每個可獨立運行的程序必須擁有的。我們可以通過構建或安裝，生成與其對應的可執行文件，後者一般會與該命令源碼文件的直接父目錄同名。
如果一個源碼文件聲明屬於main包，並且包含一個無參數聲明且無結果聲明的main函數，那麼它就是命令源碼文件。 就像下面這段代碼：
package main
import "fmt"
func main() {
fmt.Println("Hello, world!")
}
如果你把這段代碼存成 demo1.go 文件，那麼運行go run demo1.go命令後就會在屏幕（標準輸出）中看到Hello, world!
當需要模塊化編程時，我們往往會將代碼拆分到多個文件，甚至拆分到不同的代碼包中。但無論怎樣，對於一個獨立的程序來說，命令源碼文件永遠只會也只能有一個。如果有與命令源碼文件同包的源碼文件，那麼它們也應該聲明屬於main包。
知識精講
1. 命令源碼文件怎樣接收參數
我們先看一段不完整的代碼：
package main
import (
// 需在此處添加代碼。[1]
"fmt"
)
var name string
func init() {
// 需在此處添加代碼。[2]
}
func main() {
// 需在此處添加代碼。[3]
fmt.Printf("Hello, %s!\n", name)
}
如果邀請你幫助我，在注釋處添加相應的代碼，並讓程序實現」根據運行程序時給定的參數問候某人」的功能，你會打算怎樣做？
首先，Go 語言標準庫中有一個代碼包專門用於接收和解析命令參數。這個代碼包的名字叫flag。
我之前說過，如果想要在代碼中使用某個包中的程序實體，那麼應該先導入這個包。因此，我們需要在[1]處添加代碼”flag”。注意，這裡應該在代碼包導入路徑的前後加上英文半角的引號。如此一來，上述代碼導入了flag和fmt這兩個包。
其次，人名肯定是由字符串代表的。所以我們要在[2]處添加調用flag包的StringVar函數的代碼。就像這樣：
flag.StringVar(&name, "name", "everyone", "The greeting object.")
函數flag.StringVar接受 4 個參數。
- 第 1 個參數是用於存儲該命令參數值的地址，具體到這裡就是在前面聲明的變量name的地址了，由表達式&name表示。
- 第 2 個參數是為了指定該命令參數的名稱，這裡是name。
- 第 3 個參數是為了指定在未追加該命令參數時的默認值，這裡是everyone。
- 至於第 4 個函數參數，即是該命令參數的簡短說明了，這在打印命令說明時會用到。
順便說一下，還有一個與flag.StringVar函數類似的函數，叫flag.String。這兩個函數的區別是，後者會直接返回一個已經分配好的用於存儲命令參數值的地址。如果使用它的話，我們就需要把
var name string
改為
var name = flag.String("name", "everyone", "The greeting object.")
所以，如果我們使用flag.String函數就需要改動原有的代碼。這樣並不符合上述問題的要求。
再說最後一個填空。我們需要在[3]處添加代碼flag.Parse()。函數flag.Parse用於真正解析命令參數，並把它們的值賦給相應的變量。
對該函數的調用必須在所有命令參數存儲載體的聲明（這裡是對變量name的聲明）和設置（這裡是在[2]處對flag.StringVar函數的調用）之後，並且在讀取任何命令參數值之前進行。
正因為如此，我們最好把flag.Parse()放在main函數的函數體的第一行。
2. 怎樣在運行命令源碼文件的時候傳入參數，又怎樣查看參數的使用說明
如果我們把上述代碼存成名為 demo2.go 的文件，那麼運行如下命令就可以為參數name傳值：
go run demo2.go -name="Robert"
運行後，打印到標準輸出（stdout）的內容會是：
Hello, Robert!
另外，如果想查看該命令源碼文件的參數說明，可以這樣做：
$ go run demo2.go --help
其中的$表示我們是在命令提示符後運行go run命令的。運行後輸出的內容會類似：
Usage of /var/folders/ts/7lg_tl_x2gd_k1lm5g_48c7w0000gn/T/go-build155438482/b001/exe/demo2:
-name string
The greeting object. (default "everyone")
exit status 2
你可能不明白下面這段輸出代碼的意思。
/var/folders/ts/7lg_tl_x2gd_k1lm5g_48c7w0000gn/T/go-build155438482/b001/exe/demo2
這其實是go run命令構建上述命令源碼文件時臨時生成的可執行文件的完整路徑。
如果我們先構建這個命令源碼文件再運行生成的可執行文件，像這樣：
$ go build demo2.go
$ ./demo2 --help
那麼輸出就會是
Usage of ./demo2:
-name string
The greeting object. (default "everyone")
3. 怎樣自定義命令源碼文件的參數使用說明
這有很多種方式，最簡單的一種方式就是對變量flag.Usage重新賦值。flag.Usage的類型是func()，即一種無參數聲明且無結果聲明的函數類型。
flag.Usage變量在聲明時就已經被賦值了，所以我們才能夠在運行命令go run demo2.go –help時看到正確的結果。
注意，對flag.Usage的賦值必須在調用flag.Parse函數之前。
現在，我們把 demo2.go 另存為 demo3.go，然後在main函數體的開始處加入如下代碼。
flag.Usage = func() {
fmt.Fprintf(os.Stderr, "Usage of %s:\n", "question")
flag.PrintDefaults()
}
那麼當運行
$ go run demo3.go --help
後，就會看到
Usage of question:
-name string
The greeting object. (default "everyone")
exit status 2
現在再深入一層，我們在調用flag包中的一些函數（比如StringVar、Parse等等）的時候，實際上是在調用flag.CommandLine變量的對應方法。
flag.CommandLine相當於默認情況下的命令參數容器。所以，通過對flag.CommandLine重新賦值，我們可以更深層次地定製當前命令源碼文件的參數使用說明。
現在我們把main函數體中的那條對flag.Usage變量的賦值語句註銷掉，然後在init函數體的開始處添加如下代碼：
flag.CommandLine = flag.NewFlagSet("", flag.ExitOnError)
flag.CommandLine.Usage = func() {
fmt.Fprintf(os.Stderr, "Usage of %s:\n", "question")
flag.PrintDefaults()
}
再運行命令go run demo3.go –help後，其輸出會與上一次的輸出的一致。不過後面這種定製的方法更加靈活。比如，當我們把為flag.CommandLine賦值的那條語句改為
flag.CommandLine = flag.NewFlagSet("", flag.PanicOnError)
後，再運行go run demo3.go –help命令就會產生另一種輸出效果。這是由於我們在這裡傳給flag.NewFlagSet函數的第二個參數值是flag.PanicOnError。flag.PanicOnError和flag.ExitOnError都是預定義在flag包中的常量。
flag.ExitOnError的含義是，告訴命令參數容器，當命令後跟–help或者參數設置的不正確的時候，在打印命令參數使用說明後以狀態碼2結束當前程序。
狀態碼2代表用戶錯誤地使用了命令，而flag.PanicOnError與之的區別是在最後拋出「運行時恐慌（panic）」。
上述兩種情況都會在我們調用flag.Parse函數時被觸發。順便提一句，「運行時恐慌」是 Go 程序錯誤處理方面的概念。
下面再進一步，我們索性不用全局的flag.CommandLine變量，轉而自己創建一個私有的命令參數容器。我們在函數外再添加一個變量聲明：
var cmdLine = flag.NewFlagSet("question", flag.ExitOnError)
然後，我們把對flag.StringVar的調用替換為對cmdLine.StringVar調用，再把flag.Parse()替換為cmdLine.Parse(os.Args[1:])。
其中的os.Args[1:]指的就是我們給定的那些命令參數。這樣做就完全脫離了flag.CommandLine。*flag.FlagSet類型的變量cmdLine擁有很多有意思的方法。你可以去探索一下。
這樣做的好處依然是更靈活地定製命令參數容器。但更重要的是，你的定製完全不會影響到那個全局變量flag.CommandLine。
總結
如果你想詳細了解flag包的用法，可以到這個網址 //golang.google.cn/pkg/flag/ 查看文檔。或者直接使用godoc命令在本地啟動一個 Go 語言文檔服務器。怎樣使用godoc命令？你可以參看這裡 //github.com/hyper0x/go_command_tutorial/blob/master/0.5.md。
思考題
我們已經見識過為命令源碼文件傳入字符串類型的參數值的方法，那還可以傳入別的嗎？
- 默認情況下，我們可以讓命令源碼文件接受哪些類型的參數值？
- 我們可以把自定義的數據類型作為參數值的類型嗎？如果可以，怎樣做？
課程鏈接
本作品採用知識共享署名-非商業性使用-相同方式共享 4.0 國際許可協議進行許可。
歡迎轉載、使用、重新發佈，但務必保留文章署名 鄭子銘 （包含鏈接： //www.cnblogs.com/MingsonZheng/ ），不得用於商業目的，基於本文修改後的作品務必以相同的許可發佈。
