Go Module详解

基本介绍

基本介绍

Go Module是Go语言的官方依赖管理解决方案，其提供了一种简单、可靠的方式来管理项目的依赖关系。Go Module于Go1.11发布，并于Go1.14准备正式用于生产，Go官方也鼓励用户从其他的依赖管理工具迁移到Go Module。

Go Module主要解决了如下几个问题：

• 依赖管理：在引入Go Module之前，Go语言没有官方的依赖管理系统，开发人员需要手动下载和管理项目的依赖包。Go Module中提供了一种标准化的依赖管理解决方案，使开发人员能够轻松定义、下载和更新项目的依赖项。
• 版本冲突：在原始的GOPATH模式中，多个项目共享同一个全局的依赖包集合，往往会导致版本冲突。Go Module中引入了模块版本的概念，每个模块都有明确的版本号，并通过go.mod文件中的版本要求来解决版本冲突问题。
• 可重复构建：在GOPATH模式中，项目的构建结果受到GOPATH环境变量的影响，同一项目在不同环境下可能产生不一致的构建结果。Go Module中使用go.mod文件明确指定项目的依赖关系和版本要求，确保在不同环境下构建结果的一致性和可重复性。
• 跨模块引用：在GOPATH模式中，无法直接引用其他项目中的代码，必须将代码复制到自己的项目中，或使用第三方工具来管理跨项目的共享代码。Go Module中允许直接引用其他模块中的代码，简化了代码的复用和共享，提高了开发效率。
• 私有库支持：在GOPATH机制中，私有库的使用相对复杂，需要设置特殊的目录结构或使用第三方工具。Go Module中提供了对私有库的官方支持，开发人员可以使用私有代码块，并通过身份验证或代理来管理私有模块的访问权限。

相关环境变量

相关环境变量

通过go env命令可以查看与Go相关的环境变量信息。如下：

其中，与Go Module相关的环境变量主要有如下几个：

• GO111MODULE：用于启用或禁用Go Module功能。设置为on和off分别表示启用和禁用Go Module功能，设置为auto表示根据当前目录下是否包含go.mod文件来决定是否启用Go Module功能。
• GOPROXY：用于设置模块代理的地址，多个代理地址之间使用逗号分隔。设置为off表示禁用模块代理，direct表示从源代码仓库下载模块。
• GONOPROXY：用于设置不需要通过代理访问的模块路径列表，多个模块路径之间使用逗号分隔，这些模块将会直接从源代码仓库下载。
• GOSUMDB：用于配置Go语言中模块验证的校验和的数据源。
• GONOSUMDB：用于设置不参与校验和验证的模块路径列表，多个模块路径之间使用逗号分隔。
• GOPRIVATE：用于设置不在公共代码仓库上的私有模块路径列表，多个模块路径之间使用逗号分隔。

说明一下：

• 在使用Go Module之前，需要确保GO111MODULE环境变量的值不为off，如果Go Module功能未启用，可通过go env -w GO111MODULE=on命令开启Go Module功能。
• 如果将GOPROXY环境变量的值设置为off，意味着Go Module不会通过代理服务器来获取模块，此时Go Module默认会尝试从模块的导入路径所对应的源代码仓库下载模块，比如要下载的模块的导入路径为github.com/username/module，那么Go Module会直接从GitHub上的github.com/username/module仓库下载模块的代码。
• GOPROXY环境变量的值默认为https://proxy.golang.org,direct，在GOPROXY最后设置direct，意味着当无法从列出的代理服务器中获取所需模块时，直接从源代码仓库获取模块，即尝试使用获取模块的默认方式进行获取，确保代理服务器无法获取的模块，仍然能够从源代码仓库获取。
• https://proxy.golang.org是Go团队提供并由Google托管的Go模块代理服务，https://goproxy.cn是中国开发者提供的Go模块代理服务，为了提高Go Module下载模块的速度，通常会将GOPROXY的值设置为https://goproxy.cn,direct。

Go Module的使用

初始化项目（go mod init）

初始化项目

go mod init命令用于初始化一个新的Go模块，该命令会在当前目录下创建一个名为go.mod的文件。如下：

生成的go.mod文件如下：

module github.com/chenlong-cxy/go-module-test

go 1.20

鉴于当前go.mod文件的内容过于简单，为了进一步讲解go.mod文件的内容，下面给出一个较为复杂的go.mod文件示例。如下：

module module-path

go 1.20

require (
	github.com/zhagnsan/test1 v1.1.3
	github.com/zhagnsan/test2 v1.2.3
	github.com/zhagnsan/test3 v1.2.4 // indirect
)

replace github.com/zhangsan/test1 v1.1.3 => github.com