go module是什么？怎么用？（附使用示例）


go module 使用

go module 在 go 1.14 版本之后被推出

一、go module 使用介绍

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

1.1 GO111MODULE

要启用​​go module​​​支持首先要设置环境变量​​GO111MODULE​​​，通过它可以开启或关闭模块支持，它有三个可选值：​​off​​​、​​on​​​、​​auto​​​，默认值是​​auto​​。

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

简单来说，设置​​GO111MODULE=on​​​之后就可以使用​​go module​​了，以后就没有必要在GOPATH中创建项目了，并且还能够很好的管理项目依赖的第三方包信息。

使用 go module 管理依赖后会在项目根目录下生成两个文件​​go.mod​​​和​​go.sum​​。

1.2 GOPROXY

Go1.11之后设置GOPROXY命令为：

​​export GOPROXY=https:​​​​//goproxy.cn​​

Go1.13之后​​GOPROXY​​​默认值为​​https://proxy.golang.org，在国内是无法访问的，所以十分建议大家设置GOPROXY，这里我推荐使用goproxy.cn。​​

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

1.3 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         解释为什么需要依赖​​

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

1.4.1 依赖的版本

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​​


1.4.2 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​​
​​)​​

1.5 go get

在项目中执行​​go get​​命令可以下载依赖包，并且还可以指定下载的版本。

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

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

1.6 整理依赖

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

1.7 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​​查看。

1.8 在项目中使用go module

1.8.1 既有项目

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

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

1.8.2 新项目

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

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

二、包和调用文件在同一项目下

例如：

​​moduledemo​​
​​├── go.mod​​
​​├── main.go​​
​​└── mypackage​​
​​└── mypackage.go  ​​​​// package mp 定义包名为 mp​​

步骤：

1.在项目下创建一个 go.mod 文件，文件名只能为这个。

2.在 go.mod 文件中添加以下代码

​​module moduledemo  ​​​​// 设定 moduledemo 为包根目录名，可以随意改变该名字，只需要导入时一致就好​​
​​go 1.14  ​​​​// 表明版本​​

3.导入想要的包文件

​​import ​​​​"moduledemo/mypackage"​​​  ​​// 这里是导入包目录下的包文件名​​

4.使用包文件

​​mp.MyPackage()  ​​​​// 使用包中的 MyPackage() 函数​​

三、包和被调用文件不在同一个项目下

例如：

​​├── moduledemo​​
​​│   ├── go.mod​​
​​│   └── main.go​​
​​└── mypackage​​
​​├── go.mod​​
​​└── mypackage.go  ​​​​// package mp 定义包名为 mp​​

步骤

1.在 mypackage 下面创建 go.mod 文件，并添加以下代码

​​module mypackage​​

​​go 1.14​​

2.在 moduledemo 下面创建 go.mod 文件，并添加以下代码

​​module moduledemo​​

​​go 1.14​​


​​require​​​ ​​mypackage v0.0.0  ​​​​// 这个会在你执行 go build 之后自动在该文件添加​​
​​replace mypackage => ../mypackage  ​​​​// 指定需要的包目录去后面这个路径中寻找​​

3.导入和使用

​​import ​​​​"mypackage"​​​  ​​// 因为该包目录本身就是包文件所以无需添加下一级路径​​

​​mp.MyPackage()  ​​​​// 使用包中的 MyPackage() 函数​​