Fuhui

Go Module(一)


这世上太多的人,宁愿吃生活苦,也不愿吃自律的苦。大概是因为生活的苦,躺着就来了,而自律的苦,得自己去找。但只有吃得下自律的苦,才有成功的自由,没有一种成功是走得了捷径的,通向真正成功的唯一道路只有自律。越成功,越自律。越自律,越成功。

GO111MODULE

Go 1.1包含了对Go Modules预支持,包括调整后的go get命令。后续版本总GOPATH和老的go get可能会被官方移除。

Go Modules中支持了一个临时环境变量:GO111MODULE,可以赋值为offonauto

  1. 值为off,表示不支持Go Modules模式,Go仍然在vendorGoPATH路径下查找依赖;
  2. 值为on,表示当前明确使用Go ModulesGo不再去GOPATH下查找任何依赖;
  3. 值为auto或未设置,表示是否启用Go Modules依赖当前的目录情况,当编译的项目在GoPATH/src之外,或者当前目录或子目录本身包含go.mod文件,则启用Go Modules模式。

Defining a module

module通过源码根目录下的go.mod文件来定义。根路径下的module是项目依赖包的集合,但会排除子目录的go.mod文件。

下面是go mod文件模版:

module example.com/m

require (
	golang.org/x/text v0.3.0
	gopkg.in/yaml.v2 v2.1.0
)

要开始使用go mod,仅需要在项目下执行go mod init命令创建go.mod文件即可。

go mod init example.com/m

The go.mod File

go.mod文件的每一行都包还一个简单的指令(modulerequireexcludereplace),然后紧跟参数部分。指令除了单行表示之外,还可以是一个块的形式。其中,文件也是以//作为注释符。

下面是截取我项目下的go.mod文件的部分内容:

module gitlab.luojilab.com/igetserver/order_delivery

go 1.12

require (
	github.com/Shopify/sarama v1.22.1
	github.com/bsm/sarama-cluster v2.1.15+incompatible
	github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b
	github.com/gopherjs/gopherjs v0.0.0-20181103185306-d547d1d9531e // indirect
)

replace (
	cloud.google.com/go => github.com/GoogleCloudPlatform/google-cloud-go v0.36.0
	github.com/ugorji/go => github.com/ugorji/go/codec v0.0.0-20190204201341-e444a5086c43
	golang.org/x/text => github.com/golang/text v0.3.0
)

go.mod中依赖库的版本标签都类似v.0.1.0,其中打头的v是必须的,三个表示版本的数字也是被要求的。当然,并不是严格要求。

go mod比较推崇这个给版本打release tag的方式,比如我们文件中的github.com/golang/text,引用的版本被项目开发者明确的标记为v0.3.0。而它非常反对我们通过具体的commit hash code来引用一个具体的开发版本,所以,他有一套默认的版本机制,格式就是:v0.0.0-yyyymmddhhmmss-commit,从我们的go.mod文件中也可以看出来。

Modules and vendoring

当使用module时,Go命令会完全忽略vendor目录。为了跟之前Go的依赖管理相兼容,我们可以使用go mod vendor 创建vendor目录来存储编译代码的依赖包。如果在编译的时候要使用vendor中的依赖包,需要使用go build -mod=vendor命令。

go mod vendor 
go build -mod=vendor

Go Get

首先,go get解析需要新增哪些依赖。可以通过在包名后添加@version或者@branch等方式来取代命令的默认更新行为。如果后缀指定为@none,则表明该依赖应该被移除。

其次,go get会下载、编译、安装指定的包。包的安装模式也是被允许的,比如使用go get golang.org/x/perf/cmd/..来更新cmd下的所有子包。

go get -u <repo url>
go mod vendor