原文地址:https://juejin.im/post/6844903798658301960
go modules 是 golang 1.11 新加的特性。现在 1.12 已经发布了，是时候用起来了。Modules 官方定义为：
模块是相关 Go 包的集合。modules 是源代码交换和版本控制的单元。 go 命令直接支持使用 modules，包括记录和解析对其他模块的依赖性。modules 替换旧的基于 GOPATH 的方法来指定在给定构建中使用哪些源文件。
如何使用 Modules ？
-
把 golang 升级到 1.11（现在 1.12 已经发布了，建议使用 1.12）
-
设置
GO111MODULE
GO111MODULE
GO111MODULE 有三个值：off, on和auto（默认值）。
-
GO111MODULE=off，go 命令行将不会支持 module 功能，寻找依赖包的方式将会沿用旧版本那种通过 vendor 目录或者 GOPATH 模式来查找。 -
GO111MODULE=on，go 命令行会使用 modules，而一点也不会去 GOPATH 目录下查找。 -
GO111MODULE=auto，默认值，go 命令行将会根据当前目录来决定是否启用 module 功能。这种情况下可以分为两种情形： -
当前目录在 GOPATH/src 之外且该目录包含 go.mod 文件
-
当前文件在包含 go.mod 文件的目录下面。
当 modules 功能启用时，依赖包的存放位置变更为
$GOPATH/pkg，允许同一个 package 多个版本并存，且多个项目可以共享缓存的 module。
go mod
golang 提供了 go mod命令来管理包。
go mod 有以下命令：
| 命令 | 说明 |
|---|---|
| download | download modules to local cache(下载依赖包) |
| edit | edit go.mod from tools or scripts（编辑 go.mod |
| graph | print module requirement graph (打印模块依赖图) |
| init | initialize new module in current directory（在当前目录初始化 mod） |
| tidy | add missing and remove unused modules(拉取缺少的模块，移除不用的模块) |
| vendor | make vendored copy of dependencies(将依赖复制到 vendor 下) |
| verify | verify dependencies have expected content (验证依赖是否正确） |
| why | explain why packages or modules are needed(解释为什么需要依赖) |
如何在项目中使用
示例一：创建一个新项目
- 在
GOPATH 目录之外新建一个目录，并使用go mod init初始化生成go.mod文件
➜ ~ mkdir hello
➜ ~ cd hello
➜ hello go mod init hello
go: creating new go.mod: module hello
➜ hello ls
go.mod
➜ hello cat go.mod
module hello
go 1.12
复制代码 go.mod 文件一旦创建后，它的内容将会被 go toolchain 全面掌控。go toolchain 会在各类命令执行时，比如 go get、go build、go mod 等修改和维护 go.mod 文件。
go.mod 提供了module, require、replace和exclude 四个命令
-
module语句指定包的名字（路径） -
require语句指定的依赖项模块 -
replace语句可以替换依赖项模块 -
exclude语句可以忽略依赖项模块 -
添加依赖
新建一个 server.go 文件，写入以下代码：
package main
import (
"net/http"
"github.com/labstack/echo"
)
func main() {
e := echo.New()
e.GET("/", func(c echo.Context) error {
return c.String(http.StatusOK, "Hello, World!")
})
e.Logger.Fatal(e.Start(":1323"))
}
复制代码 执行 go run server.go 运行代码会发现 go mod 会自动查找依赖自动下载：
$ go run server.go
go: finding github.com/labstack/echo v3.3.10+incompatible
go: downloading github.com/labstack/echo v3.3.10+incompatible
go: extracting github.com/labstack/echo v3.3.10+incompatible
go: finding github.com/labstack/gommon/color latest
go: finding github.com/labstack/gommon/log latest
go: finding github.com/labstack/gommon v0.2.8
# 此处省略很多行
...
\_\_\_\_ \_\_
/ \_\_/\_\_\_/ / \_\_\_
/ \_// \_\_/ \_ \\/ \_ \\
/\_\_\_/\\\_\_/\_//\_/\\\_\_\_/ v3.3.10-dev
High performance, minimalist Go web framework
https://echo.labstack.com
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_O/\_\_\_\_\_\_\_
O\\
⇨ http server started on \[::\]:1323
复制代码 现在查看 go.mod 内容：
$ cat go.mod
module hello
go 1.12
require (
github.com/labstack/echo v3.3.10+incompatible // indirect
github.com/labstack/gommon v0.2.8 // indirect
github.com/mattn/go-colorable v0.1.1 // indirect
github.com/mattn/go-isatty v0.0.7 // indirect
github.com/valyala/fasttemplate v1.0.0 // indirect
golang.org/x/crypto v0.0.0-20190313024323-a1f597ede03a // indirect
)
复制代码 go module 安装 package 的原則是先拉最新的 release tag，若无 tag 则拉最新的 commit，详见 Modules 官方介绍。 go 会自动生成一个 go.sum 文件来记录 dependency tree：
$ cat go.sum
github.com/labstack/echo v3.3.10+incompatible h1:pGRcYk231ExFAyoAjAfD85kQzRJCRI8bbnE7CX5OEgg=
github.com/labstack/echo v3.3.10+incompatible/go.mod h1:0INS7j/VjnFxD4E2wkz67b8cVwCLbBmJyDaka6Cmk1s=
github.com/labstack/gommon v0.2.8 h1:JvRqmeZcfrHC5u6uVleB4NxxNbzx6gpbJiQknDbKQu0=
github.com/labstack/gommon v0.2.8/go.mod h1:/tj9csK2iPSBvn+3NLM9e52usepMtrd5ilFYA+wQNJ4=
github.com/mattn/go-colorable v0.1.1 h1:G1f5SKeVxmagw/IyvzvtZE4Gybcc4Tr1tf7I8z0XgOg=
github.com/mattn/go-colorable v0.1.1/go.mod h1:FuOcm+DKB9mbwrcAfNl7/TZVBZ6rcnceauSikq3lYCQ=
... 省略很多行
复制代码 -
再次执行脚本
go run server.go发现跳过了检查并安装依赖的步骤。 -
可以使用命令
go list -m -u all来检查可以升级的 package，使用go get -u need-upgrade-package升级后会将新的依赖版本更新到 go.mod * 也可以使用go get -u升级所有依赖
go get 升级
-
运行 go get -u 将会升级到最新的次要版本或者修订版本 (x.y.z, z 是修订版本号， y 是次要版本号)
-
运行 go get -u=patch 将会升级到最新的修订版本
-
运行 go get package@version 将会升级到指定的版本号 version
-
运行 go get 如果有版本的更改，那么 go.mod 文件也会更改
示例二：改造现有项目 (helloword)
项目目录为：
$ tree
.
├── api
│ └── apis.go
└── server.go
1 directory, 2 files
复制代码 server.go 源码为：
package main
import (
api "./api" // 这里使用的是相对路径
"github.com/labstack/echo"
)
func main() {
e := echo.New()
e.GET("/", api.HelloWorld)
e.Logger.Fatal(e.Start(":1323"))
}
复制代码 api/apis.go 源码为：
package api
import (
"net/http"
"github.com/labstack/echo"
)
func HelloWorld(c echo.Context) error {
return c.JSON(http.StatusOK, "hello world")
}
复制代码 - 使用
go mod init ***初始化 go.mod
$ go mod init helloworld
go: creating new go.mod: module helloworld
复制代码 - 运行
go run server.go
go: finding github.com/labstack/gommon/color latest
go: finding github.com/labstack/gommon/log latest
go: finding golang.org/x/crypto/acme/autocert latest
go: finding golang.org/x/crypto/acme latest
go: finding golang.org/x/crypto latest
build command-line-arguments: cannot find module for path \_/home/gs/helloworld/api
复制代码 首先还是会查找并下载安装依赖，然后运行脚本 server.go，这里会抛出一个错误：
build command-line-arguments: cannot find module for path \_/home/gs/helloworld/api
复制代码 但是go.mod 已经更新：
$ cat go.mod
module helloworld
go 1.12
require (
github.com/labstack/echo v3.3.10+incompatible // indirect
github.com/labstack/gommon v0.2.8 // indirect
github.com/mattn/go-colorable v0.1.1 // indirect
github.com/mattn/go-isatty v0.0.7 // indirect
github.com/valyala/fasttemplate v1.0.0 // indirect
golang.org/x/crypto v0.0.0-20190313024323-a1f597ede03a // indirect
)
复制代码 那为什么会抛出这个错误呢？
这是因为 server.go 中使用 internal package 的方法跟以前已经不同了，由于 go.mod 会扫描同工作目录下所有 package 并且变更引入方法，必须将 helloworld 当成路径的前缀，也就是需要写成 import helloworld/api，以往 GOPATH/dep 模式允许的 import ./api 已经失效，详情可以查看这个 issue。
- 更新旧的 package import 方式
所以 server.go 需要改写成：
package main
import (
api "helloworld/api" // 这是更新后的引入方法
"github.com/labstack/echo"
)
func main() {
e := echo.New()
e.GET("/", api.HelloWorld)
e.Logger.Fatal(e.Start(":1323"))
}
复制代码
一个小坑：开始在 golang1.11 下使用 go mod 遇到过go build github.com/valyala/fasttemplate: module requires go 1.12这种错误，遇到类似这种需要升级到 1.12 的问题，直接升级 golang1.12 就好了。幸亏是在 1.12 发布后才尝试的go mod
- 到这里就和新创建一个项目没什么区别了
使用 replace 替换无法直接获取的 package
由于某些已知的原因，并不是所有的 package 都能成功下载，比如：golang.org下的包。
modules 可以通过在 go.mod 文件中使用 replace 指令替换成 github 上对应的库，比如：
replace (
golang.org/x/crypto v0.0.0-20190313024323-a1f597ede03a => github.com/golang/crypto v0.0.0-20190313024323-a1f597ede03a
)
复制代码 或者
replace golang.org/x/crypto v0.0.0-20190313024323-a1f597ede03a => github.com/golang/crypto v0.0.0-20190313024323-a1f597ede03a
复制代码 