解析GOROOT、GOPATH、Go-Modules-三者的关系

一、GOROOT介绍

在安装完Golang语言的时候，所谓的安装路径其实就是你的GOROOT路径，也就是说GOROOT存放的Golang语言内建的程式库的所在位置，而通常你安装完后，你电脑的环境变数就会设好GOROOT路径，当你开发Golang程式的时候，当你import内建的程式库的时候，并不需要额外安装，而当程式运行后，预设也会先去GOROOT路径下寻找相对应的程式库来运行。

1、查看Glang环境变量

go env

env中有些是我已经修改过的，通常如果你是初次安装Golang语言并且没做什么环境变数设定的话，GOROOT设定路径就是你当初安装Golang语言的路径，而GOPATH通常预设会是使用者目录下的go资料夹。

2、使用 go run 执行某个文件

package main

import (
	"fmt"
)

func main() {
	fmt.Println("hello world")
}

然后再执行以下指令：

go run main.go

就会成功输出hello world，go run其实会帮你将程式码进行编译并产生执行档，而编译档跟执行档事实上是存在一个暂存资料夹里面，当运行完此程式就会自动删除。该指令可以想成类似直译的方式运行，而不需要做其他任何环境设定，即可运行。

3、引用第三方套件

package main

import (
	"github.com/gin-gonic/gin"
)

func main() {
	router := gin.Default()
	router.Run()
}

import了一个github.com/gin-gonic/gin套件，这个是别人开发的Web Framework套件，是不存在于官方程式库的，而是放在GitHub上的第三方套件。

• 当执行Golang程式码，当需要存取套件时，会先去GOROOT路径下的src资料夹找同等于我们在程式码中import的路径下去找有没有gin这个资料夹，而这资料夹里面就是包含了所有有关于该套件的程式库。
• 如果在GOROOT路径下没有找到，则会往GOPATH路径下的src资料夹找同等于我们在程式码中import的路径下去找有没有gin这个资料夹。

所以只要GOROOT跟GOPATH路径下都没有找到该套件的话，就无法执行该程式码。

二、GOPATH介绍

根据上面GOROOT的介绍，我们可以知道官方的程式库所在位置就是在GOROOT里面，而GOPATH就是专门存放第三方套件以供我们程式码的需要。那通常开发Golang的话，通常会在重新设定GOPATH的位置。

1、GOPATH目录

bin
pkg
src

依照Golang语言的惯例(强制)，GOPATH是指src路径的上一层，我们要在GOPATH路径下主动新增src资料夹，所谓src就是代表source code的意思，也就是放我们开发Golang程式码的相关专案的原始码。

2、GOPATH的缺点

第三方套件只要不是官方程式库，都需要放置在GOPATH/src的路径下才可以使用。

go get最常用在当我们想用别人公开在GitHub上的套件，可以帮我们从网路上clone到GOPATH/src里面。虽然这样很方便，但是你会发现GOPATH/src下的程式码会很复杂，除了有你自己开发的专案资料夹，也包含其他第三方程式库的专案资料夹。

再来，如果你开发的专案采用第三方套件是不同版本怎么办？以往的解决方法是要设定多组不同的GOPATH。虽然社群也有开发相对应的package manager，如Vendor、Dep来解决该问题，但毕竟不是官方主导的。

三、Go Modules的诞生

为了解决不被GOPATH的问题，因此官方在1.11开始推出了Go Modules的功能。Go Modules解决方式很像是Java看到Maven的做法，将第三方程式库储存在本地的空间，并且给程式去引用。

1、设定GO111MODULE环境变数

总共可以三种不同的值：

• auto
  

默认值，go命令会根据当前目录来决定是否启用modules功能。需要满足两种情形：
该专案目录不在GOPATH/src/下
当前或上一层目录存在go.mod档案

• on

go命令会使用modules，而不会GOPATH目录下查找。

• off
  

go命令将不会支持module功能，寻找套件如以前GOPATH的做法去寻找。

我是建议要开发Go专案就不再使用GOPATH的功能了，而是采用Go Modules的做法，因此建议都设定为on。
而采用Go Modules，下载下来的第三方套件都在哪呢？其实就位在GOPATH/pkg/mod资料夹里面。

2、初始化mod

go mod init <module name>

<module name>可填可不填，不填的话预设就是采用专案资料夹的名称。

在此档案内可以写以下几个关键字：

• module
  

定义模组路径

• go
  

定义go语言version

• require
  

指定依赖的套件，预设是最新版，可以指定版本号

• exclude
  

排除该套件和其版本

• replace
  

使用不同的套件版本并替换原有的套件版本注解
// 单行注解
/* 多行注解*/
indirect 代表被间接导入的依赖包

假设现在我要引入GitHub上的gin-gonic/gin的套件，如下定义：

module awesomeProject

go 1.13

require github.com/gin-gonic/gin v1.6.3

再执行以下指令：

go mod download

会将需要的套件安装在GOPATH/pkg/mod资料夹里面。而且会发现出现一个go.sum的档案，这个档案基本上用来记录套件版本的关系，确保是正确的，是不太需要理会的。

官方说明：除了go.mod之外，go命令还维护一个名为go.sum的文件，其中包含特定模块版本内容的预期加密哈希
go命令使用go.sum文件确保这些模块的未来下载检索与第一次下载相同的位，以确保项目所依赖的模块不会出现意外更改，无论是出于恶意、意外还是其他原因。 go.mod和go.sum都应检入版本控制。
go.sum 不需要手工维护，所以可以不用太关注。

如果将gin版本改成v1.4.0再重新执行go mod download，就会发现在GOPATH/pkg/mod里面gin-gonic会有两个资料夹分别是gin@v1.4.0、gin@v1.5.0，借此来区分版本。

当然其实也可以不执行go mod download，而直接运行go build or go install 也会自动将套件安装在相对应的地方。

还有一种方式直接下载套件而不用在go.mod中定义：

go get github.com/gin-gonic/gin@v1.5.0

只要有开启go modules功能，go get 就不会像以前一样在GOPATH/src下放置套件档案，而是会放在GOPATH/pkg/mod里面，并且go.mod会写好引入，这样也就不用使用go mod download指令了。