目录

什么是go.mod

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

Go.mod其实就是一个Modules，关于Modules的官方定义为：

Modules是相关Go包的集合，是源代码交换和版本控制的单元。go命令直接支持使用Modules，包括记录和解析对其他模块的依赖性。Modules替换旧的基于GOPATH的方法，来指定使用哪些源文件。

Modules和传统的GOPATH不同，不需要包含例如src，bin这样的子目录，一个源代码目录甚至是空目录都可以作为Modules，只要其中包含有go.mod文件。

如何使用go.mod

1.首先将go的版本升级为1.11以上

2.设置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文件的目录下面。

go包管理常用命令

golang 提供了 go mod命令来管理包。go mod 有以下命令：

go get

#打开gomod
export GO111MODULE=on

#关闭gomod
export GO111MODULE=off

#拉取 master 分支的最新 commit
go get github.com/golang/protobuf/proto@master

#拉取 tag 为 v0.3.2 的 commit
go get golang.org/x/text@v0.3.2

#拉取 hash 为 342b231 的 commit
go get golang.org/x/text@342b2e

#更新
go get -u

go mod


#创建一个新模块，初始化 go.mod 文件，参数为该模块的导入路径，推荐使用这种形式。如：go mod init github.com/linehk/example
go mod init

#以文本模式打印模块需求图
go mod graph

#格式化 go.mod 文件
go mod edit -fmt

#添加依赖或修改依赖版本，这里支持模糊匹配版本号
go mod edit -require=path@version

#从 go.mod 删除不需要的依赖、新增需要的依赖，这个操作不会改变依赖版本
go mod tidy

#生成 vendor 文件夹
go mod vendor

#验证哈希
go mod verify

其他命令

#Go 命令行工具会根据需要添加新的依赖项。如：go test ./…，测试当前模块。
go build xxx.go

#自动读取源码目录下面名为 *_test.go 的文件，生成并运行测试用的可执行文件
go test

# 编译并执行可执行文件
go run xxx.go

#打印当前模块依赖
go list -m all

#列出该模块的所有版本
go list -m -versions github.com/gin-gonic/gin

#清理本地缓存
#在使用go mod过程中，如果go mod是开启状态，但import不到包，可以使用这个命令清理下缓存
go clean -modcache

go.mod在项目中如何使用

1.首先我们要在GOPATH/src 目录之外新建工程，或将老工程copy到GOPATH/src 目录之外。

注意：go.mod文件一旦创建后，它的内容将会被go toolchain全面掌控。go toolchain会在各类命令执行时，比如go get、go build、go mod等修改和维护go.mod文件。

go.mod 文件内提供了module, require、replace和exclude四个关键字，这里注意区分与命令的区别，一个是管理go mod命令，一个是go mod文件内的关键字。

  • module语句指定包的名字（路径）
  • require语句指定的依赖项模块
  • replace语句可以替换依赖项模块
  • exclude语句可以忽略依赖项模块

下面建立了一个hello.go的文件

package main

import (
	"fmt"
)

func main() {
    fmt.Println("Hello, world!")
}

2.在当前目录下，命令行运行 go mod init + 模块名称 初始化模块

比如go mod init hello

运行完之后，会在当前目录下生成一个go.mod文件，这是一个关键文件，之后的包的管理都是通过这个文件管理。

官方说明：除了go.mod之外，go命令还维护一个名为go.sum的文件，其中包含特定模块版本内容的预期加密哈希。

go命令使用go.sum文件确保这些模块的未来下载检索与第一次下载相同的位，以确保项目所依赖的模块不会出现意外更改，无论是出于恶意、意外还是其他原因。 go.mod和go.sum都应检入版本控制。

go.sum 不需要手工维护，所以可以不用太关注。

注意 ：子目录里是不需要init的，所有的子目录里的依赖都会组织在根目录的go.mod文件里

接下来，让我们的项目依赖下第三方包。

如修改hello.go文件如下，按照过去的做法，要运行hello.go需要执行go get 命令下载包到 $GOPATH/src

package main

import (
	"fmt"
	"github.com/gohouse/gorose"
)

func main() {
    fmt.Println("Hello, world!")
}

现在，使用了新的包管理就不在需要这样做了

直接 go run hello.go

稍等片刻… go 会自动查找代码中的包，下载依赖包，并且把具体的依赖关系和版本写入到go.mod和go.sum文件中。

查看go.mod，它会变成这样：


module test

require (
	github.com/gohouse/gorose v1.0.5
)

require 关键字是引用，后面是包，最后v1.11.1 是引用的版本号

这样，一个使用Go包管理方式创建项目的小例子就完成了。

问题汇总

问题1：依赖的包下载到哪里了？还在GOPATH/src里吗？

不在。

使用Go的包管理方式，依赖的第三方包被下载到了$GOPATH/pkg/mod路径下。

问题2： 依赖包的版本是怎么控制的？

在上一个问题里，可以看到最终下载在$GOPATH/pkg/mod 下的包中最后会有一个版本号 v1.0.5，也就是说，$GOPATH/pkg/mod里可以保存相同包的不同版本。

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

问题3： 可以把项目放在$GOPATH/src下吗？

可以。 但是go会根据GO111MODULE的值而采取不同的处理方式，默认情况下，GO111MODULE=auto 自动模式

1.auto 自动模式下，项目在$GOPATH/src里会使用$GOPATH/src的依赖包，在$GOPATH/src外，就使用go.mod 里 require的包

2.on 开启模式，1.12后，无论在$GOPATH/src里还是在外面，都会使用go.mod 里 require的包

3.off 关闭模式，就是老规矩。

问题4： 依赖包中的地址失效了怎么办？

在go快速发展的过程中，有一些依赖包地址变更了。以前的做法：

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

2.git clone 或 go get 新包后，copy到$GOPATH/src里旧的路径下

无论什么方法，都不便于维护，特别是多人协同开发时。

使用go.mod就简单了，在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下。

问题5： init生成的go.mod的模块名称有什么用？

本例里，用 go mod init hello 生成的go.mod文件里的第一行会申明module hello

因为我们的项目已经不在$GOPATH/src里了，那么引用自己怎么办？就用模块名+路径。

例如，在项目下新建目录 utils，创建一个tools.go文件:

package utils

import “fmt”

func PrintText(text string) {
    fmt.Println(text)
}

在根目录下的hello.go文件就可以 import “hello/utils” 引用utils

package main

import (
	"hello/utils"
	"github.com/astaxie/beego"
)

func main() {
	utils.PrintText("Hi")
	beego.Run()
}

问题6：以前老项目如何用新的包管理

  1. 如果用auto模式，把项目移动到$GOPATH/src外
  2. 进入目录，运行 go mod init + 模块名称
  3. go build 或者 go run 一次

推荐阅读

三分钟掌握Go mod常用与高级操作 - 知乎

阅读原文

本文收藏来自互联网，仅用于学习研究，著作权归原作者所有，如有侵权请联系删除

markdown @tsingchan

引用格式为收藏注解，比如本句就是注解，非作者原文。