Note
-
一個module是一個go package的集合,該module用於發布的一個單位。
-
一般一個go repo僅僅包含一個module,含有一個go.mod文件
-
每個module路徑不僅僅用於作為import的前綴,也用於幫助go command來查找下載這個module,比如我們import module golang.org/x/tools,go command 還需要從https://golang.org/x/tools 這個地方下載這個module。(詳情見:https://golang.org/cmd/go/#hdr-Relative_import_paths)
go command在定位一個給定module的repo的時候,會通過https請求並且讀取HTML內嵌的元數據,(詳情見:https://golang.org/cmd/go/#hdr-Remote_import_paths),很多主句服務已經提供了go code的repo元數據信息,所以最佳設置你的module的方法通常是將你的module名和module repo URL路徑相匹配,這樣別人能夠根據module名就可以找到你的repo具體在哪。
-
每import一個包路徑,這個路徑以及其所有子路徑如果有其他包的話,都將不被包含。
比如:引入包github.com/google/go-cmp,則go-cmp/里面的cmp/.,如果想要引入cmp的包那么就需要包含github.com/google/go-cmp/cmp這個包,所包含的包沒有module前綴包含關系。 -
第一次開始創建module
$ mkdir hello # Alternatively, clone it if it already exists in version control.
$ cd hello
$ go mod init example.com/user/hello
go: creating new go.mod: module example.com/user/hello
$ cat go.mod
module example.com/user/hello
go 1.16
接着開始寫go源文件,第一行是“包名”
package main
import "fmt"
func main() {
fmt.Println("Hello, world.")
}
這樣就有了這個module的包以及內容,以及你聲明的路徑。
然后開始build 和install go tool:
go install example.com/user/hello
這個命令先編譯成一個二進制文件,然后安裝到你的PATH路徑中存bin的文件目錄中(這個具體存在哪可以通過GOPATH 和GOBIN這些go env環境變量來定)。如果GOBIN設置的話,那么就按照GOBIN設置的地方存放這個binary。
go env -w GOBIN=/somewhere/else/bin
如果取消設置環境變量可以通過 go env -w, 或者go env -u:
go env -u GOBIN
實例演示:自己編譯一個module,然后本地import並使用
- 先自己code一個包,假如這個包在本地$HOME/hello/morestrings,然后里面有一個function
func ReverseRunes(s string) string {
r := []rune(s)
for i, j := 0, len(r)-1; i < len(r)/2; i, j = i+1, j-1 {
r[i], r[j] = r[j], r[i]
}
return string(r)
}
注意:function首字母要大寫,只有首字母大寫的function才是exported.(https://golang.org/ref/spec#Exported_identifiers)
2. 然后build這個module
go build
- 在另外一個code里面去使用這個module
package main
import (
"fmt"
"example.com/user/hello/morestrings"
)
func main() {
fmt.Println(morestrings.ReverseRunes("!oG ,olleH"))
}
然后安裝引用的包,最后執行。
go install example.com/user/hello
hello
Hello, Go!
實例演示:引用一個遠程的module
現在假如我們想要引用一個遠程的module,如果這個module是通過版本控制系統比如“Git, Mercurial”等控制,go tool會自動根據路徑下載並使用這些repo,比如基於上個例子我們想使用一個遠程庫github.com/google/go-cmp/cmp 到你的項目里:
package main
import (
"fmt"
"example.com/user/hello/morestrings"
"github.com/google/go-cmp/cmp"
)
func main() {
fmt.Println(morestrings.ReverseRunes("!oG ,olleH"))
fmt.Println(cmp.Diff("Hello World", "Hello Go"))
}
現在你的項目依賴"github.com/google/go-cmp/cmp"這個包,那么你就需要下載這個包,同時你要在go.mod上面記錄你想引用這個包的版本。
go mod tidy 命令可以自動下載你引用但是沒有下載的包,同時去掉那些不在使用的。
go mod tidy
下載的包在指定的require版本其他所有版本中都是共享的,也因此go command把這些保存下載好的包的文件以及文件夾設置為只讀的,防止用戶更改下載下來的應用包。
如果想移除所有下載好的包,可以通過
go clean -modcache
實例演示:testing 包(詳情見https://golang.org/cmd/go/#hdr-Test_packages testing 包doc:https://golang.org/pkg/testing/)
-
testing包的測試文件可以通過go test命令來測試
-
你寫的go 代碼
以 _test.go結尾的;
函數名是Test***
並且有 func(t *testing.T)為函數簽名的function
全部被視為test代碼。 -
testfunction中如果調用t.Error or t.Fail,這時候就認為測試失敗,現在看看下面測試ReverseRunes的例子。
注意:
文件名:$HOME/hello/morestrings/reverse_test.go
函數簽名:func TestReverseRunes(t *testing.T)
package morestrings
import "testing"
func TestReverseRunes(t *testing.T) {
cases := []struct {
in, want string
}{
{"Hello, world", "dlrow ,olleH"},
{"Hello, 世界", "界世 ,olleH"},
{"", ""},
}
for _, c := range cases {
got := ReverseRunes(c.in)
if got != c.want {
t.Errorf("ReverseRunes(%q) == %q, want %q", c.in, got, c.want)
}
}
}
然后執行test代碼:
go test
PASS
ok example.com/user/morestrings 0.165s