go modules、goproxy

关于go的第三方包的依赖管理,项目小的时候还不觉得多麻烦,当项目越来越大,引入的第三方包越来越多的时候,这个时候问题就很头痛了,golang官方建议是一个项目一个GOPATH,但是鉴于很多人都不这么做(我也不这么做,因为麻烦),于是在go1.11的时候推出了这个go modules来解决依赖管理的问题。

使用

由于这个go modules和GOPATH可能是天生不和,如果配置了GOPATH的话,这个go modules是默认不开启的。 开启也很简单,只要在命令行中键入下面命令就行了。

1
export GO111MODULE=on	# 开启GoModule特性
  1. 不过这种是一次性的,重启之后就会消失,所以可以在环境信息文件/etc/profile的最后面添加上一行export GO111MODULE=on
  2. 使用命令source /etc/profile让其生效。

GO111MODULE解释, 当为on时则使用Go Modules,go 会忽略 $GOPATH vendor文件夹,只根据go.mod下载依赖。当为 off时则不适用新特性 Go Modules支持,它会查找 vendor目录和 $GOPATH来查找依赖关系,也就是继续使用“GOPATH模式”。当为 auto时或未设置时则根据当前项目目录下是否存在 go.mod文件或 $GOPATH/src之外并且其本身包含go.mod文件时才会使用新特性 Go Modules模式,并且autoGO111MODULE的默认值。

goproxy

关于goproxy,简单来说就是一个代理,让我们更方便的下载哪些由于墙的原因而导致无法下载的第三方包,比如golang.org/x/下的包,虽然也有各种方法解决,但是,如果是你在拉取第三方包的时候,而这个包又依赖于golang.org/x/下的包,你本地又恰恰没有,当然不嫌麻烦的话,也可以先拉取golang.org/x/下的包,再拉取第三方包。

这个goproxy强大地方就在于代理,而它官网是这样介绍自己的【A Global Proxy for Go Modules】,就是这么强大,全球代理,让世界没有难下的包

使用

一般来说,goproxy是和go modules配合使用的。 首先要确保go modules是开启的,如果没有开启可以在命令行键入下面命令即可

1
2
export GO111MODULE=on
export GOPROXY=https://goproxy.io

不过这种是一次性的,重启之后就会消失,所以可以在环境信息文件/etc/profile的最后面添加上下面这两行

1
2
export GO111MODULE=on
export GOPROXY=https://goproxy.io

最后使用source /etc/profile让其生效。

go.mod 和 go.sum介绍

go.mod是Go项目的依赖描述文件,该文件主要用来描述两个事情:

  1. 当前项目名(module)是什么。每个项目都应该设置一个名称,当前项目中的包(package)可以使用该名称进行相互调用。
  2. 当前项目依赖的第三方包名称。项目运行时会自动分析项目中的代码依赖,生成go.sum依赖分析结果,随后go编译器会去下载这些第三方包,然后再编译运行。 go.sum依赖分析文件,记录每个依赖库的版本和哈希值 一般情况下,go.sum应当被添加到版本管理中随着go.mod文件一起提交。

go modules常用命令

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
go mod init 	#初始化modules
go mod download	#下载依赖的module到本地cache
go mod edit		#编辑go.mod文件,选项有-json、-require和-exclude,可以使用帮助go help mod edit
go mod graph	#以文本模式打印模块需求图
go mod tidy		#检查,删除错误或者不使用的modules,以及添加缺失的模块
go mod vendor	#生成vendor目录,将依赖复制到vendor目录下面
go mod verify	#验证依赖是否正确
go mod why		#解释为什么需要依赖

go list -m				#查看主模块的路径
go list -m -f={{.Dir}}	#查看主模块的根目录
go list -m all			#查看当前的依赖和版本信息

goland ide下使用go modules

在goland下,是推荐使用goland配置vgo来快速使用go modules的。而vgo是基于Go Modules规范的包管理工具,同官方的go mod命令工具类似。

关于在goland下要使用go modules,本菜鸡实在绕了很久,由于go modules出来也不久,虽说网上也有部分博客在教怎么用goland去用go modules,但是有一点很重要,在大部分博客中也没指出,就是关于goland的版本是否支持go modules这个新功能,这个问题实在是有点坑,相信不少人用的是goland2017或goland2018.1.3版本,这就有个问题,这些旧版本不支持快速使用go modules来包依赖管理,所以这里建议使用goland2019.1这个比较新的版本。

下面是配置流程: 在设置页面里,根据下图来配置就可以了

在这里插入图片描述

还有一种是新建项目时就想使用go modules,那么可以根据下面的图来配置,而这种的话,新建时就会在项目根目录下自动创建一个 go.mod 文件

在这里插入图片描述

接下来就以新建项目的这种情况来介绍怎么在goland下使用go modules 先创建一个项目,在创建页面的时候就选择"Go Modules(vgo)“这个选项,强烈建议在"Proxy"这一栏填上“https://goproxy.io”,毕竟墙的存在。

在创建完项目的时候,会在项目目录下自动生成一个go.mod文件,而这个文件初始的时候,内容就只有以下的两句话

module playxy		// 模块名,默认使用项目名。

go 1.12		// 当前go的版本	

而模块名就是我们说的项目依赖路径,通常来说该地址就是项目的仓库地址,所有需要引用项目包的地址都要填写这个路径,无论是内部之间引用还是外部引用。也就是说,在项目启用了 go modules 之后,引用包必须跟 go mod 文件第一行包名一样

好,接下来我们创建main.go,随便import一个包,会发现这个包是红色的,就算本地的$GOPATH/src/github.com/有这个第三方包也一样会报红。这是因为我们启动了GO111MODULE =on,那么只会使用go module的方式寻找依赖包,由于这时候go.mod里没有任何加入依赖的语句,那么自然是找不到,所以会报红。最简单的方法就是把鼠标放在报红的地方,会弹出来解决方案,点击Sync package of testModuleProject或用快捷键"Alt+Shift+Enter",把包同步到模块里,其实这里的同步包就是相当于命令go mod download,只不过比较方便而已。

在这里插入图片描述


版权声明:本文为CSDN博主「你是魔鬼吧」的原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。 原文链接:https://blog.csdn.net/qq_42403866/java/article/details/93654421