golang的包管理工具--glide使用说明

2020-12-16 16:41:55 编辑 0 阅读量:420

## 一、介绍
不论是开发Java还是你正在学习的Golang，都会遇到依赖管理问题。Java有牛逼轰轰的Maven和Gradle。 Golang亦有godep、govendor、glide、gvt、gopack等等，本文主要给大家介绍gilde。 glide是Golang的包管理工具，是为了解决Golang依赖问题的。 为什么需要glide？ 原因很简单，Go 语言原生包管理的缺陷。罗列一下golang的 get 子命令管理依赖有很多大缺陷：

- 能拉取源码的平台很有限，绝大多数依赖的是 github.com
- 不能区分版本，以至于令开发者以最后一项包名作为版本划分
- 依赖 列表/关系 无法持久化到本地，需要找出所有依赖包然后一个个 go get
- 只能依赖本地全局仓库（GOPATH/GOROOT），无法将库放置于局部仓库（$PROJECT_HOME/vendor）

## 二、安装
#### Golang环境设置
采用vendor目录特性，Go 1.5 做为试验特性加入（需要指定 GO15VENDOREXPERIMENT=1 环境变量），并在 Go 1.6 正式引入的一个概念。多数 go 依赖解决方案都基于它的。GO15VENDOREXPERIMENT 是 Go 1.5 版本新增的一个环境变量，如果将值改为 1 则表示启用。它可以将项目根目录名为 vendor 的目录添加到 Go 的库搜寻路径中，实现一个局部依赖的效果。
特性在 1.5 版本作为实验特性被添加，1.6 中默认被启用，1.7 移除变量加入标准中。
Go 提供了原始的 go get ，让第三方包管理可以基于 go get 做扩展。GO15VENDOREXPERIMENT 特性让局部依赖成为现实。Go 官方在给第三方包管理营造条件以及引导开发者用户至所推荐的方向，促进社区的繁荣。证明了一个语言技术的生态不仅仅只能靠官方或者取决于官方的完善程度。

//设置环境变量 使用vendor目录
GO15VENDOREXPERIMENT=1
为什么要选择glide？ Glide 是众多实现 GO15VENDOREXPERIMENT 特性的包管理工具之一，但它是本文最为推荐的，具体为什么推荐它，原因很简单，因为它目前最受关注。 几大主要功能：
- 持久化依赖列表至配置文件中，包括依赖版本（支持范围限定）以及私人仓库等
- 持久化关系树至 lock 文件中（类似于 yarn 和 cargo），以重复拉取相同版本依赖
- 兼容 go get 所支持的版本控制系统：Git, Bzr, HG, and SVN
- 支持 GO15VENDOREXPERIMENT 特性，使得不同项目可以依赖相同项目的不同版本
- 可以导入其他工具配置，例如： Godep, GPM, Gom, and GB

#### 安装glide
`$ go get github.com/Masterminds/glide`
需要把$GOPAH/bin加入$PATH中

#### 验证
`$ glide`

## 三、使用
篇幅有限，我只介绍经常使用到的。 先进入在GOPATH的一个项目中。
#### 初始化
```
cd $GOPATH/src/foor
初始化 (glide init)
$ glide init
[INFO]  Generating a YAML configuration file and guessing the dependencies
[INFO]  Attempting to import from other package managers (use --skip-import to skip)
[INFO]  Scanning code to look for dependencies
[INFO]  --> Found reference to github.com/urfave/cli
[INFO]  Writing configuration file (glide.yaml)
[INFO]  Would you like Glide to help you find ways to improve your glide.yaml configuration?
[INFO]  If you want to revisit this step you can use the config-wizard command at any time.
[INFO]  Yes (Y) or No (N)?
Y
[INFO]  Loading mirrors from mirrors.yaml file
[INFO]  Looking for dependencies to make suggestions on
[INFO]  --> Scanning for dependencies not using version ranges
[INFO]  --> Scanning for dependencies using commit ids
[INFO]  Gathering information on each dependency
[INFO]  --> This may take a moment. Especially on a codebase with many dependencies
[INFO]  --> Gathering release information for dependencies
[INFO]  --> Looking for dependency imports where versions are commit ids
[INFO]  Here are some suggestions...
[INFO]  The package github.com/urfave/cli appears to have Semantic Version releases (http://semver.org).
[INFO]  The latest release is v1.19.1. You are currently not using a release. Would you like
[INFO]  to use this release? Yes (Y) or No (N)
Y
[INFO]  Would you like to remember the previous decision and apply it to future
[INFO]  dependencies? Yes (Y) or No (N)
Y
[INFO]  Updating github.com/urfave/cli to use the release v1.19.1 instead of no release
[INFO]  The package github.com/urfave/cli appears to use semantic versions (http://semver.org).
[INFO]  Would you like to track the latest minor or patch releases (major.minor.patch)?
[INFO]  Tracking minor version releases would use '>= 1.19.1, < 2.0.0' ('^1.19.1'). Tracking patch version
[INFO]  releases would use '>= 1.19.1, < 1.20.0' ('~1.19.1'). For more information on Glide versions
[INFO]  and ranges see https://glide.sh/docs/versions
[INFO]  Minor (M), Patch (P), or Skip Ranges (S)?
P
[INFO]  Would you like to remember the previous decision and apply it to future
[INFO]  dependencies? Yes (Y) or No (N)
Y
[INFO]  Updating github.com/urfave/cli to use the range ~1.19.1 instead of commit id v1.19.1
[INFO]  Configuration changes have been made. Would you like to write these
[INFO]  changes to your configuration file? Yes (Y) or No (N)
Y
[INFO]  Writing updates to configuration file (glide.yaml)
[INFO]  You can now edit the glide.yaml file.:
[INFO]  --> For more information on versions and ranges see https://glide.sh/docs/versions/
[INFO]  --> For details on additional metadata see https://glide.sh/docs/glide.yaml/
$ ll
glide.yaml
$ cat glide.yaml 
package: foor
import: []
```
在初始化过程中， glide 会询问一些问题。 glide.yaml记载了依赖包的列表及其更新规则，每次执行 glide up 时，都会按照指定的规则（如只下载补丁(patch)不下载升级(minor)）下载新版。

一个完整的gilde.yaml
```
package: foor
# 去除包
ignore:
- appengine
- golang.org/x/net
# 排除目录
excludeDirs:
- node_modules
# 导入包
import:
- package: github.com/astaxie/beego
  version: 1.8.0
- package: github.com/coocood/freecache
- package: github.com/garyburd/redigo/redis
- package: github.com/go-sql-driver/mysql
- package: github.com/bitly/go-simplejson
- package: git.oschina.net/qiangmzsx/beegofreecache
testImport:
- package: github.com/smartystreets/goconvey
  subpackages:
  - convey
```

#### 版本号指定规则
```
=: equal (aliased to no operator)
!=: not equal
>: greater than
<: less than
>=: greater than or equal to
<=: less than or equal to

1.2 - 1.4.5 which is equivalent to >= 1.2, <= 1.4.5
2.3.4 - 4.5 which is equivalent to >= 2.3.4, <= 4.5
1.2.x is equivalent to >= 1.2.0, < 1.3.0

>= 1.2.x is equivalent to >= 1.2.0
<= 2.x is equivalent to < 3
* is equivalent to >= 0.0.0

~1.2.3 is equivalent to >= 1.2.3, < 1.3.0
~1 is equivalent to >= 1, < 2
~2.3 is equivalent to >= 2.3, < 2.4
~1.2.x is equivalent to >= 1.2.0, < 1.3.0
~1.x is equivalent to >= 1, < 2

^1.2.3 is equivalent to >= 1.2.3, < 2.0.0
^1.2.x is equivalent to >= 1.2.0, < 2.0.0
^2.3 is equivalent to >= 2.3, < 3
^2.x is equivalent to >= 2.0.0, < 3
```
''指定版本报错，需要用''指定的可以不填写

#### 安装依赖 (glide install)
glide.yaml我们已经准备好了，现在就改安装一下试试。
```

$ glide install
[INFO]    Lock file (glide.lock) does not exist. Performing update.
[INFO]    Downloading dependencies. Please wait...
[INFO]    --> Fetching updates for github.com/go-sql-driver/mysql
[INFO]    --> Fetching updates for github.com/astaxie/beego
[INFO]    --> Fetching updates for github.com/coocood/freecache
[INFO]    --> Fetching updates for git.oschina.net/caitinggui/beegofreecache
[INFO]    --> Fetching updates for github.com/bitly/go-simplejson
[INFO]    --> Fetching updates for github.com/garyburd/redigo
[INFO]    --> Fetching updates for github.com/smartystreets/goconvey
[INFO]    --> Detected semantic version. Setting version for github.com/astaxie/beego to v1.8.0
[INFO]    Resolving imports
[INFO]    Downloading dependencies. Please wait...
[INFO]    Setting references for remaining imports
[INFO]    Exporting resolved dependencies...
[INFO]    --> Exporting github.com/astaxie/beego
[INFO]    --> Exporting github.com/coocood/freecache
[INFO]    --> Exporting github.com/bitly/go-simplejson
[INFO]    --> Exporting github.com/go-sql-driver/mysql
[INFO]    --> Exporting github.com/garyburd/redigo
[INFO]    --> Exporting github.com/smartystreets/goconvey
[INFO]    --> Exporting git.oschina.net/caitinggui/beegofreecache
[INFO]    Replacing existing vendor dependencies
[INFO]    Project relies on 6 dependencies.
$ ll
total 12
glide.lock
glide.yaml
vendor
$ ll vendor/
git.oschina.net
github.com
```
看到glide.look了吗，这个文件记载了依赖包确定的revision, 下次再执行 glide install 时，会直接读这个文件下载确定的版本。

#### 升级版本 (glide up)
glide up 会按照语义化版本规则更新依赖包代码，开发过程中如果需要使用新版代码，可以执行这个命令：
修改一下glide.yaml中的一个Package.
```
- package: github.com/astaxie/beego
  version: 1.8.3
```
执行glide up。
```
$ glide up
[INFO]    Downloading dependencies. Please wait...
[INFO]    --> Fetching updates for git.oschina.net/caitinggui/beegofreecache
[INFO]    --> Fetching updates for github.com/garyburd/redigo
[INFO]    --> Fetching updates for github.com/go-sql-driver/mysql
[INFO]    --> Fetching updates for github.com/astaxie/beego
[INFO]    --> Fetching updates for github.com/bitly/go-simplejson
[INFO]    --> Fetching updates for github.com/coocood/freecache
[INFO]    --> Fetching updates for github.com/smartystreets/goconvey
[INFO]    --> Detected semantic version. Setting version for github.com/astaxie/beego to v1.8.3
[INFO]    Resolving imports
[INFO]    Downloading dependencies. Please wait...
[INFO]    Setting references for remaining imports
[INFO]    Exporting resolved dependencies...
[INFO]    --> Exporting github.com/astaxie/beego
[INFO]    --> Exporting github.com/bitly/go-simplejson
[INFO]    --> Exporting github.com/garyburd/redigo
[INFO]    --> Exporting github.com/go-sql-driver/mysql
[INFO]    --> Exporting github.com/coocood/freecache
[INFO]    --> Exporting github.com/smartystreets/goconvey
[INFO]    --> Exporting git.oschina.net/caitinggui/beegofreecache
[INFO]    Replacing existing vendor dependencies
[INFO]    Project relies on 6 dependencies.
```

#### 添加并下载依赖 (glide get)
除了自动从代码中解析 import 外，glide 还可以通过 glide get 直接下载代码中没有的依赖，与 go get 的用法基本一致：
```
$ glide get github.com/orcaman/concurrent-map
[INFO]    Preparing to install 1 package.
[INFO]    Attempting to get package github.com/orcaman/concurrent-map
[INFO]    --> Gathering release information for github.com/orcaman/concurrent-map
[INFO]    --> Adding github.com/orcaman/concurrent-map to your configuration
[INFO]    Downloading dependencies. Please wait...
[INFO]    --> Fetching updates for github.com/garyburd/redigo
[INFO]    --> Fetching updates for github.com/astaxie/beego
[INFO]    --> Fetching updates for github.com/go-sql-driver/mysql
[INFO]    --> Fetching updates for git.oschina.net/caitinggui/beegofreecache
[INFO]    --> Fetching updates for github.com/bitly/go-simplejson
[INFO]    --> Fetching github.com/orcaman/concurrent-map
[INFO]    --> Fetching updates for github.com/coocood/freecache
[INFO]    --> Fetching updates for github.com/smartystreets/goconvey
[INFO]    Resolving imports
[INFO]    Downloading dependencies. Please wait...
[INFO]    --> Detected semantic version. Setting version for github.com/astaxie/beego to v1.8.3
[INFO]    Exporting resolved dependencies...
[INFO]    --> Exporting github.com/smartystreets/goconvey
[INFO]    --> Exporting github.com/garyburd/redigo
[INFO]    --> Exporting github.com/go-sql-driver/mysql
[INFO]    --> Exporting github.com/orcaman/concurrent-map
[INFO]    --> Exporting github.com/astaxie/beego
[INFO]    --> Exporting github.com/bitly/go-simplejson
[INFO]    --> Exporting github.com/coocood/freecache
[INFO]    --> Exporting git.oschina.net/caitinggui/beegofreecache
[INFO]    Replacing existing vendor dependencies
使用镜像 (glide mirror)
[WARN]    Unable to checkout golang.org/x/crypto
[ERROR]    Update failed for golang.org/x/crypto: Cannot detect VCS
[ERROR]    Failed to do initial checkout of config: Cannot detect VCS
```
这几行信息估计很多人都是遇到过的。在我天朝或者在公司内部都可能不能访问一些站点，导致很Golang的依赖包不能通过go get下载。此时也就是glide大发神威的时候到了，可以通过配置将墙了的版本库 URL 映射到没被墙的 URL，甚至也可以映射到本地版本库。 将golang.org映射到github: 修改glide.yaml加入

`- package: golang.org/x/crypto`
如果你的网络可以访问就不需要使用glide镜像功能，可以跳过。
```
$ glide mirror set golang.org/x/crypto github.com/golang/crypto
[INFO]    golang.org/x/crypto being set to github.com/golang/crypto
[INFO]    mirrors.yaml written with changes
$ glide up
[INFO]    Loading mirrors from mirrors.yaml file
[INFO]    Downloading dependencies. Please wait...
[INFO]    --> Fetching updates for github.com/orcaman/concurrent-map
[INFO]    --> Fetching golang.org/x/crypto
[INFO]    --> Fetching updates for github.com/astaxie/beego
[INFO]    --> Fetching updates for github.com/go-sql-driver/mysql
[INFO]    --> Fetching updates for github.com/garyburd/redigo
[INFO]    --> Fetching updates for github.com/coocood/freecache
[INFO]    --> Fetching updates for github.com/bitly/go-simplejson
[INFO]    --> Fetching updates for git.oschina.net/caitinggui/beegofreecache
[INFO]    --> Fetching updates for github.com/smartystreets/goconvey
[INFO]    --> Detected semantic version. Setting version for github.com/astaxie/beego to v1.8.3
[INFO]    Resolving imports
[INFO]    Downloading dependencies. Please wait...
[INFO]    Setting references for remaining imports
[INFO]    Exporting resolved dependencies...
[INFO]    --> Exporting github.com/astaxie/beego
[INFO]    --> Exporting github.com/coocood/freecache
[INFO]    --> Exporting github.com/smartystreets/goconvey
[INFO]    --> Exporting github.com/garyburd/redigo
[INFO]    --> Exporting github.com/go-sql-driver/mysql
[INFO]    --> Exporting github.com/bitly/go-simplejson
[INFO]    --> Exporting github.com/orcaman/concurrent-map
[INFO]    --> Exporting golang.org/x/crypto
[INFO]    --> Exporting git.oschina.net/caitinggui/beegofreecache
[INFO]    Replacing existing vendor dependencies
[INFO]    Project relies on 8 dependencies.
$ ll vendor/
git.oschina.net
github.com
golang.org
```
终于看到golang.org啦！！！ 细心的你一定已经发现了

`[INFO]    mirrors.yaml written with changes`
说明执行glide mirror时候镜像配置写入到的是$HOME/.glide/mirrors.yaml中，打开看看。
```
repos:
- original: golang.org/x/crypto
  repo: github.com/golang/crypto
```
还可以映射到本地目录。
```
$ glide mirror set golang.org/x/text /home/users/caitinggui/var/golang/golang.org/x/text
[INFO]    golang.org/x/text being set to /home/users/caitinggui/var/golang/golang.org/x/text
[INFO]    mirrors.yaml written with changes
$ glide up
[INFO]    Loading mirrors from mirrors.yaml file
[INFO]    Downloading dependencies. Please wait...
[INFO]    --> Fetching golang.org/x/text
[INFO]    --> Fetching updates for github.com/garyburd/redigo
[INFO]    --> Fetching updates for git.oschina.net/caitinggui/beegofreecache
[INFO]    --> Fetching updates for github.com/astaxie/beego
[INFO]    --> Fetching updates for github.com/bitly/go-simplejson
[INFO]    --> Fetching updates for github.com/go-sql-driver/mysql
[INFO]    --> Fetching updates for github.com/coocood/freecache
[INFO]    --> Fetching updates for github.com/orcaman/concurrent-map
[INFO]    --> Fetching updates for golang.org/x/crypto
[INFO]    --> Fetching updates for github.com/smartystreets/goconvey
[INFO]    --> Detected semantic version. Setting version for github.com/astaxie/beego to v1.8.3
[INFO]    Resolving imports
[INFO]    Downloading dependencies. Please wait...
[INFO]    Setting references for remaining imports
[INFO]    Exporting resolved dependencies...
[INFO]    --> Exporting github.com/astaxie/beego
[INFO]    --> Exporting github.com/go-sql-driver/mysql
[INFO]    --> Exporting github.com/bitly/go-simplejson
[INFO]    --> Exporting github.com/coocood/freecache
[INFO]    --> Exporting github.com/smartystreets/goconvey
[INFO]    --> Exporting github.com/garyburd/redigo
[INFO]    --> Exporting github.com/orcaman/concurrent-map
[INFO]    --> Exporting golang.org/x/text
[INFO]    --> Exporting golang.org/x/crypto
[INFO]    --> Exporting git.oschina.net/caitinggui/beegofreecache
[INFO]    Replacing existing vendor dependencies
[INFO]    Project relies on 9 dependencies.
```
#### 全局选项
运行glide，在最后就可以看到
```
GLOBAL OPTIONS:
   --yaml value, -y value  Set a YAML configuration file. (default: "glide.yaml")
   --quiet, -q             Quiet (no info or debug messages)
   --debug                 Print debug verbose informational messages
   --home value            The location of Glide files (default: "/home/users/caitinggui/.glide") [$GLIDE_HOME]
   --tmp value             The temp directory to use. Defaults to systems temp [$GLIDE_TMP]
   --no-color              Turn off colored output for log messages
   --help, -h              show help
   --version, -v           print the version
```
在官网中会看到一个GLIDE_HOME变量，该变量就是`~/.glide`。 这个目录之前有提到过，除了包含有mirrors.yaml还有一个很重要的目录cache本地 cache,每次更新代码时， glide 都会在本地保存 cache，以备下次 glide install 使用 。

## 四、注意
- 设置mirror
国内因为被墙的原因，`golang.com/`下的包都无法下载，需要用mirror
```
$ mkdir ~/.glide    # 如果有该目录可以忽略
$ glide mirror set https://golang.org/x/mobile https://github.com/golang/mobile --vcs git
$ glide mirror set https://golang.org/x/crypto https://github.com/golang/crypto --vcs git
$ glide mirror set https://golang.org/x/net https://github.com/golang/net --vcs git
$ glide mirror set https://golang.org/x/tools https://github.com/golang/tools --vcs git
$ glide mirror set https://golang.org/x/text https://github.com/golang/text --vcs git
$ glide mirror set https://golang.org/x/image https://github.com/golang/image --vcs git
$ glide mirror set https://golang.org/x/sys https://github.com/golang/sys --vcs git
```
然后找个空目录用`glide get`把上面的包都下载了，这样是为了建立缓存，以后碰到奇葩的`golang.org/x/sys/unix`就可以下载
- 忽略的目录
glide会忽略以`-`, `.`开头的目录，计算依赖的时候会跳过

--- 
参考：
- [1][Glide总是报错，我已经设置过镜像了啊~~](https://gocn.vip/question/1605)
- [2][Golang官方依赖管理工具：dep](https://studygolang.com/articles/10589)
- [3][glide install golang.org 失败](https://blog.csdn.net/wj199395/article/details/78603642)

golang的包管理工具--glide使用说明

附件: