我們已經知道,環境變數 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包,
問題決議
命令原始碼檔案如此重要,以至于它毫無疑問地成為了我們學習 Go 語言的第一助手,不過,只會列印Hello, world是遠遠不夠的,咱們千萬不要成為“Hello, world”黨,既然決定學習 Go 語言,你就應該從每一個知識點深入下去,
無論是 Linux 還是 Windows,如果你用過命令列(command line)的話,肯定就會知道幾乎所有命令(command)都是可以接收引數(argument)的,通過構建或安裝命令原始碼檔案,生成的可執行檔案就可以被視為“命令”,既然是命令,那么就應該具備接收引數的能力,
下面,我就帶你深入了解一下與命令引數的接收和決議有關的一系列問題,
知識精講
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 程式錯誤處理方面的概念,關于它的拋出和恢復方法,我在本專欄的后續部分中會講到,0
下面再進一步,我們索性不用全域的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,
總結
恭喜你!你現在已經走出了 Go 語言編程的第一步,你可以用 Go 撰寫命令,并可以讓它們像眾多作業系統命令那樣被使用,甚至可以把它們嵌入到各種腳本中,
雖然我為你講解了命令原始碼檔案的基本撰寫方法,并且也談到了為了讓它接受引數而需要做的各種準備作業,但這并不是全部,
別擔心,我在后面會經常提到它的,另外,如果你想詳細了解flag包的用法,可以到這個網址查看檔案,或者直接使用godoc命令在本地啟動一個 Go 語言檔案服務器,怎樣使用godoc命令?你可以參看這里,
思考題
- 默認情況下,我們可以讓命令原始碼檔案接受哪些型別的引數值?
- 我們可以把自定義的資料型別作為引數值的型別嗎?如果可以,怎樣做?
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/252431.html
標籤:Go
