Go依赖包管理

GOROOT与GOPATH是什么？

GOROOT环境变量用于指定golang开发包的安装位置，其中go的标准库位于$GOROOT/src目录下。

GOPATH环境变量指定workspace的位置，workspace就是写代码的位置。用来指示go从哪里搜索go源文件和第三方包。

从Go 1.8版本开始，Go开发包在安装完成后会为GOPATH设置一个默认目录（默认位置为$HOME/go(Unix)或%USERPROFILE%\go(Windows)）。
Go1.11版本之后官方推出的版本管理工具go module。启用go module后，代码无需必须写在$GOPATH/src中，可以使用Go module配置代码在任何位置
从Go1.13版本开始，go module将是Go语言默认的依赖管理工具。
到Go1.14版本推出之后Go modules 功能已经被正式推荐在生产环境下使用了，安装开发包后不需要做任何配置，默认配置就可以直接使用go module。

go需要导入包时，会依次从$GOROOT/src和$GOPATH/pkg所设置的位置处搜索标准库和第三方包。

workspace是什么？

启用go module后，workspace基本就不具有存在的意义了。但是GOPATH还是有意义的，用于指定目录，存放第三方库文件或编译后可执行文件。

通过环境变量GOPATH设置workspace的路径。

由于可以将多个go项目放在同一个$GOPATH目录下，为了区分src下的不同的项目目录（或库文件目录），建议将每个项目目录设置为$GOPATH/src/{项目名称}/项目文件或目录。

每个workspace都是一个目录，这个目录下至少包含三个目录：

src：该目录用于存放项目源代码文件。使用go mod后，编写的go代码可以不放在该目录下。
bin：该目录用于存放可执行命令(即go install后可执行的二进制go程序，也称为命令文件)
pkg：该目录用于存放共享库文件(即go get|mod后非可执行程序的库包，也称为包对象文件；go mod相关命令下载的库包位于pkg/mod/目录下)

依赖包是什么？

每句代码都必须放在其中一个包中，使用package 包名声明当前文件属于哪个包。

一个包由位于单个目录下(不能跨多个目录)的一个或多个.go源代码文件组成。即一个包可以包含多个文件，但是这些文件都要放在同一个目录中。

目录名称一般与包名称一致，但是不用强制要求一致。

golang中包分为main包和库包(除了main包之外的包)。库包又分为标准包和第三方包。标准包位于$GOROOT/src目录下，第三方包下载后位于$GOPATH/pkg目录下。

go操作命令

go build：编译，编译后会在当前目录下生成一个可执行二进制文件：Windows下生成的是test.exe文件，Unix下生成的是test文件。编译时会对import导入的包进行搜索，搜索的路径为标准库所在路径$GOROOT/src、workspace下的src目录。它只会生成额外的可执行文件放在当前目录下，不会生成额外的库文件。

注意，生成的可执行文件名称可能会出乎意料：当go build以目录的形式进行编译，则生成的可执行文件名为目录名。当go build以go代码文件名的方式进行编译，则生成的可执行程序名为go源码文件名(去掉后缀.go或增加后缀.exe)。

go install：go install时会先进行编译，然后将编译后的二进制文件保存到第一个$GOPATH/bin目录下，将编译后的库文件放在$GOPATH/pkg目录下。go install时,首先要先进入到特定目录下，然后才能使用go install命令：

要么先进入到$GOPATH/src下，且只能对目录进行操作，不能对具体的go文件操作，因为go中包和目录名相同，但与go源文件名不一定相同。给go install指定一个目录名，就表示编译这个包名；
要么先进入项目目录下，然后直接go install，此时后面不加目录名（当前目录）。

go run：编译+运行，go run不会保留生成可执行的二进制文件，它实际上是将编译得到的文件放进一个临时目录，然后执行，执行完后自动清理临时目录。

go get：下载第三方包。不启用go module时，下载的第三方包存放在$GOPATH/pkg目录下，启用go module后，下载在$GOPATH/pkg/mod/目录下

go module

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

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 module模式下，go get下载的包会自动维护在go.mod文件中。

go mod download 下载所有依赖包

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

go mod tidy 整理依赖

我们在代码中删除依赖代码后，相关的依赖库并不会在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 mod edit的更多用法可以通过go help mod edit查看。

在项目中使用go module

既有项目

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

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

新项目

对于一个新创建的项目，我们可以在项目文件夹下按照以下步骤操作：

执行go mod init 项目名命令，在当前项目文件夹下创建一个go.mod文件。（项目名称不一定要与目录名相同）
手动编辑go.mod中的require依赖项或执行go get自动发现、维护依赖。

如何使用go module导入本地包

https://www.liwenzhou.com/posts/Go/import_local_package_in_go_module/

前提

假设我们现在有moduledemo和mypackage两个包，其中moduledemo包中会导入mypackage包并使用它的New方法。

mypackage/mypackage.go内容如下：

package mypackage

import "fmt"

func New(){
	fmt.Println("mypackage.New")
}

我们现在分两种情况讨论：

在同一个项目下

注意：在一个项目（project）下我们是可以定义多个包（package）的。

目录结构

现在的情况是，我们在moduledemo/main.go中调用了mypackage这个包。

moduledemo
├── go.mod
├── main.go
└── mypackage
    └── mypackage.go

导入包

这个时候，我们需要在moduledemo/go.mod中按如下定义：

module moduledemo

go 1.14

然后在moduledemo/main.go中按如下方式导入mypackage

package main

import (
	"fmt"
	"moduledemo/mypackage"  // 导入同一项目下的mypackage包
)
func main() {
	mypackage.New()
	fmt.Println("main")
}

举个例子

举一反三，假设我们现在有文件目录结构如下：

└── bubble
    ├── dao
    │   └── mysql.go
    ├── go.mod
    └── main.go

其中bubble/go.mod内容如下：

module github.com/q1mi/bubble

go 1.14

bubble/dao/mysql.go内容如下：

package dao

import "fmt"

func New(){
	fmt.Println("mypackage.New")
}

bubble/main.go内容如下：

package main

import (
	"fmt"
	"github.com/q1mi/bubble/dao"
)
func main() {
	dao.New()
	fmt.Println("main")
}

不在同一个项目下

目录结构

├── moduledemo
│   ├── go.mod
│   └── main.go
└── mypackage
    ├── go.mod
    └── mypackage.go

导入包

这个时候，mypackage也需要进行module初始化，即拥有一个属于自己的go.mod文件，内容如下：

module mypackage

go 1.14

然后我们在moduledemo/main.go中按如下方式导入：

import (
	"fmt"
	"mypackage"
)
func main() {
	mypackage.New()
	fmt.Println("main")
}

因为这两个包不在同一个项目路径下，你想要导入本地包，并且这些包也没有发布到远程的github或其他代码仓库地址。这个时候我们就需要在go.mod文件中使用replace指令。

在调用方也就是moduledemo/go.mod中按如下方式指定使用相对路径来寻找mypackage这个包。

module moduledemo

go 1.14


require "mypackage" v0.0.0
replace "mypackage" => "../mypackage"

举个例子

最后我们再举个例子巩固下上面的内容。

我们现在有文件目录结构如下：

├── p1
│   ├── go.mod
│   └── main.go
└── p2
    ├── go.mod
    └── p2.go

p1/main.go中想要导入p2.go中定义的函数。

p2/go.mod内容如下：

module liwenzhou.com/q1mi/p2

go 1.14

p1/main.go中按如下方式导入

import (
	"fmt"
	"liwenzhou.com/q1mi/p2"
)
func main() {
	p2.New()
	fmt.Println("main")
}

因为我并没有把liwenzhou.com/q1mi/p2这个包上传到liwenzhou.com这个网站，我们只是想导入本地的包，这个时候就需要用到replace这个指令了。

p1/go.mod内容如下：

module github.com/q1mi/p1

go 1.14


require "liwenzhou.com/q1mi/p2" v0.0.0
replace "liwenzhou.com/q1mi/p2" => "../p2"

此时，我们就可以正常编译p1这个项目了。

说再多也没用，自己动手试试吧。

Go依赖包管理

GOROOT与GOPATH是什么？

workspace是什么？

依赖包是什么？

go操作命令

go module

相关环境变量

GO111MODULE

GOPROXY

go mod命令

go.mod文件

依赖的版本

replace

go get 下载指定依赖包

go mod download 下载所有依赖包

go mod tidy 整理依赖

go mod edit

格式化

添加依赖项

移除依赖项

在项目中使用go module

既有项目

新项目

如何使用go module导入本地包

前提

在同一个项目下

目录结构

导入包

举个例子

不在同一个项目下

目录结构

导入包

举个例子