「go generate」指令的作用是在編譯前自動化產生某類程式碼;它常用於自動產生程式碼,它可以在程式碼編譯之前根據原始碼產生程式碼。當執行“go generate”命令時,它將掃描與目前套件相關的原始程式碼文件,找出所有包含“//go:generate”的特殊註釋,提取並執行該特殊註釋後面的命令。
本教學操作環境:windows7系統、GO 1.18版本、Dell G3電腦。
Go語言提供了一系列強大的工具,靈活使用這些工具,能夠讓我們的專案開發更加容易,工具集包含如下。
bug start a bug report build compile packages and dependencies clean remove object files and cached files doc show documentation for package or symbol env print Go environment information fix update packages to use new APIs fmt gofmt (reformat) package sources generate generate Go files by processing source get add dependencies to current module and install them install compile and install packages and dependencies list list packages or modules mod module maintenance run compile and run Go program test test packages tool run specified go tool version print Go version vet report likely mistakes in packages
工具的原始碼位於$GOPATH/src/cmd/internal,本篇主要討論Go工具generate。
#go generate指令是在Go語言1.4 版本裡面新加入的指令,常用於自動產生程式碼,它可以在程式碼編譯之前根據原始程式碼產生程式碼。當執行go generate時,它將掃描與目前套件相關的原始程式碼文件,找出所有包含"// go:generate"的註解語句,提取並執行該註解後的命令,命令為可執行程式。該過程類似於呼叫執行shell腳本。
//go:generate command argument...
$ go generate [-run regexp] [-n] [-v] [-x] [build flags] [file.go... | packages]
package mainimport "fmt"//go:generate echo GoGoGo!//go:generate go run main.go//go:generate echo $GOARCH $GOOS $GOFILE $GOLINE $GOPACKAGEfunc main() { fmt.Println("go rum main.go!")}
執行go generate指令
$ go generate GoGoGo!go rum main.go!amd64 darwin main.go 7 main
#為枚舉常數實作String方法
看完上述generate的簡單介紹,可能讀者並沒有感受到該工具的強大之處,小菜刀提供一個工具的經典應用場景:為枚舉常數實作String方法。
這裡需要提及官方的另一個工具stringer,它可以自動為整數常數集寫String()方法。由於stringer並不在Go官方發行版的工具集裡,我們需要自行安裝,執行以下指令。go get golang.org/x/tools/cmd/stringer
package painkillertype Pill intconst ( Placebo Pill = iota Aspirin Ibuprofen Paracetamol Acetaminophen = Paracetamol)
func (p Pill) String() string
func (p Pill) String() string { switch p { case Placebo: return "Placebo" case Aspirin: return "Aspirin" case Ibuprofen: return "Ibuprofen" case Paracetamol: // == Acetaminophen return "Paracetamol" } return fmt.Sprintf("Pill(%d)", p)}
//go:generate stringer -type=Pill
$ go generate $ cat pill_string.go // Code generated by stringer -type Pill pill.go; DO NOT EDIT. package painkillerimport "fmt"const _Pill_name = "PlaceboAspirinIbuprofenParacetamol"var _Pill_index = [...]uint8{0, 7, 14, 23, 34}func (i Pill) String() string { if i = Pill(len(_Pill_index)) { return fmt.Sprintf("Pill(%d)", i) } return _Pill_name[_Pill_index[i]:_Pill_index[i+1]]}
$ go generate
值得一提的是,在Go原始碼文件中,大量採用了go generate stringer的方案實作對枚舉常數的String方法。在小菜刀本機Go 1.14.1的源碼下,一共有23處使用,具體如下。
它們利用Go編譯器提供的函式庫,包括定義抽象語法樹的go/ast、解析抽象語法樹的go/parser、解析用於格式化程式碼的go/format、Go詞法標記的go/ token等。解析原始檔案並依照現有的範本產生新的程式碼,此過程和Web 服務中利用範本產生 HTML 檔案類似。
以上是go generate指令的作用是什麼的詳細內容。更多資訊請關注PHP中文網其他相關文章!