Go:模块管理

时间:Feb. 18, 2020 分类:

目录:

模块管理

最早的时候,Go所有的依赖包都放在GOPATH下,导致一个库只能保留一个版本

godep

Go在1.5版本引入了vendor模式,如果项目下有vendor目录,go工具链会优先使用vendor内的包进行编译

godep是一个通过vendor模式来管理Go语言的第三方依赖管理工具,类似的还有dep

安装godep

go get github.com/tools/godep

基本命令

  • godep save 将依赖项输出并复制到Godeps.json文件中
  • godep go 使用保存的依赖项运行go工具
  • godep get 下载并安装具有指定依赖项的包
  • godep path 打印依赖的GOPATH路径
  • godep restore 在GOPATH中拉取依赖的版本
  • godep update 更新选定的包或go版本
  • godep diff 显示当前和以前保存的依赖项集之间的差异
  • godep version 查看版本信息

使用godep

在项目目录下使用godep save命令,会在当前项目创建Godeps和vendor目录(如果项目有依赖第三方库的时候)

$ godep save
$ cat Godeps/Godeps.json
{
    "ImportPath": "demo",
    "GoVersion": "go1.10",
    "GodepVersion": "v80",
    "Deps": [
        {
            "ImportPath": "github.com/go-sql-driver/mysql",
            "Comment": "v1.5.0-2-g5a8a207",
            "Rev": "5a8a207333b3cbdd6f50a31da2d448658343637e"
        }
    ]
}
$ tree vendor/
vendor/
└── github.com
    └── go-sql-driver
        └── mysql
            ├── auth.go
            ├── AUTHORS
            ├── buffer.go
            ...

如果是新加入的包可以重新go save,如果是更新需要go update <包>,如果需要修改依赖的版本也可直接修改Godeps.json

go module

go module是1.11之后推出的版本管理工具,在1.13之后go module是go语言的默认管理工具

启用go module首先要设置环境变量GO111MODULE,有三个值off,on和auto,默认是auto

  • GO111MODULE=off 禁用模块支持,编译时会从GOPATH和vendor文件夹中查找包。
  • GO111MODULE=on 启用模块支持,编译时会忽略GOPATH和vendor文件夹,只根据 go.mod下载依赖。
  • GO111MODULE=auto 当项目在$GOPATH/src外且项目根目录有go.mod文件时,开启模块支持。

go module

  • go mod download 下载依赖的module到本地cache(默认为$GOPATH/pkg/mod目录)
  • go mod edit 编辑go.mod文件
  • go mod graph 打印模块依赖图
  • go mod init 初始化当前文件夹, 创建go.mod文件
  • go mod tidy 增加缺少的module,删除无用的module
  • go mod vendor 将依赖复制到vendor下
  • go mod verify 校验依赖
  • go mod why 解释为什么需要依赖

go.mod

go.mod文件

module demo

go 1.13

require (
    github.com/DeanThompson/ginpprof v0.0.0-20190408063150-3be636683586
    github.com/gin-gonic/gin v1.4.0
    github.com/go-sql-driver/mysql v1.4.1
    github.com/jmoiron/sqlx v1.2.0
    github.com/satori/go.uuid v1.2.0
    google.golang.org/appengine v1.6.1 // indirect
)
  • module用来定义包名
  • require用来定义依赖包及版本
  • indirect表示间接引用

依赖的版本

支持git分支或tag,git提交的hash等等

例如

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

因为访问golang.org/x的包都需要翻墙,可以使用replace

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
)

go get也是支持各种版本

  • 运行go get -u将会升级到最新的次要版本或者修订版本(x.y.z, z是修订版本号, y是次要版本号)
  • 运行go get -u=patch将会升级到最新的修订版本
  • 运行go get package@version将会升级到指定的版本号version

下载所有依赖使用go mod download

依赖整理

查找版本

go list -m -versions github.com/Shopify/sarama

格式化go.mod文件,主要用于手动修改

go mod edit -fmt

亦可通过go mod手动操作,添加依赖项

go mod edit -require=golang.org/x/text

移除依赖项

go mod edit -droprequire=golang.org/x/text

对于已有项目使用go module

  • 在项目目录下执行go mod init,生成一个go.mod文件
  • 执行go get,查找并记录当前项目的依赖,同时生成一个go.sum记录每个依赖库的版本和哈希值

对于新的项目

  • 执行go mod init项目名命令,在当前项目文件夹下创建一个go.mod文件
  • 手动编辑go.mod中的require依赖项或执行go get自动发现、维护依赖

go proxy

export GOPROXY=https://goproxy.cn

在1.13版本之后使用

go env -w GOPROXY=https://goproxy.cn,direct

windows下构建linux运行程序

set GOARCH=amd64 
set GOOS=linux