一文让你完全弄懂Go Modules模式！

Go Modules 模式

GOPATH 目录

GOPATH 目录下一共包含三个子目录：

  • bin：存储所编译生成的二进制文件。
  • pkg：存储预编译的目标文件，以加快程序的后续编译速度。
  • src：存储所有 .go 文件或源代码。在编写 Go 应用程序，程序包和库时，一般会以 $GOPATH/src/github.com/foo/bar 的路径进行存放。

使用 go get 来拉取外部依赖时，会自动下载并安装到 $GOPATH 目录下。

go mod 命令

查看 go mod 都有哪些命令

# Go 的所有工具都可以使用 `go help` 来查看使用方法
go help mod

# 查看 go mod download 有哪些参数
go help mod download
命令 作用
go mod help 查看帮助信息
go mod init 初始化当前文件夹，生成 go.mod 文件
go mod download 下载 go.mod 文件中指明的所有依赖到本地（默认为 $GOPATH/pkg/mod 目录）增加 -x 参数 go mod download -x 会打印下载信息；go mod download -json 用来查看模块下载的 zip 存放位置，以及解压后的位置；
go mod tidy 整理现有的依赖，执行时会把未使用的 module 移除掉，同时也会增加缺少的包
go mod graph 查看现有的依赖结构图
go mod edit 编辑 go.mod 文件，比如修改项目中使用的 go 版本 go mod edit -go=1.17
go mod vendor 导出项目所有的依赖到 vendor 目录（需要执行 go build -mod=vendor 才可以使用 vendor 作为依赖来编译，但是在 v1.14 及以后的版本中，如果 golang 项目根目录下存在 vendor 目录，go build 命令会默认优先基于 vendor 目录缓存的三方依赖包构建 golang 程序，除非我们在 go build 命令后面加上 -mod=mod 参数）
go mod verify 校验一个模块是否被篡改过，校验从 GOPROXY 服务器上下载的 zip 文件与 GOSUMDB 服务器下载下来的哈希值，是否匹配。
go mod why 查看为什么需要依赖某模块，比如 go mod why gopkg.in/yaml.v2 gopkg.in/yaml.v3
go clean -modcache 可以清空本地下载的 Go Modules 缓存 （会清空 $GOPATH/pkg/mod 目录）

go mod 环境变量

和 go mod 比较关联的几个环境变量


go env

GO111MODULE="auto"
GOPROXY="https://goproxy.cn,direct"
GOSUMDB="sum.golang.org"
GONOPROXY=""
GONOSUMDB=""
GOPRIVATE=""

GO111MODULE

Go 语言提供了 GO111MODULE 这个环境变量来作为 Go modules 的开关，其允许设置以下参数：

  • auto：只要项目包含了 go.mod 文件的话启用 Go modules，目前在 Go1.11 至 Go 1.14 中仍然是默认值
  • on：启用 Go modules，推荐设置，将会是未来版本中的默认值
  • off：禁用 Go modules，不推荐设置

设置方式

go env -w GO111MODULE=on

也可以直接在 shell 环境变量中设置，比如我这里使用的是 Mac，且使用的 zsh，则在 vim ~/.zshrc 然后添加以下内容，如果是其它 Linux 系列系统，则需要在 ~/.bash_profile 文件中进行设置。


export GO111MODULE=on

然后要记得 source ~/.zshrc

GOPROXY

这个环境变量主要是用于设置 Go 模块代理（Go module proxy），其作用是用于使 Go 在后续拉取模块版本时直接通过镜像站点来快速拉取

GOPROXY 的默认值是：https://proxy.golang.org,direct


# 1. 七牛 CDN
go env -w  GOPROXY=https://goproxy.cn,direct

# 2. 阿里云
go env -w GOPROXY=https://mirrors.aliyun.com/goproxy/,direct

# 3. 官方
go env -w  GOPROXY=https://goproxy.io,direct

direct 是一个特殊指示符，用于指示 Go 在获取源码包时，先尝试在设置 GOPROXY 的地址下抓取，如果遇到 404 或 410 等错误时，再回溯到模块版本的源地址去抓取 （比如 GitHub 等）。

GOSUMDB

它的值是一个 Go checksum database，用于在拉取模块版本时（无论是从源站拉取还是通过 Go module proxy 拉取）保证拉取到的模块版本数据未经过篡改，若发现不一致，也就是可能存在篡改，将会立即终止。

GOSUMDB 的默认值为：sum.golang.org，在国内也是无法访问的，但是 GOSUMDB 可以被 Go 模块代理所代理，因此我们可以通过设置 GOPROXY 来解决，而先前我们所设置的模块代理 goproxy.cn （七牛云的 CDN）就能支持代理 sum.golang.org，所以这一个问题在设置 GOPROXY 后，可以不需要过度关心。

也可以将其设置为 off ，也就是禁止 Go 在后续操作中校验模块版本。但是不建议关闭校验。

GONOPROXY/GONOSUMDB/GOPRIVATE

  • GONOPROXY —— 设置不走 Go Proxy 的 URL 规则；
  • GONOSUMDB —— 设置不检查哈希的 URL 规则；
  • GOPRIVATE —— 设置私有模块的 URL 规则，会同时设置以上两个变量。

这三个环境变量都是用在当前项目依赖了私有模块，例如自己公司部署的私有 git 仓库或者是 GitHub 中的私有仓库，都是需要进行设置的，否则会拉取失败。

设置 GOPRIVATE 之后，表示该地址为私有仓库，不会从 GOPROXY 所对应的地址上去下载。

而一般建议直接设置 GOPRIVATE，它的值将作为 GONOPROXY 和 GONOSUMDB 的默认值，所以建议直接设置 GOPRIVATE 即可。


# 以下表示 git.example.com 和 github.com/username/package 都是私有仓库，不会进行 GOPROXY 下载和校验
go env -w GOPRIVATE="git.example.com,github.com/username/package"
# 设置后，前缀为 `git.example.com` 和 `github.com/username/package` 的模块都会被认为是私有模块

# 表示所有模块路径为 example.com 的子域名都不进行 GOPROXY 下载和校验
# 需要注意的是不包括 example.com 本身
go env -w GOPRIVATE="*.example.com"

使用 Go Modules 初始化项目


# 开启 Go Modules 模块，保证 GO111MODULE=on
go env -w GO111MODULE=on

# 在任意文件夹下创建一个项目（不要求在 $GOPATH/src 目录下创建）
mkdir -p $HOME/modules_test

cd $HOME/modules_test

# 创建 go.mod 文件，同时起当前项目的模块名称
# 如果你是在 `$GOPATH/src` 目录下创建的文件夹可以直接执行 `go mod init` 命令初始化，不需要加模块名称
go mod init github.com/pudongping/moudles_test

# 在该项目下编写源代码，并下载依赖库
# 也可以不加 `-v` 参数
go get -v XXXXXXXX

eg: go get -v github.com/pudongping/test_moudles

下载的包其实被缓存在 $GOPATH/pkg/mod 目录和 $GOPATH/pkg/sumdb 目录下

  • go.mod 文件中：
  1. module：用于定义当前项目的模块路径。
  2. go：用于标识当前模块的 Go 语言版本，值为初始化模块时的版本。
  3. require：用于设置一个特定的模块版本。
  4. exclude：用于从使用中排除一个特定的模块版本。
  5. replace：用于将一个模块版本替换为另外一个模块版本。
# v0.0.0 表示版本信息
# 20190718012654 表示所拉取版本的 commit 时间
# fb15b899a751 表示所拉取版本的 commit 哈希值
github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751
  • go.sum 文件中：

go.sum 文件的作用是：罗列当前项目直接或间接依赖的所有模块版本，保证今后项目依赖的版本不会被篡改。间接依赖的包的哈希值也会被保存。

go.sum 文件中有两种 hash 的形式：

  1. h1:<hash> 将目标模块版本的 zip 文件开包后，针对所有包内文件依次进行 hash，然后再把它们的 hash 结果按照固定格式和算法组成总的 hash 值，如果不存在，表示可能依赖的库用不上
  2. xxx/go.mod h1.<hash> 表示 go.mod 文件做的 hash

# 将目标模块版本的 zip 文件开包后，针对包内所有文件依次进行 hash，然后再将 它们的 hash 结果汇总组成 hash
github.com/gorilla/mux v1.7.4 h1:VuZ8uybHlWmqV03+zRzdwKL4tUnIp1MAQtp1mIFE1bc=

# 针对 go.mod 文件的 hash 值
github.com/gorilla/mux v1.7.4/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=

go get 拉取命令

下载的模块会被放置于 $GOPATH/pkg/mod 目录中

命令 作用
go get 拉取依赖，会进行指定性拉取（更新），并不会更新所依赖的其它模块。（如果本地已存在要下载的包，将会直接使用本地已存在的包）
go get -u 更新现有的依赖，会强制更新它所依赖的其它全部模块，不包括自身。
go get -u -t ./… 更新所有直接依赖和间接依赖的模块版本，包括单元测试中用到的。
go get golang.org/x/text@latest 拉取最新的版本，若存在 tag，则优先使用。
go get golang.org/x/text@master 拉取 master 分支的最新 commit。
go get golang.org/x/text@v0.3.2 拉取 tag 为 v0.3.2 的 commit。
go get golang.org/x/text@342b2e 拉取 hash 为 342b231 的 commit，最终会被转换为 v0.3.2。

go get 子参数说明

子命令 描述
-d 仅下载，不安装
-f 和 -u 配合，强制更新，不检查是否过期
-t 下载测试代码所需的依赖包
-u 更新包，包括他们的依赖项
-v 输出详细信息
insecure 使用 http 等非安全协议

修改项目模块的版本依赖关系


go mod edit -replace=<老版本>=<需要替换的版本>

# 比如
go mod edit -replace=demo-package@v1.0.0=demo-package@v2.0.0

go list 命令以及参数

go list -m -u all
参数 作用
-f 用于查看对应依赖结构体中的指定的字段，其默认值就是 {{.ImportPath}}，也就是导入路径，因此我们一般不需要进行调整
-json 显示的格式，若不指定该选项，则会一行行输出。
-u 显示能够升级的模块信息
-m 显示当前项目所依赖的全部模块

比如查看 gin 框架的版本

go list -m -versions -json github.com/gin-gonic/gin

输出如下：

{
    "Path": "github.com/gin-gonic/gin",
    "Version": "v1.7.7",
    "Versions": [
        "v1.1.1",
        "v1.1.2",
        "v1.1.3",
        "v1.1.4",
        "v1.3.0",
        "v1.4.0",
        "v1.5.0",
        "v1.6.0",
        "v1.6.1",
        "v1.6.2",
        "v1.6.3",
        "v1.7.0",
        "v1.7.1",
        "v1.7.2",
        "v1.7.3",
        "v1.7.4",
        "v1.7.6",
        "v1.7.7"
    ],
    "Time": "2021-11-24T13:54:13Z",
    "Dir": "/Users/pudongping/go/pkg/mod/github.com/gin-gonic/gin@v1.7.7",
    "GoMod": "/Users/pudongping/go/pkg/mod/cache/download/github.com/gin-gonic/gin/@v/v1.7.7.mod",
    "GoVersion": "1.13"
}

私有库使用 Go Modules 时

  • 需要将 GOPRIVATE 环境变量设置成你私有库的域名
# GO111MODULE 设置成 on 或者 auto 都行
GO111MODULE="auto"
# GOPROXY 最好设置成国内镜像地址
GOPROXY="https://goproxy.cn,direct"
# GOPRIVATE 一定要设置成你的私有库域名，比如
GOPRIVATE="gitlab.xxx.com"
  • 然后执行以下命令即可。注意：前提是你能够通过 ssh 公钥拉取代码 
# 以下假设我私有 git 仓库地址为 gitlab.xxx.com:2222
# 那么则需要调整为

cat << EOF >> ~/.gitconfig
[url "ssh://git@gitlab.xxx.com:2222"]
        insteadOf = https://gitlab.xxx.com
EOF

# 或者执行（效果都是一样的）
git config --global url."ssh://git@gitlab.xxx.com:2222".insteadof "https://gitlab.xxx.com"
  • 测试一下下载一个包
# 仅仅作为示范，此地址根本就不存在
go get -v gitlab.xxx.com/utils/arrayx
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 215,634评论 6赞 497
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 91,951评论 3赞 391
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 161,427评论 0赞 351
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 57,770评论 1赞 290
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,835评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,799评论 1赞 294
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,768评论 3赞 416
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,544评论 0赞 271
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,979评论 1赞 308
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,271评论 2赞 331
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,427评论 1赞 345
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,121评论 5赞 340
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,756评论 3赞 324
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,375评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,579评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,410评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,315评论 2赞 352

推荐阅读更多精彩内容

  • Go开发关键技术指南：Modules
    Modules 先把最重要的说了，关于modules的最新详细信息可以执行命令go help modules或者查...
    winlinvip阅读 1,543评论 0赞 0
  • go modules
    参考一文搞懂 Go Modules 前世今生及入门使用[https://www.cnblogs.com/wongb...
    合肥黑阅读 827评论 0赞 1
  • GO Modules 使用
    旧项目迁移，打算使用GO Modules 作为依赖管理。 go版本 1.12 私人依赖包，如何处理 1. 创建模块...
    起名好难_b30f阅读 4,000评论 1赞 11
  • 【翻译】Command Go (下)
    File types（文件类型） go命令检查目录中特定文件的集合。它根据文件的扩展名表示要检查的文件。这些扩展名...
    Cxb168阅读 1,738评论 0赞 0
  • GO modules详解
    什么是Go Modules? Go modules 是 Go 语言的依赖解决方案，发布于 Go1.11，成长于 G...
    舍是境界阅读 1,706评论 0赞 1