主要來(lái)源:《Go Web編程》
1、go build
作用:compile packages and dependencies
注:在包的編譯過(guò)程中,若有必要,會(huì)同時(shí)編譯與之相關(guān)聯(lián)的包。
示例:
-
編譯多個(gè)Go源碼文件
go build logging/base.go logging/console_logger.go -
編譯包
默認(rèn)為當(dāng)前文件夾的包
go build logging // 從GOPAT開(kāi)始尋找
| 標(biāo)記名稱(chēng) | 標(biāo)記描述 |
|---|---|
| -a | 強(qiáng)行對(duì)所有涉及到的代碼包(包含標(biāo)準(zhǔn)庫(kù)中的代碼包)進(jìn)行重新構(gòu)建,即使它們已經(jīng)是最新的了。 |
| -n | 打印編譯期間所用到的其它命令,但是并不真正執(zhí)行它們。 |
| -p n | 指定編譯過(guò)程中執(zhí)行各任務(wù)的并行數(shù)量(確切地說(shuō)應(yīng)該是并發(fā)數(shù)量)。在默認(rèn)情況下,該數(shù)量等于CPU的邏輯核數(shù)。但是在darwin/arm平臺(tái)(即iPhone和iPad所用的平臺(tái))下,該數(shù)量默認(rèn)是1。 |
| -race | 開(kāi)啟競(jìng)態(tài)條件的檢測(cè)。不過(guò)此標(biāo)記目前僅在linux/amd64、freebsd/amd64、darwin/amd64和windows/amd64平臺(tái)下受到支持。 |
| -v | 打印出那些被編譯的代碼包的名字。 |
| -work | 打印出編譯時(shí)生成的臨時(shí)工作目錄的路徑,并在編譯結(jié)束時(shí)保留它。在默認(rèn)情況下,編譯結(jié)束時(shí)會(huì)刪除該目錄。 |
| -x | 打印編譯期間所用到的其它命令。注意它與-n標(biāo)記的區(qū)別。 |
參數(shù)的介紹
-
-o指定輸出的文件名,可以帶上路徑,例如go build -o a/b/c -
-i安裝相應(yīng)的包,編譯 +go install -
-a更新全部已經(jīng)是最新的包的,但是對(duì)標(biāo)準(zhǔn)包不適用 -
-n把需要執(zhí)行的編譯命令打印出來(lái),但是不執(zhí)行,這樣就可以很容易的知道底層是如何運(yùn)行的 -
-p n指定可以并行可運(yùn)行的編譯數(shù)目,默認(rèn)是CPU數(shù)目 -
-race開(kāi)啟編譯的時(shí)候自動(dòng)檢測(cè)數(shù)據(jù)競(jìng)爭(zhēng)的情況,目前只支持64位的機(jī)器 -
-v打印出來(lái)我們正在編譯的包名 -
-work打印出來(lái)編譯時(shí)候的臨時(shí)文件夾名稱(chēng),并且如果已經(jīng)存在的話就不要?jiǎng)h除 -
-x打印出來(lái)執(zhí)行的命令,其實(shí)就是和-n的結(jié)果類(lèi)似,只是這個(gè)會(huì)執(zhí)行 - -----------------------------------------------分割線---------------------------------------------------------
-
-ccflags 'arg list'傳遞參數(shù)給5c, 6c, 8c 調(diào)用 -
-compiler name指定相應(yīng)的編譯器,gccgo還是gc -
-gccgoflags 'arg list'傳遞參數(shù)給gccgo編譯連接調(diào)用 -
-gcflags 'arg list'傳遞參數(shù)給5g, 6g, 8g 調(diào)用 -
-installsuffix suffix為了和默認(rèn)的安裝包區(qū)別開(kāi)來(lái),采用這個(gè)前綴來(lái)重新安裝那些依賴(lài)的包,-race的時(shí)候默認(rèn)已經(jīng)是-installsuffix race,大家可以通過(guò)-n命令來(lái)驗(yàn)證 -
-ldflags 'flag list'傳遞參數(shù)給5l, 6l, 8l 調(diào)用 -
-tags 'tag list'設(shè)置在編譯的時(shí)候可以適配的那些tag,詳細(xì)的tag限制參考里面的 Build Constraints
2、go clean
這個(gè)命令是用來(lái)移除當(dāng)前源碼包和關(guān)聯(lián)源碼包里面編譯生成的文件。這些文件包括
_obj/ 舊的object目錄,由Makefiles遺留
_test/ 舊的test目錄,由Makefiles遺留
_testmain.go 舊的gotest文件,由Makefiles遺留
test.out 舊的test記錄,由Makefiles遺留
build.out 舊的test記錄,由Makefiles遺留
*.[568ao] object文件,由Makefiles遺留
DIR(.exe) 由go build產(chǎn)生
DIR.test(.exe) 由go test -c產(chǎn)生
MAINFILE(.exe) 由go build MAINFILE.go產(chǎn)生
*.so 由 SWIG 產(chǎn)生
我一般都是利用這個(gè)命令清除編譯文件,然后github遞交源碼,在本機(jī)測(cè)試的時(shí)候這些編譯文件都是和系統(tǒng)相關(guān)的,但是對(duì)于源碼管理來(lái)說(shuō)沒(méi)必要。
$ go clean -i -n
cd /Users/astaxie/develop/gopath/src/mathapp
rm -f mathapp mathapp.exe mathapp.test mathapp.test.exe app app.exe
rm -f /Users/astaxie/develop/gopath/bin/mathapp
參數(shù)介紹
-
-i清除關(guān)聯(lián)的安裝的包和可運(yùn)行文件,也就是通過(guò)go install安裝的文件 -
-n把需要執(zhí)行的清除命令打印出來(lái),但是不執(zhí)行,這樣就可以很容易的知道底層是如何運(yùn)行的 -
-r循環(huán)的清除在import中引入的包 -
-x打印出來(lái)執(zhí)行的詳細(xì)命令,其實(shí)就是-n打印的執(zhí)行版本
3、gofmt
gofmt -w -l src,可以格式化整個(gè)項(xiàng)目。
gofmt的參數(shù)介紹
-
-l顯示那些需要格式化的文件 -
-w把改寫(xiě)后的內(nèi)容直接寫(xiě)入到文件中,而不是作為結(jié)果打印到標(biāo)準(zhǔn)輸出。 -
-r添加形如“a[b:len(a)] -> a[b:]”的重寫(xiě)規(guī)則,方便我們做批量替換 -
-s簡(jiǎn)化文件中的代碼 -
-d顯示格式化前后的diff而不是寫(xiě)入文件,默認(rèn)是false -
-e打印所有的語(yǔ)法錯(cuò)誤到標(biāo)準(zhǔn)輸出。如果不使用此標(biāo)記,則只會(huì)打印不同行的前10個(gè)錯(cuò)誤。 -
-cpuprofile支持調(diào)試模式,寫(xiě)入相應(yīng)的cpufile到指定的文件
4、go get
這個(gè)命令是用來(lái)動(dòng)態(tài)獲取遠(yuǎn)程代碼包的,目前支持的有BitBucket、GitHub、Google Code和Launchpad。這個(gè)命令在內(nèi)部實(shí)際上分成了兩步操作:第一步是下載源碼包,第二步是執(zhí)行go install。下載源碼包的go工具會(huì)自動(dòng)根據(jù)不同的域名調(diào)用不同的源碼工具,對(duì)應(yīng)關(guān)系如下:
BitBucket (Mercurial Git)
GitHub (Git)
Google Code Project Hosting (Git, Mercurial, Subversion)
Launchpad (Bazaar)
所以為了go get 能正常工作,你必須確保安裝了合適的源碼管理工具,并同時(shí)把這些命令加入你的PATH中。其實(shí)go get支持自定義域名的功能,具體參見(jiàn)go help remote。
參數(shù)介紹:
-
-d只下載不安裝 -
-f只有在你包含了-u參數(shù)的時(shí)候才有效,不讓-u去驗(yàn)證import中的每一個(gè)都已經(jīng)獲取了,這對(duì)于本地fork的包特別有用 -
-fix在獲取源碼之后先運(yùn)行fix,然后再去做其他的事情 -
-t同時(shí)也下載需要為運(yùn)行測(cè)試所需要的包 -
-u強(qiáng)制使用網(wǎng)絡(luò)去更新包和它的依賴(lài)包 -
-v顯示執(zhí)行的命令
5、go install
這個(gè)命令在內(nèi)部實(shí)際上分成了兩步操作:第一步是生成結(jié)果文件(可執(zhí)行文件或者.a包),第二步會(huì)把編譯好的結(jié)果移到$GOPATH/pkg或者$GOPATH/bin。
參數(shù)支持go build的編譯參數(shù)。大家只要記住一個(gè)參數(shù)-v就好了,這個(gè)隨時(shí)隨地的可以查看底層的執(zhí)行信息。
6、go test
遵循原則:
- 文件名必須以
_test.go結(jié)尾 - 文件必須
import "testing"這個(gè) testing 包 - 所有的測(cè)試用例函數(shù)名必須以
Test開(kāi)頭 - 測(cè)試函數(shù)格式:
func TestXxx (t *testing.T),Xxx部分可以為任意的字母數(shù)字的組合,但是首字母必須是大寫(xiě)字母[A-Z],例如Testintdiv是錯(cuò)誤的函數(shù)名。 - 函數(shù)中通過(guò)調(diào)用
testing.T的Error,Errorf,FailNow,Fatal,FatalIf方法來(lái)表明測(cè)試未通過(guò),調(diào)用Log方法用來(lái)記錄測(cè)試的信息。
默認(rèn)的情況下,不需要任何的參數(shù),它會(huì)自動(dòng)把你源碼包下面所有test文件測(cè)試完畢,當(dāng)然你也可以帶上參數(shù),詳情請(qǐng)參考go help testflag
常用參數(shù):
-
-bench regexp執(zhí)行相應(yīng)的壓力測(cè)試-
壓力測(cè)試用例必須遵循如下格式,其中XXX可以是任意字母數(shù)字的組合,但是首字母不能是小寫(xiě)字母
func BenchmarkXXX(b *testing.B) { ... } go test不會(huì)默認(rèn)執(zhí)行壓力測(cè)試的函數(shù),如果要執(zhí)行壓力測(cè)試需要帶上參數(shù)-bench
執(zhí)行所有測(cè)試, 使用
-bench .or-bench=. -
-
-cover開(kāi)啟測(cè)試覆蓋率如:
func Abs(a int) int { if a > 0 { return a } else { return a * (-1) } }func TestAbs(t *testing.T) { if Abs(5) != 5 { t.Fatal("abs error, except:5, result:", Abs(5)) } }這時(shí)go test -cover 會(huì)顯示
coverage: 50.0% of statements從覆蓋率來(lái)看,單元測(cè)試沒(méi)有覆蓋全部的代碼,我們可以通過(guò)如下命令將cover的詳細(xì)信息保存到cover.out中。
go test -cover -coverprofile=cover.out -covermode=count 注: -cover 允許代碼分析 -covermode 代碼分析模式(set:是否執(zhí)行;count:執(zhí)行次數(shù);atomic:次數(shù),并發(fā)執(zhí)行) -coverprofile 輸出結(jié)果文件之后通過(guò)
go tool cover -func=cover.out查看每個(gè)方法的覆蓋率。
運(yùn)行結(jié)果:util/compute.go:7: Sum 100.0% util/compute.go:15: Abs 66.7% total: (statements) 85.7%這里發(fā)現(xiàn)是Abs方法沒(méi)有覆蓋完全,因?yàn)槲覀兊挠美挥玫搅苏龜?shù)的那個(gè)分支。
還可以使用html的方式查看具體的覆蓋情況。go tool cover -html=cover.out會(huì)默認(rèn)打開(kāi)瀏覽器,將覆蓋情況顯示到頁(yè)面中:
img -run regexp只運(yùn)行regexp匹配的函數(shù),例如-run=Array那么就執(zhí)行包含有Array開(kāi)頭的函數(shù)-v顯示測(cè)試的詳細(xì)命令
Tips
-
測(cè)試單個(gè)文件
go test -v hello_test.go hello.go注意此處,如果要測(cè)試某一個(gè)文件,需要把測(cè)試文件與原文件都列出來(lái)
-
測(cè)試一個(gè)函數(shù)
go test -run TestSum此處可以使用正則匹配,例如 Sum 會(huì)匹配到所有包含Sum的函數(shù)
7、go tool
go tool下面下載聚集了很多命令,這里我們只介紹兩個(gè),fix和vet
-
go tool fix .用來(lái)修復(fù)以前老版本的代碼到新版本,例如go1之前老版本的代碼轉(zhuǎn)化到go1,例如API的變化 -
go tool vet directory|files用來(lái)分析當(dāng)前目錄的代碼是否都是正確的代碼,例如是不是調(diào)用fmt.Printf里面的參數(shù)不正確,例如函數(shù)里面提前return了然后出現(xiàn)了無(wú)用代碼之類(lèi)的。
8、go generate
這個(gè)命令是從Go1.4開(kāi)始才設(shè)計(jì)的,用于在編譯前自動(dòng)化生成某類(lèi)代碼。go generate和go build是完全不一樣的命令,通過(guò)分析源碼中特殊的注釋?zhuān)缓髨?zhí)行相應(yīng)的命令。這些命令都是很明確的,沒(méi)有任何的依賴(lài)在里面。而且大家在用這個(gè)之前心里面一定要有一個(gè)理念,這個(gè)go generate是給你用的,不是給使用你這個(gè)包的人用的,是方便你來(lái)生成一些代碼的。
這里我們來(lái)舉一個(gè)簡(jiǎn)單的例子,例如我們經(jīng)常會(huì)使用yacc來(lái)生成代碼,那么我們常用這樣的命令:
go tool yacc -o gopher.go -p parser gopher.y
-o 指定了輸出的文件名, -p指定了package的名稱(chēng),這是一個(gè)單獨(dú)的命令,如果我們想讓go generate來(lái)觸發(fā)這個(gè)命令,那么就可以在當(dāng)然目錄的任意一個(gè)xxx.go文件里面的任意位置增加一行如下的注釋?zhuān)?/p>
//go:generate go tool yacc -o gopher.go -p parser gopher.y
這里我們注意了,//go:generate是沒(méi)有任何空格的,這其實(shí)就是一個(gè)固定的格式,在掃描源碼文件的時(shí)候就是根據(jù)這個(gè)來(lái)判斷的。
所以我們可以通過(guò)如下的命令來(lái)生成,編譯,測(cè)試。如果gopher.y文件有修改,那么就重新執(zhí)行go generate重新生成文件就好。
$ go generate
$ go build
$ go test
9、godoc
在Go1.2版本之前還支持go doc命令,但是之后全部移到了godoc這個(gè)命令下,需要這樣安裝go get golang.org/x/tools/cmd/godoc
很多人說(shuō)go不需要任何的第三方文檔,例如chm手冊(cè)之類(lèi)的(其實(shí)我已經(jīng)做了一個(gè)了,chm手冊(cè)),因?yàn)樗鼉?nèi)部就有一個(gè)很強(qiáng)大的文檔工具。
如何查看相應(yīng)package的文檔呢? 例如builtin包,那么執(zhí)行godoc builtin 如果是http包,那么執(zhí)行godoc net/http 查看某一個(gè)包里面的函數(shù),那么執(zhí)行godoc fmt Printf 也可以查看相應(yīng)的代碼,執(zhí)行godoc -src fmt Printf
通過(guò)命令在命令行執(zhí)行 godoc -http=:端口號(hào) 比如godoc -http=:8080。然后在瀏覽器中打開(kāi)127.0.0.1:8080,你將會(huì)看到一個(gè)golang.org的本地copy版本,通過(guò)它你可以查詢pkg文檔等其它內(nèi)容。如果你設(shè)置了GOPATH,在pkg分類(lèi)下,不但會(huì)列出標(biāo)準(zhǔn)包的文檔,還會(huì)列出你本地GOPATH中所有項(xiàng)目的相關(guān)文檔,這對(duì)于經(jīng)常被墻的用戶來(lái)說(shuō)是一個(gè)不錯(cuò)的選擇。
10、其它命令
go還提供了其它很多的工具,例如下面的這些工具
go version 查看go當(dāng)前的版本
go env 查看當(dāng)前go的環(huán)境變量
go list 列出當(dāng)前全部安裝的package
go run 編譯并運(yùn)行Go程序
以上這些工具還有很多參數(shù)沒(méi)有一一介紹,用戶可以使用go help 命令獲取更詳細(xì)的幫助信息。