Go模块是Go语言的依赖包管理工具。
Go模块的使用
1、Go1.11及以后版本才能使用。
2、Go1.11需要设置环境变量 GO111MODULE 为 on(新特性开关,按照Go语言惯例,mod首次在go1.11版本中使用,go1.12及以后版本这个设置应该不会用了)。
mod是模块英文modules的简写。
列举一些常用的命令行:
-
go help mod
查看帮助。 -
go mod init <项目模块名称>
初始化模块,会在项目根目录下生成go.mod
文件。参数<项目模块名称>
是非必写的,但如果你的项目还没有代码编写,这个参数能快速初始化模块。如果之前使用其它依赖管理工具(比如dep,glide等),mod会自动接管原来依赖关系。 -
go mod tidy
根据go.mod文件来处理依赖关系。 -
go mod vendor
将依赖包复制到项目下的 vendor 目录。建议一些使用了被墙包的话可以这么处理,方便用户快速使用命令go build -mod=vendor
编译。 -
go list -m all
显示依赖关系。go list -m -json all
显示详细依赖关系。 -
go mod download <path@version>
下载依赖。参数<path@version>
是非必写的,path是包的路径,version是包的版本。 - 其它命令可以通过
go help mod
来查看。
另外:
go.mod文件是文本文件,是可以自己手动编辑的。
Go模块版本控制的下载文件及信息会存储到GOPATH的pkg/mod文件夹里。
使用了Go模块,源码不一定要在GOPATH中进行。
使用示例
go.mod文件
module github.com/wuyumin/easydoc
require (
github.com/BurntSushi/toml v0.3.0
github.com/mostafah/fsync v0.0.0-20151120150823-6c37e2827238
github.com/russross/blackfriday v1.5.1
)
Git建议
go.mod文件必须要提交到git仓库,但go.sum文件可以不用提交到git仓库(git忽略文件.gitignore中设置一下)。
问题解答
- 问:启用Go模块以后,使用
go get xxx
时会报错提示"go: cannot find main module; see 'go help modules'",这个是怎么回事?答:因为没有找到
go.mod
文件,所以会报错。你只要在项目根目录下生成一个go.mod文件就可以了。 - 问:如何在Go模块里使用本地依赖包?
答:首先在项目的
go.mod
文件的require处添加依赖包,然后在replace处添加替换本地依赖包(路径要处理妥当)。比如:
require (
mytest v0.0.0
)
replace (
mytest v0.0.0 => ../mytest
)
参考资料
- 语义化版本(中文) https://semver.org/lang/zh-CN/
- Go模块官方文档(英文) https://github.com/golang/go/...
- Go模块命令说明(英文) https://golang.google.cn/cmd/...
欢迎修正
此篇文章最新的更改都会在GitHub上进行。
GitHub上的原文链接
https://github.com/wuyumin/tu...
欢迎在GitHub上star本项目或通过Issues提供修正建议。