Go 項(xiàng)目中代碼組織的兩種模式
這是一篇基礎(chǔ)文章,主要幫新手解決 GOPATH 和 Go Module 的問題。希望這篇文章能夠?yàn)槟銖氐捉饣蟆1疚淖髡撸篕ade。
本文的行文風(fēng)格跟普通的文章不一樣,是一種沉浸式的、筆記式的、或者視頻稿的風(fēng)格。不知道你是否會喜歡。
注: 本文基于 go1.16, macOS 環(huán)境
01 相關(guān)概念梳理
注: 詳細(xì)的可以完整閱讀 Go 官方文檔及 Wiki, 為了通俗一點(diǎn), 文中某些描述可能不是很嚴(yán)謹(jǐn)!
首先需要清楚 Go 項(xiàng)目中包(package)和模塊(module)的概念, 簡單描述一下:
- 包(package)是用來管理 .go 文件的, 相關(guān)概念: 包目錄, 包名, 包路徑/包導(dǎo)入路徑/導(dǎo)入路徑
它是源代碼的集合, 由一個或多個源文件組成: 一個目錄最多只能有一個包, 一個包只能存在于一個目錄
- 模塊(module)是用來管理包的, 相關(guān)概念: 模塊目錄, 模塊路徑
它是包的集合, 由零個或多個包組成: 一個目錄最多只能有一個模塊, 一個模塊只能存在于一個目錄 ; 一個模塊目錄里必須要有g(shù)o.mod文件
02 代碼組織的兩種模式
注: 文中描述模式時使用小寫(強(qiáng)迫癥); 相關(guān)的發(fā)展歷史可在社區(qū)了解
- GOPATH mode(gopath模式): 通過配置 GO111MODULE=off 強(qiáng)制開啟
- $GOPATH默認(rèn)為用戶家目錄下的go目錄, 即 ~/go
- $GOPATH可以設(shè)置多個目錄, 可以實(shí)現(xiàn)依賴包存放在一個目錄, 自己項(xiàng)目的包存放在另外一個目錄
- 包需要存放在$GOPATH/src下的子目錄中, 包目錄相對于$GOPATH/src的相對路徑則為包的導(dǎo)入路徑
- 習(xí)慣上, 包所在的目錄名與包名相同(不是必須)
- 使用go get下載的包也是存放在$GOPATH/src目錄中
- 依賴包可以放在vendor目錄中
- 沒有模塊相關(guān)的概念
- module mode(gomod模式): 通過配置GO111MODULE=on強(qiáng)制開啟
- $GOPATH默認(rèn)為用戶家目錄下的go目錄, 即 ~/go
- 模塊目錄可以是任何目錄, 包必須在某個模塊中
- 模塊路徑需要在模塊目錄下的 go.mod 文件中使用module指令指定
- 習(xí)慣上, 模塊下的包所在的目錄名與包名相同(不是必須)
- 使用go get下載的包存放在$GOPATH/pkg/mod下的相關(guān)目錄中
- 通過 go 命令的參數(shù)-mod=vendor可以支持 main 包下的vendor目錄
- 有模塊相關(guān)的概念及配置, 比如: GOPROXY, GOPRIVATE, GOSUMDB等
注: GO111MODULE配置還有一個值是auto, 意思是具體 go 使用哪一種模式由 go 來判斷并決定, 不同版本的判斷不同, 效果不同, 所有建議使用 go 之前先明確設(shè)置GO111MODULE的值為 off 或者 on
注: gomod 模式中只保留了部分的 vendor 特性支持, 不建議日常開發(fā)中使用, 一般用作依賴存檔或 CI/CD 使用
注: gopath 模式基本廢棄, 不建議再使用, 如果有老項(xiàng)目仍在使用, 建議著手遷移到 gomod 模式, 如果遷移有問題, 可以在社區(qū)交流討論, 或向官方求助
03 兩種模式的使用示例
gopath 模式(官方已經(jīng)準(zhǔn)備廢棄,不建議使用)
1.開啟gopath模式, 設(shè)置GO111MODULE值為off
- MacBook$ # 1. 設(shè)置
- MacBook$ export GO111MODULE=off
- MacBook$ # 需要永久配置的話, 需要修改相關(guān)的配置文件
- MacBook$ # 比如: ~/.bash_profile 或 ~/.bashrc 等
- MacBook$ #
- MacBook$ # 建議使用下面的方法:
- MacBook$ go env -w GO111MODULE=off
- MacBook$ # 2. 驗(yàn)證
- MacBook$ go env GO111MODULE
- off
- MacBook$
2.根據(jù)需要設(shè)置GOPATH, 默認(rèn)值為~/go, 建議使用默認(rèn)(這里為了演示設(shè)置了其他目錄)
- MacBook$ # 1. 設(shè)置
- MacBook$ export GOPATH=/Users/kadefor/examples/gopath_mode
- MacBook$ # 同上建議:
- MacBook$ go env -w GOPATH=/Users/kadefor/examples/gopath_mode
- MacBook$ # 2. 驗(yàn)證
- MacBook$ go env GOPATH
- /Users/kadefor/examples/gopath_mode
- MacBook$
3.日常開發(fā)(使用labstack/echo這個 web 開發(fā)框架為例)
- MacBook$ go env GO111MODULE
- off
- MacBook$ go env GOPATH
- /Users/kadefor/examples/gopath_mode
- MacBook$ pwd
- /Users/kadefor/examples/gopath_mode/src
- MacBook$ tree .
- .
- └── github.com
- └── myrepo
- └── helloworld
- └── main.go
- 3 directories, 1 file
- MacBook$ cd github.com/myrepo/helloworld/
- MacBook$
- MacBook$ # 項(xiàng)目代碼放在`GOPATH/src`下, 一般是放在某個子目錄里
- MacBook$ # 相對于`GOPATH/src`的相對目錄路徑即為包導(dǎo)入路徑
- MacBook$ # 比如說, 有一個包c(diǎn)c在src目錄下的`aa/bb/cc`目錄里
- MacBook$ # 那它的導(dǎo)入路徑就是"aa/bb/cc"
- MacBook$
- MacBook$ # 這里github.com/myrepo/helloworld目錄下有個main包:
- MacBook$ pwd
- /Users/kadefor/examples/gopath_mode/src/github.com/myrepo/helloworld
- MacBook$ ls
- main.go
- MacBook$ head -8 main.go
- package main
- import (
- "github.com/labstack/echo"
- "github.com/labstack/echo/middleware"
- "net/http"
- )
- MacBook$ # gopath模式下, go找包會在`GOROOT`, `GOPATH/src`, vendor目錄下去找
- MacBook$ # 比如這里導(dǎo)入的"github.com/labstack/echo"
- MacBook$ # 運(yùn)行看看:
- MacBook$ go run .
- main.go:4:2: cannot find package "github.com/labstack/echo" in any of:
- /Users/kadefor/sdk/go/src/github.com/labstack/echo (from $GOROOT)
- /Users/kadefor/examples/gopath_mode/src/github.com/labstack/echo (from $GOPATH)
- main.go:5:2: cannot find package "github.com/labstack/echo/middleware" in any of:
- /Users/kadefor/sdk/go/src/github.com/labstack/echo/middleware (from $GOROOT)
- /Users/kadefor/examples/gopath_mode/src/github.com/labstack/echo/middleware (from $GOPATH)
- MacBook$ # 現(xiàn)在就需要下載依賴的包
- MacBook$ # 方法一般有:
- MacBook$ # 1. go get github.com/labstack/echo 它還會同時下載相應(yīng)的依賴包, 簡單
- MacBook$ # 但是, 某些包可能因?yàn)榫W(wǎng)絡(luò)原因訪問不了 - -! 可以掛代理
- MacBook$ # 2. 想辦法把包下載回來解壓到`GOPATH/src`目錄里, 并保留包目錄的結(jié)構(gòu)
- MacBook$ # 比如git clone或者去github上點(diǎn)鼠標(biāo)下載并解壓到`GOPATH/src`目錄里
- MacBook$ # 3. 使用第三方的包管理工具, 比如dep, govendor等
- MacBook$ # 第三方包管理工具一般是使用vendor特性, 并支持維護(hù)包的版本
- MacBook$ # 這樣的工具在gopath模式里使用比較多, 因?yàn)? go get的方法不支持包版本!
- MacBook$ # 現(xiàn)在我掛代理使用go get
- MacBook$ export https_proxy=http://127.0.0.1:7890 http_proxy=http://127.0.0.1:7890 all_proxy=socks5://127.0.0.1:7890
- MacBook$ tree `go env GOPATH`/src -L 3
- /Users/kadefor/examples/gopath_mode/src
- └── github.com
- └── myrepo
- └── helloworld
- 3 directories, 0 files
- MacBook$ go get -v -u -d github.com/labstack/echo
- github.com/labstack/echo (download)
- MacBook$ tree `go env GOPATH`/src -L 3
- /Users/kadefor/examples/gopath_mode/src
- ├── github.com
- │ ├── labstack
- │ │ ├── echo
- │ │ └── gommon
- │ ├── mattn
- │ │ ├── go-colorable
- │ │ └── go-isatty
- │ ├── myrepo
- │ │ └── helloworld
- │ └── valyala
- │ └── fasttemplate
- └── golang.org
- └── x
- ├── crypto
- ├── net
- ├── sys
- └── text
- 17 directories, 0 files
- MacBook$ # 其他多出來的就是labstack/echo的依賴包
- MacBook$ # 現(xiàn)在運(yùn)行:
- MacBook$ go run .
- ../../labstack/echo/middleware/jwt.go:9:2: cannot find package "github.com/dgrijalva/jwt-go" in any of:
- /Users/kadefor/sdk/go/src/github.com/dgrijalva/jwt-go (from $GOROOT)
- /Users/kadefor/examples/gopath_mode/src/github.com/dgrijalva/jwt-go (from $GOPATH)
- ../../labstack/echo/middleware/rate_limiter.go:9:2: cannot find package "golang.org/x/time/rate" in any of:
- /Users/kadefor/sdk/go/src/golang.org/x/time/rate (from $GOROOT)
- /Users/kadefor/examples/gopath_mode/src/golang.org/x/time/rate (from $GOPATH)
- MacBook$ # 暈! 還有一個包沒下載!
- MacBook$
- MacBook$ grep 'echo/middleware' main.go
- "github.com/labstack/echo/middleware"
- MacBook$ go get -v -d github.com/labstack/echo/middleware
- github.com/dgrijalva/jwt-go (download)
- get "golang.org/x/time/rate": found meta tag vcs.metaImport{Prefix:"golang.org/x/time", VCS:"git", RepoRoot:"https://go.googlesource.com/time"} at //golang.org/x/time/rate?go-get=1
- get "golang.org/x/time/rate": verifying non-authoritative meta tag
- golang.org/x/time (download)
- MacBook$ # 再來:
- MacBook$ go run .
- ⇨ http server started on [::]:1323
- ^Csignal: interrupt
- MacBook$ # 項(xiàng)目已經(jīng)運(yùn)行起來了, 下面再演示一下自己項(xiàng)目下的其他包的使用
- MacBook$ pwd
- /Users/kadefor/examples/gopath_mode/src/github.com/myrepo/helloworld
- MacBook$ ls
- main.go
- MacBook$ mkdir abc
- MacBook$ pwd
- /Users/kadefor/examples/gopath_mode/src/github.com/myrepo/helloworld
- MacBook$ cd abc
- MacBook$ pwd
- /Users/kadefor/examples/gopath_mode/src/github.com/myrepo/helloworld/abc
- MacBook$ # 怎么用這個包呢? 導(dǎo)入路徑是什么?
- MacBook$ # 相對于src的相對路徑就是abc這個包的導(dǎo)入路徑:
- MacBook$ # github.com/myrepo/helloworld/abc
- MacBook$ cat abc.go
- package abc
- import "fmt"
- func Print() {
- fmt.Println("GOPATH mode: Hello, ABC")
- }
- MacBook$ cd ..
- MacBook$ cat main.go
- package main
- import (
- "github.com/myrepo/helloworld/abc"
- "github.com/labstack/echo"
- "github.com/labstack/echo/middleware"
- "net/http"
- )
- func main() {
- abc.Print()
- e := echo.New()
- e.Use(middleware.Logger())
- e.Use(middleware.Recover())
- e.GET("/", hello)
- e.Logger.Fatal(e.Start(":1323"))
- }
- func hello(c echo.Context) error {
- return c.String(http.StatusOK, "Hello, World!")
- }
- MacBook$ cd ..
- MacBook$ go run main.go
- GOPATH mode: Hello, ABC
- ⇨ http server started on [::]:1323
- ^Csignal: interrupt
- MacBook$ # 接下來演示一下vendor
- MacBook$ pwd
- /Users/kadefor/examples/gopath_mode/src/github.com/myrepo/helloworld
- MacBook$ mkdir vendor
- MacBook$ mkdir -p vendor/github.com/myrepo/helloworld/
- MacBook$ cp -a abc vendor/github.com/myrepo/helloworld/
- MacBook$ # 改一下vendor下abc那個包, 看看效果
- MacBook$ vim vendor/github.com/myrepo/helloworld/abc/abc.go
- MacBook$ tree .
- .
- ├── abc
- │ └── abc.go
- ├── main.go
- └── vendor
- └── github.com
- └── myrepo
- └── helloworld
- └── abc
- └── abc.go
- 6 directories, 3 files
- MacBook$ cat abc/abc.go
- package abc
- import "fmt"
- func Print() {
- fmt.Println("GOPATH mode: Hello, ABC")
- }
- MacBook$ cat vendor/github.com/myrepo/helloworld/abc/abc.go
- package abc
- import "fmt"
- func Print() {
- fmt.Println("GOPATH mode vendor: Hello, ABC")
- }
- MacBook$ # 運(yùn)行后輸出什么呢?
- MacBook$ go run .
- GOPATH mode vendor: Hello, ABC
- ⇨ http server started on [::]:1323
- ^Csignal: interrupt
- MacBook$ # 我們也可以把所有的依賴包都放到vendor目錄下
- MacBook$ # 這樣的作用是:
- MacBook$ # 1. 可以把依賴存檔, 就算源倉庫刪除了, 我們的項(xiàng)目同樣可以運(yùn)行
- MacBook$ # 2. 保存我們自己修改后的第三方包
- MacBook$ #
- MacBook$ # 但是手動去做太麻煩了, 所以在gopath模式中一般會使用第三方的包管理工具
- MacBook$ # 使用主流的第三方包管理工具還有一個好處是: 遷移到gomod模式比較簡單!
- MacBook$
gomod 模式(官方建議使用)
1.開啟gomod模式, 設(shè)置GO111MODULE值為on
- MacBook$ # 1. 設(shè)置
- MacBook$ export GO111MODULE=on
- MacBook$ # 需要永久配置的話, 需要修改相關(guān)的配置文件
- MacBook$ # 比如: ~/.bash_profile 或 ~/.bashrc 等
- MacBook$ #
- MacBook$ # 建議使用下面的方法:
- MacBook$ go env -w GO111MODULE=on
- MacBook$
- MacBook$ # 2. 驗(yàn)證
- MacBook$ go env GO111MODULE
- on
- MacBook$
2.根據(jù)需要設(shè)置GOPATH, 默認(rèn)值為~/go, 建議使用默認(rèn)(這里為了演示設(shè)置了其他目錄)
- MacBook$ # 1. 設(shè)置
- MacBook$ export GOPATH=/Users/kadefor/examples/gomod_mode
- MacBook$ # 同上建議:
- MacBook$ go env -w GOPATH=/Users/kadefor/examples/gomod_mode
- MacBook$
- MacBook$ # 2. 驗(yàn)證
- MacBook$ go env GOPATH
- /Users/kadefor/examples/gomod_mode
- MacBook$
3.設(shè)置GOPROXY
- MacBook$ # 1. 設(shè)置
- MacBook$ export GOPROXY=https://goproxy.cn,direct
- MacBook$ # 同上建議:
- MacBook$ go env -w GOPROXY=https://goproxy.cn,direct
- MacBook$
- MacBook$ # 有官方的proxy, 但是網(wǎng)絡(luò)原因訪問不了
- MacBook$ # 使用proxy的好處:
- MacBook$ # 1. 一般公共的proxy都會上CDN, 模塊下載速度快
- MacBook$ # 2. proxy相當(dāng)于一個中心化的模塊版本鏡像, 只要proxy上的緩存不刪除
- MacBook$ # 就算源倉庫刪除了, 項(xiàng)目還是可以構(gòu)建
- MacBook$ #
- MacBook$ # 公司內(nèi)部如果私有模塊比較多, 比較復(fù)雜, 可以自建proxy
- MacBook$ # 由自建的proxy去控制哪些模塊是私有的, 哪些是公有的
- MacBook$ # 這樣對于公司內(nèi)部的開發(fā)來說是透明的, 不需要再關(guān)注私有模塊
- MacBook$ #
日常開發(fā)(使用labstack/echo這個 web 開發(fā)框架為例)
- MacBook$ pwd
- /tmp/helloworld
- MacBook$ # 使用gomod模式后, 項(xiàng)目就可以隨便放在某個目錄了, 但是, 項(xiàng)目必須在某個模塊內(nèi)
- MacBook$ # 如果是新建的項(xiàng)目, 需要自己創(chuàng)建項(xiàng)目所在模塊
- MacBook$ go mod init github.com/myrepo/helloworld
- go: creating new go.mod: module github.com/myrepo/helloworld
- go: to add module requirements and sums:
- go mod tidy
- MacBook$ cat go.mod
- module github.com/myrepo/helloworld
- go 1.16
- MacBook$ # 這里指定的模塊路徑為 github.com/myrepo/helloworld
- MacBook$ # 也可以指定其他的, 比如 abc, xxx/ooo 等等
- MacBook$ # 也有限制, 有幾個特殊的不行, 哪些? 自己找找 :-)
- MacBook$
- MacBook$ # 這個模塊路徑一般和源碼倉庫的路徑一致
- MacBook$ # 這個模塊路徑會做為模塊目錄下包的導(dǎo)入路徑的前綴
- MacBook$ # 比如, 如果當(dāng)前模塊下有個包abc, 則這個包的導(dǎo)入路徑為:
- MacBook$ # github.com/myrepo/helloworld/abc
- MacBook$ vim main.go
- MacBook$ cat main.go
- package main
- import (
- "github.com/labstack/echo/v4"
- "github.com/labstack/echo/v4/middleware"
- "net/http"
- )
- func main() {
- e := echo.New()
- e.Use(middleware.Logger())
- e.Use(middleware.Recover())
- e.GET("/", hello)
- e.Logger.Fatal(e.Start(":1323"))
- }
- func hello(c echo.Context) error {
- return c.String(http.StatusOK, "Hello, World!")
- }
- MacBook$ cat go.mod
- module github.com/myrepo/helloworld
- go 1.16
- MacBook$ # 使用gomod模式的話, 代碼寫好了, 可以執(zhí)行下面命令, 自動下載依賴:
- MacBook$ # 不需要手動一個一個去下載, 直接執(zhí)行:
- MacBook$ go mod tidy
- go: finding module for package github.com/labstack/echo/v4/middleware
- go: finding module for package github.com/labstack/echo/v4
- go: downloading github.com/labstack/echo/v4 v4.2.0
- go: found github.com/labstack/echo/v4 in github.com/labstack/echo/v4 v4.2.0
- go: found github.com/labstack/echo/v4/middleware in github.com/labstack/echo/v4 v4.2.0
- go: downloading github.com/labstack/gommon v0.3.0
- go: downloading golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a
- go: downloading golang.org/x/net v0.0.0-20200822124328-c89045814202
- go: downloading github.com/stretchr/testify v1.4.0
- go: downloading github.com/dgrijalva/jwt-go v3.2.0+incompatible
- go: downloading golang.org/x/time v0.0.0-20201208040808-7e3f01d25324
- go: downloading github.com/mattn/go-colorable v0.1.7
- go: downloading github.com/mattn/go-isatty v0.0.12
- go: downloading gopkg.in/yaml.v2 v2.2.2
- go: downloading golang.org/x/sys v0.0.0-20200826173525-f9321e4c35a6
- go: downloading golang.org/x/text v0.3.3
- MacBook$ # 使用gomod模式的話, 你用的依賴可能有不同的主版本號, 如果是大于等于2, 則在導(dǎo)入路徑后面得加上 /v2 /v3 /v4 等
- MacBook$
- MacBook$ # 我想用labstack/echo的v4版本, 則導(dǎo)入路徑為: github.com/labstack/echo/v4
- MacBook$ # 現(xiàn)在看看go.mod
- MacBook$ cat go.mod
- module github.com/myrepo/helloworld
- go 1.16
- require github.com/labstack/echo/v4 v4.2.0
- MacBook$ # 運(yùn)行
- MacBook$ go run .
- v4.2.0
- High performance, minimalist Go web framework
- ⇨ http server started on [::]:1323
- ^Csignal: interrupt
- MacBook$ # 使用gomod模式還是簡單, 只要你的依賴不奇葩 :D
- MacBook$
- MacBook$ # 如果你使用支持自動補(bǔ)全的編輯器或者IDE, 但它不會自動下載依賴(一般都會), 如果模塊沒有提前下載, 則自動補(bǔ)全無法正常使用
- MacBook$ # 或者你需要使用模塊特定的版本
- MacBook\$ # 那就需要手動下載依賴了:
- MacBook$ go get -v -d github.com/labstack/echo/v3
- go get: module github.com/labstack/echo@upgrade found (v3.3.10+incompatible), but does not contain package github.com/labstack/echo/v3
- MacBook$ # 這里需要特別說明一下, 在 gomod 模式出現(xiàn)之前, 有些模塊已經(jīng)有 v2,v3 等版本號了, 但不是模塊, 所有就會有類似上面的錯誤
- MacBook$ # 既然不是模塊就不存在/v2,/v3這樣的尾巴了
- MacBook$ go get -v -d github.com/labstack/echo@v3.3.10
- go get: added github.com/labstack/echo v3.3.10+incompatible
- MacBook$ vim main.go # 改一下包導(dǎo)入路徑
- MacBook$ cat main.go
- package main
- import (
- "github.com/labstack/echo"
- "github.com/labstack/echo/middleware"
- "net/http"
- )
- func main() {
- e := echo.New()
- e.Use(middleware.Logger())
- e.Use(middleware.Recover())
- e.GET("/", hello)
- e.Logger.Fatal(e.Start(":1323"))
- }
- func hello(c echo.Context) error {
- return c.String(http.StatusOK, "Hello, World!")
- }
- MacBook\$ cat go.mod
- module github.com/myrepo/helloworld
- go 1.16
- require (
- github.com/labstack/echo v3.3.10+incompatible // indirect
- github.com/labstack/echo/v4 v4.2.0
- )
- MacBook$ go mod tidy
- MacBook$ # 變化
- MacBook\$ cat go.mod
- module github.com/myrepo/helloworld
- go 1.16
- require (
- github.com/dgrijalva/jwt-go v3.2.0+incompatible // indirect
- github.com/labstack/echo v3.3.10+incompatible
- github.com/labstack/gommon v0.3.0 // indirect
- github.com/mattn/go-colorable v0.1.7 // indirect
- github.com/valyala/fasttemplate v1.2.1 // indirect
- golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a // indirect
- golang.org/x/net v0.0.0-20200822124328-c89045814202 // indirect
- golang.org/x/sys v0.0.0-20200826173525-f9321e4c35a6 // indirect
- golang.org/x/text v0.3.3 // indirect
- )
- MacBook\$ go run .
- v3.3.10-dev
- High performance, minimalist Go web framework
- ⇨ http server started on [::]:1323
- ^Csignal: interrupt
04 總結(jié)
gomod 模式相對于 gopath 模式來說還是比較新, 所以 gomod 模式下還有很多操作在本文中就沒有寫了, 如果有人喜歡這種沉浸式的、筆記式的、或者視頻稿的風(fēng)格, 那后面就再寫寫 gopath 模式遷移到 gomod 模式的操作, 以及 gomod 模式下模塊的常見管理操作, 如果不喜歡這種風(fēng)格, 那就算了 :D
本文轉(zhuǎn)載自微信公眾號「polarisxu」,作者Kade。轉(zhuǎn)載本文請聯(lián)系polarisxu公眾號。






