Loading... ## 前言 从python转到golang后对包管理器的使用,一下不是很习惯,所以学习了一下,找了一些有关资料 golang的包管理器从最初到现在分为三类 --- 1. GOPATH 2. go vendor 3. go mod --- 按照时间先后顺序就是上面的顺序,目前最主流的包依赖管理方式是使用官方推荐的 Go Modules,官方正式放话,强烈推荐你使用 Go Modules,并且有自信可以用于生产中。 ## 小荷才露:GOPATH GOPATH 应该很多人都很眼熟了,在配置环境的时候,都配置过,GOPATH就是配置的工作目录,看一下有哪些目录:  剔除两个自建目录,`output`和 `project`,剩下三个目录: - bin - pkg - src 每个目录存放的文件,都不相同 - bin:存放编译后生成的二进制可执行文件 - pkg:存放编译后生成的 .a 文件 - src:存放项目的源代码,可以是你自己写的代码,也可以是你 go get 下载的包 将你的包或者别人的包全部放在 $GOPATH/src 目录下进行管理的方式,我们称之为 GOPATH 模式。 在这个模式下,使用 go install 时,生成的可执行文件会放在 $GOPATH/bin 下 如果你安装的是一个库,则会生成 .a 文件到 $GOPATH/pkg 下对应的平台目录中(由 GOOS 和 GOARCH 组合而成),生成 .a 为后缀的文件。 GOOS,表示的是目标操作系统,有 darwin(Mac),linux,windows,android,netbsd,openbsd,solaris,plan9 等 而 GOARCH,表示目标架构,常见的有 arm,amd64 等 这些都可以通过go env 查看:  至此,你可能不会觉得上面的方案会产生什么样的问题,直到你开始真正使用 GOPATH 去开发程序,就不得不开始面临各种各样的问题,其中最严重的就是版本管理问题,因为 GOPATH 根本没有版本的概念。 以下几点是你使用 GOPATH 一定会碰到的问题: - 你无法在你的项目中,使用指定版本的包,因为不同版本的包的导入方法也都一样 - 其他人运行你的开发的程序时,无法保证他下载的包版本是你所期望的版本,当对方使用了其他版本,有可能导致程序无法正常运行 - 在本地,一个包只能保留一个版本,意味着你在本地开发的所有项目,都得用同一个版本的包,这几乎是不可能的。 ##承上启下:go vendor 为了解决 GOPATH 方案下不同项目下无法使用多个版本库的问题,Go v1.5 开始支持 vendor 。 以前使用 GOPATH 的时候,所有的项目都共享一个 GOPATH,需要导入依赖的时候,都来这里找,正所谓一山不容二虎,在 GOPATH 模式下只能有一个版本的第三方库。 解决的思路就是,在每个项目下都创建一个 `vendor` 目录,每个项目所需的依赖都只会下载到自己 `vendor`目录下,项目之间的依赖包互不影响。在编译时,v1.5 的 Go 在你设置了开启 `GO15VENDOREXPERIMENT=1` (注:这个变量在 v1.6 版本默认为1,但是在 v1.7 后,已去掉该环境变量,`默认开启 vendor` 特性,无需你手动设置)后,会提升 vendor 目录的依赖包搜索路径的优先级(相较于 GOPATH)。 其搜索包的优先级顺序,由高到低是这样的: - 当前包下的 vendor 目录 - 向上级目录查找,直到找到 src 下的 vendor 目录 - 在 GOROOT 目录下查找 - 在 GOPATH 下面查找依赖包 虽然这个方案解决了一些问题,但是解决得并不完美。 如果多个项目用到了同一个包的同一个版本,这个包会存在于该机器上的不同目录下,不仅对磁盘空间是一种浪费,而且没法对第三方包进行集中式的管理(分散在各个角落)。 并且如果要分享开源你的项目,你需要将你的所有的依赖包悉数上传,别人使用的时候,除了你的项目源码外,还有所有的依赖包全部下载下来,才能保证别人使用的时候,不会因为版本问题导致项目不能如你预期那样正常运行。 这些看似不是问题的问题,会给我们的开发使用过程变得非常难受,虽然我是初学者,还未使用过 go vendor,但能有很明显的预感,这个方案照样会令我崩溃。 ## 横空出世:go mod go modules 在 v1.11 版本正式推出,在最新发布的 v1.14 版本中,官方正式发话,称其已经足够成熟,可以应用于生产上。 从 v1.11 开始,go env 多了个环境变量: `GO111MODULE` ,这里的 111,其实就是 v1.11 的象征标志, go 里好像很喜欢这样的命名方式,比如当初 vendor 出现的时候,也多了个 GO15VENDOREXPERIMENT环境变量,其中 15,表示的vendor 是在 v1.5 时才诞生的。 GO111MODULE 是一个开关,通过它可以开启或关闭 go mod 模式。 它有三个可选值:off、on、auto,默认值是auto。 - `GO111MODULE=off`禁用模块支持,编译时会从GOPATH和vendor文件夹中查找包。 - `GO111MODULE=on`启用模块支持,编译时会忽略GOPATH和vendor文件夹,只根据 go.mod下载依赖。 - `GO111MODULE=auto`,当项目在$GOPATH/src外且项目根目录有go.mod文件时,自动开启模块支持。 go mod 出现后, GOPATH(肯定没人使用了) 和 GOVENDOR 将会且正在被逐步淘汰,但是若你的项目仍然要使用那些即将过时的包依赖管理方案,请注意将 GO111MODULE 置为 off。 具体怎么设置呢?可以使用 go env 的命令,如我要开启 go mod ,就使用这条命令 `````````````````````` go env -w GO111MODULE="on" `````````````````````` ## go modules 在使用 go modules 模式后,项目目录下会多生成两个文件也就是 go.mod 和 go.sum   ### go.mod go.mod 的内容比较容易理解 - 第一行:模块的引用路径 - 第二行:项目使用的 go 版本 - 第三行:项目所需的直接依赖包及其版本 在实际应用上,你会看见更复杂的 go.mod 文件,比如下面这样 ````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````` go 1.14 require ( example.com/apple v0.1.2 example.com/banana v1.2.3 example.com/banana/v2 v2.3.4 example.com/pear // indirect example.com/strawberry // incompatible ) exclude example.com/banana v1.2.4 replace( golang.org/x/crypto v0.0.0-20180820150726-614d502a4dac => github.com/golang/crypto v0.0.0-20180820150726-614d502a4dac golang.org/x/net v0.0.0-20180821023952-922f4815f713 => github.com/golang/net v0.0.0-20180826012351-8a410e7b638d golang.org/x/text v0.3.0 => github.com/golang/text v0.3.0 ) ````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````` 主要是多出了两个 flag: - exclude: 忽略指定版本的依赖包 - replace:由于在国内访问golang.org/x的各个包都需要翻墙,你可以在go.mod中使用replace替换成github上对应的库。 ### go.sum 反观 go.sum 文件,就比较复杂了,密密麻麻的。 可以看到,内容虽然多,但是也不难理解 每一行都是由 `模块路径`,`模块版本`,`哈希检验值` 组成,其中哈希检验值是用来保证当前缓存的模块不会被篡改。hash 是以h1:开头的字符串,表示生成checksum的算法是第一版的hash算法(sha256)。 值得注意的是,为什么有的包只有一行 ```xml <module> <version>/go.mod <hash> ``` 而有的包却有两行呢 ```xml <module> <version> <hash> <module> <version>/go.mod <hash> ``` 那些有两行的包,区别就在于 hash 值不一行,一个是 h1:hash,一个是 go.mod h1:hash 而 `h1:hash` 和 `go.mod h1:hash`两者,要不就是同时存在,要不就是只存在 `go.mod h1:hash`。那什么情况下会不存在 `h1:hash` 呢,就是当 Go 认为肯定用不到某个模块版本的时候就会省略它的 `h1 hash`,就会出现不存在 `h1 hash`,只存在 `go.mod h1:hash` 的情况。 `go.mod` 和 `go.sum` 是 `go modules` 版本管理的指导性文件,因此 `go.mod` 和 `go.sum` 文件都应该提交到你的 Git 仓库中去,避免其他人使用你写项目时,重新生成的 `go.mod` 和 `go.sum` 与你开发的基准版本的不一致。 ### go mod 命令的使用 - `go mod init`:初始化go mod, 生成go.mod文件,后可接参数指定 module 名,上面已经演示过。 - `go mod download`:手动触发下载依赖包到本地cache(默认为$GOPATH/pkg/mod目录) - `go mod graph`: 打印项目的模块依赖结构 - `go mod tidy` :添加缺少的包,且删除无用的包 - `go mod verify` :校验模块是否被篡改过 - `go mod why`: 查看为什么需要依赖 - `go mod vendor` :导出项目所有依赖到vendor下 - `go mod edit` :编辑go.mod文件,接 -fmt 参数格式化 go.mod 文件,接 -require=golang.org/x/text 添加依赖,接 -droprequire=golang.org/x/text 删除依赖,详情可参考 go help mod edit - `go list -m -json all`:以 json 的方式打印依赖详情 如何给项目添加依赖(写进 go.mod)呢? 有两种方法: 你只要在项目中有 import,然后 go build 就会 go module 就会自动下载并添加。 自己手工使用 go get 下载安装后,会自动写入 go.mod 。 ## 写在最后 如果让我用一段话来评价 GOPATH 和 go vendor,我会说 GOPATH 做为 Golang 的第一个包管理模式,只能保证你能用,但不保证好用,而 go vendor 解决了 GOPATH 忽视包版的本管理,保证好用,但是还不够好用,直到 go mod 的推出后,才使 Golang 包的依赖管理有了一个能让 Gopher 都统一比较满意的方案,达到了能用且好用的标准。 如果是刚开始学习 Golang ,那么 GOPATH 和 go vendor 可以做适当了解,不必深入研究,除非你要接手的项目由于一些历史原因仍然在使用 go vender 械管理,除此之外,任何 Gopher 应该从此刻就投入 go modules 的怀抱。 以上是我在这几天的学习总结,希望对还未入门阶段的你,有所帮助。另外,本篇文章如有写得不对的,请后台批评指正,以免误导其他朋友,非常感谢。 <hr class="content-copyright" style="margin-top:50px" /><blockquote class="content-copyright" style="font-style:normal"><p class="content-copyright">版权属于:JsOnGmAX</p><p class="content-copyright">本文链接:<a class="content-copyright" href="https://jsong.cn/archives/28.html" target="_blank" >https://jsong.cn/archives/28.html</a></p><p class="content-copyright">博客内容遵循 署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0) 协议 如有侵权 请联系本人删除</p></blockquote> 最后修改:2020 年 08 月 05 日 09 : 49 AM © 允许规范转载 赞赏 如果觉得我的文章对你有用,请随意赞赏 ×Close 赞赏作者 扫一扫支付 支付宝支付 微信支付