Go Module 是从 Go 版本 1.11.1 开始官方提供的包管理工具,用于解决Go项目的包管理及依赖,类似于PHP的 composer、Nodejs的 npm。
本章节会对 Go Module 的一些常用的实用的命令/设置进行介绍,更详细的介绍请查看官方文档: https://go.dev/wiki/Modules
关于 go.mod
go.mod 是 Go 项目的依赖描述文件,该文件主要用来描述两个事情:
- 当前项目名(
module)是什么。每个项目都应该设置一个名称,当前项目中的包(package)可以使用该名称进行相互调用。 - 当前项目依赖的第三方包名称。项目运行时会自动分析项目中的代码依赖,生成
go.sum依赖分析结果,随后 go 编译器会去下载这些第三方包,然后再编译运行。
我们可以看到之前的 hello world 项目下有一个自动生成的 go.mod 文件,其内容如下:
module hello
其中, hello 为当前项目的名称,在我们初始化项目的时候Goland IDE自动帮助我们生成了该文件,默认情况下该module的名称为目录的名称,该名称可以随意设置。
关于GOPROXY
GOPROXY 是一个环境变量,用于设置代理地址加速下载依赖或下载自己的私有依赖。
详见 Go 官网说明: https://go.dev/wiki/Modules
常见的公共GOPROXY反向代理地址有:
使用 go.mod
使用 Goland IDE
-
设置
Goland启用Go Module特性
在下载第三方依赖包时,您需要科学上网。笔者本地设置了一个环境变量
GOPROXY用于科学上网拉取依赖:GOPROXY=https://goproxy.cn如果您本地环境已经有
VPN功能,那么可以忽略GOPROXY的设置,可以添加direct后缀表示不使用代理。GOPROXY=https://goproxy.cn,direct -
手动修改
go.mod文件如下:module hello
require github.com/gogf/gf/v2 latest增加
GoFrame框架的依赖,其中latest表示使用github.com/gogf/gf/v2最新版本,IDE将会立即去更新下载框架代码。成功后,IDE将会修改go.mod文件并生成go.sum依赖分析文件。该go.sum文件为该项目所有的第三方依赖,通常也应该推送到版本管理仓库中。 -
随后
go.mod文件被自动更新为:module hello
require github.com/gogf/gf/v2 v2.8.1其中
v2.8.1表示Go Module检测到的最新框架版本。
使用命令行
-
打开
Terminal,在项目根目录下执行:go env -w GO111MODULE=on
go env -w GOPROXY=https://goproxy.cn,direct
go get -u github.com/gogf/gf/v2推荐使用
go env -w的方式设置Go的环境变量(其他方式请参考),以上命令将会使用代理立即下载最新稳定版本的GoFrame框架。 -
随后
go.mod文件内容被自动更新为:module hello
require github.com/gogf/gf/v2 v2.8.1且生成了新的
go.sum依赖分析文件。