go mod

一概述

1 Go.mod是Golang1.11版本新引入的官方包管理工具，用于解决之前没有地方记录依赖包具体版本的问题，方便依赖包的管理。

2 Go.mod其实就是一个Modules，官方定义：Modules是相关Go包的集合，是源代码交换和版本控制的单元。简单的说就是一个类似索引文件，里面包含依赖哪些模块。

3 go命令直接支持使用Modules，包括记录和解析对其他模块的依赖性。

二 优点

1、排除了$GOPATH的无法有效的管理版本依赖，没有一个地方能够表明依赖包的具体版本号，无法形成有效的版本配套关系的缺点。

2、排除使用vendor这个特性，vendor它能够很好的管理工程，但是它会使得每一个工程都会有一个单独的vendor，非常浪费硬盘，可能导致ide直接卡死。

3、Go Modules相关是一个索引文件，不需要包含src，bin等子目录，只要目录下包含go.mod文件即可。

三 使用条件

1 首先将go的版本升级到1.11以上
备注：

• go 1.11通过设置环境变量GO111MODULE来决定是否启用
• go1.13已经默认支持

2 设置GO111MODULE
GO111MODULE简介:有三个值，分别是：off, on和auto（默认值）

(1) GO111MODULE=off，go命令行将不会支持module功能，寻找依赖包的方式将会沿用旧版本那种通过vendor目录或者GOPATH模式来查找。

(2) GO111MODULE=on，go命令行会使用modules，而一点也不会去GOPATH目录下查找

(3) GO111MODULE=auto，默认值，go命令行将会根据当前目录来决定是否启用module功能。
简单说就是以下两种情况会使用go mod功能，分别是：

• 当前目录在GOPATH/src之外且该目录包含go.mod文件
• 当前文件在包含go.mod文件的目录下面。

四 go mod的命令

go mod init # 初始化当前目录为模块根目录，生成go.mod, go.sum文件
go mod download # 下载依赖包
go mod tidy #整理检查依赖，如果缺失包会下载或者引用的不需要的包会删除
go mod vendor #复制依赖到vendor目录下面
go mod 可看完整所有的命令
go mod graph 以文本模式打印模块需求图
go mod verify 验证依赖是否正确
go mod edit 编辑go.mod文件

五 使用

1 新建工程

2 在项目目录下运行“go mod init + 模块名称”

• 运行完之后，会在当前目录下生成一个go.mod文件，这是一个关键文件，之后的包的管理都是通过这个文件管理。
• 官方说明：除了go.mod之外，go命令还维护一个名为go.sum的文件，其中包含特定模块版本内容的预期加密哈希
• go命令使用go.sum文件确保这些模块的未来下载检索与第一次下载相同的位，以确保项目所依赖的模块不会出现意外更改，无论是出于恶意、意外还是其他原因。 go.mod和go.sum都应检入版本控制。
• go.sum 不需要手工维护，所以可以不用太关注。

3 开发项目， 编译

在运行go build 或 go run时， 会自动查找下载代码依赖的包并且把具体的依赖关系和版本写入到go.mod 和 go.sum文件中

六 问题

1 依赖包下载到哪里？

在编译或运行时依赖包被下载到了$GOPAT/pkg/mod路径

2 依赖包的版本怎么控制？

如果go.mod中没有指定版本，go命令会自动下载代码中的依赖的最新版本
如果go.mod用require语句指定包和版本，go命令会根据指定的路径和版本下载包
指定版本时可以用latest，这样它会自动下载指定包的最新版本

3 项目是否可以放在$GOPATH/src下？

可以

• 如果 GO111MODULE 为on模式，1.12后，无论在$GOPATH/src里还是在外面，都会使用go.mod 里 require的包
• 如果 GO111MODULE 为 off 或 auto， 项目目录在$GOPATH/src下， 则不可以使用go.mod

4 依赖包地址失效，如何处理？

(1)修改源码，用新路径替换import的地址

(2) 在go.mod文件里用 replace 替换包 例如：

replace golang.org/x/text => github.com/golang/text latest

• go会用 github.com/golang/text 替代golang.org/x/text
• 原理：下载github.com/golang/text 的最新版本到 $GOPATH/pkg/mod/golang.org/x/text下