第10章 包和工具

現在隨便一個小程序可能就包含10000個函數，但是我們不可能一個個去構建，大部分還是來自于他人，這些函數通過類似包和模塊的方式被重用

go語言的包超過100個，可以在終端中使用go list std ｜wc -l去查看，開源包可以通過http：//godoc.org來檢索

go帶了一個工具包里面有各種簡化工作區和包管理的小工具

10.7 工具

現在我們再來看看go語言工具箱中的具體功能，包括如何下載、格式化、構建、測試和安裝Go語言編寫的程序

Go語言的工具箱集合了一系列功能的命令集，它是一個包管理器，可以查詢包、計算包的依賴關系、從遠程版本控制系統下載包；它也是一個構建系統，計算文件的依賴關系，然后調用編譯器、匯編器和連接器構建程序；另外它也是一個單元測試和基準測試的驅動程序，我們將在下一章討論這個問題

我們運行一下go命令，看看工具

% go Go is a tool for managing Go source code.Usage:go <command> [arguments]The commands are:bug start a bug reportbuild compile packages and dependenciesclean remove object files and cached filesdoc show documentation for package or symbolenv print Go environment informationfix update packages to use new APIsfmt gofmt (reformat) package sourcesgenerate generate Go files by processing sourceget add dependencies to current module and install theminstall compile and install packages and dependencieslist list packages or modulesmod module maintenancerun compile and run Go programtest test packagestool run specified go toolversion print Go versionvet report likely mistakes in packagesUse "go help <command>" for more information about a command.Additional help topics:buildconstraint build constraintsbuildmode build modesc calling between Go and Ccache build and test cachingenvironment environment variablesfiletype file typesgo.mod the go.mod filegopath GOPATH environment variablegopath-get legacy GOPATH go getgoproxy module proxy protocolimportpath import path syntaxmodules modules, module versions, and moremodule-get module-aware go getmodule-auth module authentication using go.sumpackages package lists and patternsprivate configuration for downloading non-public codetestflag testing flagstestfunc testing functionsvcs controlling version control with GOVCSUse "go help <topic>" for more information about that topic

為了達到零配置的設計目標，Go語言的工具箱很多地方都依賴各種約定。例如，根據給定的源文件名稱，Go語言的工具可以找到源文件對應的包，因為每個目錄只包含了單一的包，并且包的導入路徑和工作區的目錄結構是對應的，給定一個包的導入路徑，Go語言的工具可以找到與之對應的儲存著實體文件的目錄。它還可以跟俊導入路徑找到存儲代碼倉庫的遠程服務器URL

10.7.1 工作區結構

對于大多數的Go用戶來說只需要配置GOPATH的環境 變量就可指定當前的工作目錄

$ export GOPATH=$HOME/gobook $ go get gopl.io/...

按照上述邏輯下載源碼應該是如下的目錄結構

GOPATH/src/gopl.io/.git/ch1/helloworld/main.godup/main.go...golang.org/x/net/.git/html/parse.gonode.go...bin/helloworldduppkg/darwin_amd64/...

GOPATH對應的工作區域有三個子目錄：src/bin/pkg。src存放源代碼，bin存放編譯后可執行的程序，pkg用于保存編譯后的包的目標文件

第二個環境變量GOROOT用來指定Go的安裝目錄，還有它自帶的標準庫包的位置

其中go env命令用于查看go語言工具涉及所有環境變量的值，包括未設置環境變量的默認值

$ go env GOPATH="/home/gopher/gobook" GOROOT="/usr/local/go" GOARCH="amd64" GOOS="darwin" ...

10.7.2 下載包

使用Go語言工具箱的Go命令，不僅可以根據包導入路徑找到本地工作區的包，甚至可以從互聯網上找到并且更新包

使用 go get 可以下載一個單一的包或者用…下載整個子目錄里面的每個包，go命令會同時計算并下載所有依賴的包

一旦包被下載，接著就是安裝包或包對應的可執行程序

下載過程：第一個命令是獲取golint工具，它用于檢測Go源代碼的編程風格是否有問題，第二個命令是用golint命令對包代碼進行編碼風格檢查，它友好的報告了忘記了包的文檔

$ go get github.com/golang/lint/golint $ $GOPATH/bin/golint gopl.io/ch2/popcount src/gopl.io/ch2/popcount/main.go:1:1:package comment should be of the form "Package popcount ..."

go get 命令支持當前流行的托管網站GitHub、Bitbucket和Launchpad，可以直接向他們的版本控制系統請求代碼

對于其他網站，我們可能需要指定版本控制系統的具體路徑和協議，例如Git或Mercurial。運行go help importpath獲取相關的信息

go get命令獲取的代碼是真實的本地存儲倉庫，而不僅僅只是復制源文件，因此可以使用版本管理工具進行不同版本的切換。例如golang.org/x/net包目錄對應一個Git倉庫

$ cd $GOPATH/src/golang.org/x/net $ git remote -v origin https://go.googlesource.com/net (fetch) origin https://go.googlesource.com/net (push)

注意：導入路徑含有網站域名，這個和本地Git倉庫對應遠程服務地址并不相同，真實的地址是go.googlesource.com.這是Go語言工具的一個特性，讓包用一個自定義的導入路徑，真實的代碼由更通用的服務提供，例如googlesource.com或github.com

如下頁面https：//golang.org/x/net/html包含了如下的元數據，它告訴Go語言的工具當前包真實的Git倉庫托管地址

$ go build gopl.io/ch1/fetch $ ./fetch https://golang.org/x/net/html | grep go-import <meta name="go-import"content="golang.org/x/net git https://go.googlesource.com/net">

指定-u 命令行參數， go get命令將確保包和依賴的包都是最新版本，如果指定，存在于本地的包則不會更新到最新版本

但是對于發布程序，本地程序可能需要對依賴的包進行精細化的管理。一般解決方法是使用vendor的目錄用于存儲依賴包的固定版本的源代碼，對本地依賴的包的版本更新也是謹慎和持續可控的

10.7.3 構建包

go build命令編譯命令行參數指定的每一個包

如果包是一個庫，則忽略輸出結果，這可以檢測包是否是正確編譯。如果包的名字是main，go build將調用鏈接器在當前目錄創建一個可執行程序；以導入路徑的最后一段作為可執行程序的名字

由于每個目錄只包含一個包，因此每個對應可執行程序或者叫Unix術語中的命令的包，會要求放到一個獨立的目錄中。這些目錄有時候會放在名叫cmd目錄的子目錄下面，例如用于提供Go文檔服務的golang.org/x/tools/cmd/godoc命令就是放在cmd子目錄

每個包可以由它們的導入路徑指定，就像前面提到的那樣，或者用一個相對目錄的路徑名指定，相對路徑必須以.或…開頭，如果沒有指定參數，那么默認指定為當前目錄對應的包。下面的命令用于構建同一個包，雖然它們寫法各不相同

$ cd $GOPATH/src/gopl.io/ch1/helloworld $ go build 或者：$ cd anywhere $ go build gopl.io/ch1/helloworld 或者：$ cd $GOPATH $ go build ./src/gopl.io/ch1/helloworld 但不能這樣：$ cd $GOPATH $ go build src/gopl.io/ch1/helloworld Error: cannot find package "src/gopl.io/ch1/helloworld".

也可以指定包的源文件列表，這一般只用于構建一些小程序，或者做一些臨時性的實驗。如果是main包，將會以第一個Go源文件的基礎文件名作為最終的可執行程序的名字

$ cat quoteargs.go package mainimport ("fmt""os" )func main() {fmt.Printf("%q\n", os.Args[1:]) } $ go build quoteargs.go $ ./quoteargs one "two three" four\ five ["one" "two three" "four five"] 特別是對于這類一次性運行的程序，我們希望盡快的構建并運行它。go run命令實際上是結合了構建和運行的兩個步驟：$ go run quoteargs.go one "two three" four\ five ["one" "two three" "four five"]

其實也可以偷懶，直接go run *.go

默認情況下，go build用于構建指定的包和依賴的包，但會丟棄除可執行文件之外的所有中間編譯結果

go install 則會保存中間編譯結果

編譯對應不同的操作系統平臺和CPU架構，go install 命令會將編譯結果安裝到GOOS和GOARCH對應的目錄

針對不同的操作系統或CPU交叉構建也很簡單，只需設置好目標對應的GOOS和GOARCH，然后運行構建命令即可，下面交叉編譯的程序將輸出它在編譯時的操作系統和CPU類型

func main（）{fmt.Println(runtime.GOOS,runtime.GOARCH) }

下面以64位和32位環境分別編譯和執行

$ go build gopl.io/ch10/cross $ ./cross darwin amd64 $ GOARCH=386 go build gopl.io/ch10/cross $ ./cross darwin 386

更多的細節可以查看文檔

go doc go/build

10.7.4 包文檔

Go語言的編碼風格鼓勵為每個包提供良好的文檔，包成員和包的目的和用法都應該在導出前注釋好

注釋是完整的句子，如下

// Fprintf formats according to a format specifier and writes to w. // It returns the number of bytes written and any write error encountered. func Fprintf(w io.Writer, format string, a ...interface{}) (int, error)

當包的注釋比較多則可以放到另一個文件中

使用go doc 包名/成員名/方法名可以查看，如下

go doc time go doc time.Since go doc time.Duration.Seconds

這個命令并不需要輸入完整導入路徑或者正確的大小寫

go doc json.decode package json // import "encoding/json"func (dec *Decoder) Decode(v interface{}) errorDecode reads the next JSON-encoded value from its input and stores it in thevalue pointed to by v.See the documentation for Unmarshal for details about the conversion of JSONinto a Go value.

第二個工具godoc 可以提供相互交叉引用的HTML頁面，但是包含和go doc命令相似以及更多的信息。godoc的在線服務 https://godoc.org ，包含了成千上萬的開源包的檢索工具

10.7.5 內部包

在Go語言中，包是最重要的封裝機制

為了滿足我們對于包的可見性的控制，我們使用Go語言的構建工具對包含的internal名字的路徑段的包導入路徑做了特殊處理。這種包叫做internal包，一個internal包只能被和internal目錄有一個同父目錄的包所導入，例如，net/http/internal/chunked內部包只能被net/http/httputil或net/http包導入，但是不能被net/url包導入，不過net/url包可以導入net/http/httputil包

net/http net/http/internal/chunked net/http/httputil net/url

10.7.6 查詢包

go list可以查詢可用包的信息

其最簡單的形式，可以測試包是否在工作區并打印它的導入路徑：$ go list github.com/go-sql-driver/mysql github.com/go-sql-driver/mysql

go list命令的參數還可以用"..."表示匹配任意的包的導入路徑。我們可以用它來列出工作區中的所有包：

$ go list ... archive/tar archive/zip bufio bytes cmd/addr2line cmd/api ...many more... 或者是特定子目錄下的所有包：$ go list gopl.io/ch3/... gopl.io/ch3/basename1 gopl.io/ch3/basename2 gopl.io/ch3/comma gopl.io/ch3/mandelbrot gopl.io/ch3/netflag gopl.io/ch3/printints gopl.io/ch3/surface 或者是和某個主題相關的所有包:$ go list ...xml... encoding/xml gopl.io/ch7/xmlselect go list命令還可以獲取每個包完整的元信息，而不僅僅只是導入路徑，這些元信息可以以不同格式提供給用戶。其中-json命令行參數表示用JSON格式打印每個包的元信息。$ go list -json hash {"Dir": "/home/gopher/go/src/hash","ImportPath": "hash","Name": "hash","Doc": "Package hash provides interfaces for hash functions.","Target": "/home/gopher/go/pkg/darwin_amd64/hash.a","Goroot": true,"Standard": true,"Root": "/home/gopher/go","GoFiles": ["hash.go"],"Imports": ["io"],"Deps": ["errors","io","runtime","sync","sync/atomic","unsafe"] } 命令行參數-f則允許用戶使用text/template包（§4.6）的模板語言定義輸出文本的格式。下面的命令將打印strconv包的依賴的包，然后用join模板函數將結果鏈接為一行，連接時每個結果之間用一個空格分隔：$ go list -f '{{join .Deps " "}}' strconv errors math runtime unicode/utf8 unsafe 上面的命令在Windows的命令行運行會遇到template: main:1: unclosed action的錯誤。產生這個錯誤的原因是因為命令行對命令中的" "參數進行了轉義處理。可以按照下面的方法解決轉義字符串的問題：$ go list -f "{{join .Deps \" \"}}" strconv 下面的命令打印compress子目錄下所有包的導入包列表：$ go list -f '{{.ImportPath}} -> {{join .Imports " "}}' compress/... compress/bzip2 -> bufio io sort compress/flate -> bufio fmt io math sort strconv compress/gzip -> bufio compress/flate errors fmt hash hash/crc32 io time compress/lzw -> bufio errors fmt io compress/zlib -> bufio compress/flate errors fmt hash hash/adler32 io

Windows下有同樣有問題，要避免轉義字符串的干擾：

$ go list -f "{{.ImportPath}} -> {{join .Imports \" \"}}" compress/...

go list命令對于一次性的交互式查詢或自動化構建或測試腳本都很有幫助。我們將在11.2.4節中再次使用它。每個子命令的更多信息，包括可設置的字段和意義，可以用go help list命令查看。

在本章，我們解釋了Go語言工具中除了測試命令之外的所有重要的子命令。

在下一章，我們將看到如何用go test命令去運行Go語言程序中的測試代碼

總結

以上是生活随笔為你收集整理的Go语言圣经 - 第10章 包和工具 - 10.7 工具的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。