go mod 使用 + GO111MODULE

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功能。

这种情况下可以分为两种情形：

1.当前目录在GOPATH/src之外且该目录包含go.mod文件，开启模块支持。

2.当前文件在包含go.mod文件的目录下面。

在使用模块时，GOPATH是无意义的，不过它还是会把下载的依赖存储在$GOPATH/pkg/mod 中，也会把go install 的结果放在 $GOPATH/bin 中。

当modules 功能启用时，依赖包的存放位置变更为$GOPATH/pkg，允许同一个package多个版本并存，且多个项目可以共享缓存的module。

go mod

golang 提供了go mod命令来管理包。

go mod 有以下命令：

命令 说明download ：download modules to local cache(下载依赖包，下载依赖的module 到本地cache)edit： edit go.mod from tools or scripts（编辑go.mod文件）graph：print module requirement graph (打印模块依赖图)init：initialize new module in current directory（在当前目录初始化mod，在当前文件夹下初始化一个新的module，创建 go.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(解释为什么需要依赖)

go mod vendor 命令可以在项目中创建vendor 文件将依赖包拷贝过来。go mod download 命令用于将依赖包缓存到本地Cache起来。go list -m -json all ：显示所有import库信息：-json ：JSON格式显示，all：显示全部库Mod Cache 路径：默认在$GOPATH/pkg 下面:$GOPATH/pkg/mod

如何在项目中使用

示例一：创建一个新项目

在GOPATH 目录之外新建一个目录，并使用go mod init初始化生成go.mod 文件，go.mod中会列出所有依赖包的路径和版本。

➜ ~ mkdir hello➜ ~ cd hello➜ go mod init hellogo: creating new go.mod: module hello➜ lsgo.mod➜ cat go.modmodule hellogo 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 mainimport ("net/http""/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.mod 内容：

$ cat go.modmodule hellogo 1.12require (/labstack/echo v3.3.10+incompatible // /labstack/gommon v0.2.8 // /mattn/go-colorable v0.1.1 // /mattn/go-isatty v0.0.7 // /valyala/fasttemplate v1.0.0 // /x/crypto v0.0.0-0313024323-a1f597ede03a // indirect)

// indirect 表示这个库是间接引用进来的。

go module 安装 package 的原則是先拉最新的 release tag，若无tag则拉最新的commit， go 会自动生成一个 go.sum 文件来记录 dependency tree：

$ cat /labstack/echo v3.3.10+incompatible h1:pGRcYk231ExFAyoAjAfD85kQzRJCRI8bbnE7CX5OEgg=/labstack/echo v3.3.10+incompatible/go.mod h1:0INS7j/VjnFxD4E2wkz67b8cVwCLbBmJyDaka6Cmk1s=/labstack/gommon v0.2.8 h1:JvRqmeZcfrHC5u6uVleB4NxxNbzx6gpbJiQknDbKQu0=/labstack/gommon v0.2.8/go.mod h1:/tj9csK2iPSBvn+3NLM9e52usepMtrd5ilFYA+wQNJ4=/mattn/go-colorable v0.1.1 h1:G1f5SKeVxmagw/IyvzvtZE4Gybcc4Tr1tf7I8z0XgOg=/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.go1 directory, 2 files

server.go 源码为：

package mainimport (api "./api" // 这里使用的是相对路径"/labstack/echo")func main() {e := echo.New()e.GET("/", api.HelloWorld)e.Logger.Fatal(e.Start(":1323"))}

api/apis.go 源码为：

package apiimport ("net/http""/labstack/echo")func HelloWorld(c echo.Context) error {return c.JSON(http.StatusOK, "hello world")}

使用 go mod init *** 初始化go.mod

$ go mod init helloworldgo: creating new go.mod: module helloworld

运行 go run server.go

go: finding /labstack/gommon/color latestgo: finding /labstack/gommon/log latestgo: finding /x/crypto/acme/autocert latestgo: finding /x/crypto/acme latestgo: finding /x/crypto latestbuild 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.modmodule helloworldgo 1.12require (/labstack/echo v3.3.10+incompatible // /labstack/gommon v0.2.8 // /mattn/go-colorable v0.1.1 // /mattn/go-isatty v0.0.7 // /valyala/fasttemplate v1.0.0 // /x/crypto v0.0.0-0313024323-a1f597ede03a // indirect)

那为什么会抛出这个错误呢？

这是因为 server.go 中使用 internal package 的方法跟以前已经不同了，由于 go.mod会扫描同工作目录下所有 package 并且变更引入方法，必须将 helloworld当成路径的前缀，也就是需要写成 import helloworld/api，以往 GOPATH/dep 模式允许的 import ./api 已经失效，详情可以查看这个 issue。

更新旧的package import 方式

所以server.go 需要改写成：

package mainimport (api "helloworld/api" // 这是更新后的引入方法"/labstack/echo")func main() {e := echo.New()e.GET("/", api.HelloWorld)e.Logger.Fatal(e.Start(":1323"))}

一个小坑：开始在golang1.11 下使用go mod 遇到过 go build /valyala/fasttemplate: module requires go 1.12 这种错误，遇到类似这种需要升级到1.12 的问题，直接升级golang1.12 就好了。幸亏是在1.12 发布后才尝试的go mod 🤷‍♂️

使用replace替换无法直接获取的package

由于某些已知的原因，并不是所有的package都能成功下载，比如：下的包。

modules 可以通过在 go.mod 文件中使用 replace 指令替换成github上对应的库，比如：

replace (/x/crypto v0.0.0-0313024323-a1f597ede03a => /golang/crypto v0.0.0-0313024323-a1f597ede03a)

或者

replace /x/crypto v0.0.0-0313024323-a1f597ede03a => /golang/crypto v0.0.0-0313024323-a1f597ede03a

https://juejin.im/post/6844903798658301960