跳出Go module的泥潭

李海彬

发布于 2018-09-29 12:21:33

1.7K0

发布于 2018-09-29 12:21:33

原文作者：smallnest

Go 1.11 前天已经正式发布了，这个版本包含了两个最重要的feature就是 module和web assembly。虽然也有一些简单的教程介绍了go module的特性，但是基本上都是hello world的例子，在实践的过程中，很多人都在“拼命的挣扎”，包括我自己，从一些qq群、github的issue, twitter上都可以看到大家茫然或者抱怨的语句。

虽然有三个帮助文件go help mod、go help modules、go help module-get可以了解一些go module的用法，但是感觉Go开发组对module这一特性还是没有很好的做一个全面的介绍，很多情况还得靠大家看源代码或者去猜，比如module下载的文件夹、版本格式的完整声明，module的最佳实践等，并且当前Go 1.11的实现中还有一些bug,给大家在使用的过程中带来了很大的困难。

我也在摸索中前行，记录了摸索过程中的一些总结，希望能给还在挣扎中的Gopher一些帮助。

Introduction to Go Modules 是一篇很好的go module 入门介绍，如果你仔细阅读了它，应该就不需要看本文了。

1、GO111MODULE

要使用go module,首先要设置GO111MODULE=on,这没什么可说的，如果没设置，执行命令的时候会有提示，这个大家应该都了解了。

2、既有项目

假设你已经有了一个go 项目，比如在$GOPATH/github.com/smallnest/rpcx下，你可以使用go mod init github.com/smallnest/rpcx在这个文件夹下创建一个空的go.mod (只有第一行 module github.com/smallnest/rpcx)。

然后你可以通过 go get ./...让它查找依赖，并记录在go.mod文件中(你还可以指定 -tags,这样可以把tags的依赖都查找到)。

通过go mod tidy也可以用来为go.mod增加丢失的依赖，删除不需要的依赖，但是我不确定它怎么处理tags。

执行上面的命令会把go.mod的latest版本换成实际的最新的版本，并且会生成一个go.sum记录每个依赖库的版本和哈希值。

3、新的项目

你可以在GOPATH之外创建新的项目。

go mod init packagename可以创建一个空的go.mod,然后你可以在其中增加require github.com/smallnest/rpcx latest依赖，或者像上面一样让go自动发现和维护。

go mod download可以下载所需要的依赖，但是依赖并不是下载到$GOPATH中，而是$GOPATH/pkg/mod中，多个项目可以共享缓存的module。

4、go mod命令

1download    download modules to local cache (下载依赖的module到本地cache))
2edit        edit go.mod from tools or scripts (编辑go.mod文件)
3graph       print module requirement graph (打印模块依赖图))
4init        initialize new module in current directory (再当前文件夹下初始化一个新的module, 创建go.mod文件))
5tidy        add missing and remove unused modules (增加丢失的module，去掉未用的module)
6vendor      make vendored copy of dependencies (将依赖复制到vendor下)
7verify      verify dependencies have expected content (校验依赖)
8why         explain why packages or modules are needed (解释为什么需要依赖)

有些命令还有bug, 比如go mod download -dir:

1go mod download -dir /tmp
2flag provided but not defined: -dir
3usage: go mod download [-dir] [-json] [modules]
4Run 'go help mod download' for details.

帮助里明明说可以设置dir,但是实际却不支持dir参数。

看这些命令的帮助已经比较容易了解命令的功能。

5、访问外国网站

在国内访问golang.org/x的各个包都需要访问外国网站，你可以在go.mod中使用replace替换成github上对应的库。

1replace (
2    golang.org/x/crypto v0.0.0-20180820150726-614d502a4dac => github.com/golang/crypto v0.0.0-20180820150726-614d502a4dac
3    golang.org/x/net v0.0.0-20180821023952-922f4815f713 => github.com/golang/net v0.0.0-20180826012351-8a410e7b638d
4    golang.org/x/text v0.3.0 => github.com/golang/text v0.3.0
5)

依赖库中的replace对你的主go.mod不起作用，比如github.com/smallnest/rpcx的go.mod已经增加了replace,但是你的go.mod虽然require了rpcx的库，但是没有设置replace的话， go get还是会访问golang.org/x。

所以如果想编译那个项目，就在哪个项目中增加replace。

6、版本格式

下面的版本都是合法的：

1gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7
2gopkg.in/vmihailenco/msgpack.v2 v2.9.1
3gopkg.in/yaml.v2 <=v2.2.1
4github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e
5latest