Go語言核心36講（Go語言基礎知識二）--學習筆記

MingsonZheng發表於2021-10-13

Go筆記

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包的用法，可以到這個網址 https://golang.google.cn/pkg/flag/ 檢視文件。或者直接使用godoc命令在本地啟動一個 Go 語言文件伺服器。怎樣使用godoc命令？你可以參看這裡 https://github.com/hyper0x/go_command_tutorial/blob/master/0.5.md。