一、依赖管理

最早的时候,Go所依赖的所有的第三方库都放在GOPATH这个目录下面。这就导致了同一个库只能保存一个版本的代码。Go语言从v1.5开始开始引入vendor模式,如果项目目录下有vendor目录,那么go工具链会优先使用vendor内的包进行编译、测试等。godep是一个通过vender模式实现的Go语言的第三方依赖管理工具,类似的还有由社区维护准官方包管理工具dep

二、go module

go module是Go1.11版本之后官方推出的版本管理工具,并且从Go1.13版本开始,go module将是Go语言默认的依赖管理工具.

Go1.13之后GOPROXY默认值为https://proxy.golang.org,在国内无法访问的,建议设置GOPROXY:

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

三、go mod命令

常用的go mod命令如下:

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 github.com/Q1mi/studygo/blogger

go 1.12

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表示间接引用

依赖版本

go mod支持语义化版本号,比如go get foo@v1.2.3,也可以跟git的分支或tag,比如go get foo@master,当然也可以跟git提交哈希,比如go get foo@e3702bed2。关于依赖的版本支持以下几种格式:

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
latest

replace

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

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命令可以下载依赖包,并且还可以指定下载的版本。

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

如果下载所有依赖可以使用go mod download命令。

六、整理依赖

我们在代码中删除依赖代码后,相关的依赖库并不会在go.mod文件中自动移除。这种情况下我们可以使用go mod tidy命令更新go.mod中的依赖关系。

七、go mod edit

格式化:因为我们可以手动修改go.mod文件,所以有些时候需要格式化该文件。Go提供了一下命令:

go mod edit -fmt

添加依赖项:

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

移除依赖项:如果只是想修改go.mod文件中的内容,那么可以运行go mod edit -droprequire=package path,比如要在go.mod中移除golang.org/x/text包,可以使用如下命令

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

八、项目使用

既有项目

如果需要对一个已经存在的项目启用go module,可以按照以下步骤操作:

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

新建项目

在一个新项目中,如果需要使用go mod,需要先进行初始化,进入你的项目根目录,执行如下命令进行初始化:

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

在一个新项目中,如果需要使用go mod,需要先进行初始化,进入你的项目根目录,执行如下命令进行初始化:

go mod init uPlanet

初始化完成之后会在你的项目根目录生成一个go.mod文件(该文件就相当于 maven 的 pom.xml,或者 npm 的 package.json),go.mod文件内容如下:

module uPlanet

go 1.15

如果需要依赖第三方库,那么需要将第三方库声明到go.mod文件中,例如:

module uPlanet

go 1.1

require (
    gopkg.in/resty.v1 v1.12.0
)

配置完成之后执行 go mod download将依赖下载到本地,依赖下载成功之后我们就可以在代码中通过import来引入相关依赖了。例如我们新建main.go文件,完整代码如下:

package main

import (
    "fmt"

    "gopkg.in/resty.v1"
)

func main() {
    resp, err := resty.R().Get("http://www.baidu.com")
    if (err == nil) {
        fmt.Println(string(resp.Body()))
    }
}