Go Modules 包管理

最新推荐文章于 2024-06-21 22:06:52 发布
最新推荐文章于 2024-06-21 22:06:52 发布
阅读量466 收藏 2
点赞数 1
分类专栏： Go 文章标签： go gomod
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/eight_eyes/article/details/117286728
版权

Go Package 管理发展史

Go 依赖管理是通过 Git 仓库模式实现，并随着版本的更迭已经逐渐完善

  • GOPATH 模式
    GOPATH 目录是所有工程的公共依赖包目录，所有需要编译的 go 工程的依赖包都放在 GOPATH 目录下。
  • Vendor 特性
    为了解决 GOPATH 模式下，多个工程需要共享 GOPATH 目录，无法适用于各个工程对于不同版本的依赖包的使用，不便于更新某个依赖包。 go 1.6 之后开启了 vendor 目录。
  • Go Module 包管理
    从 Go1.11 以后开始支持 Module 依赖管理工具，从而实现了依赖包的进行升级更新，在 Go1.13 版本后默认打开。

GOPATH 环境变量

GOPATH 为 Go 开发环境时所设置的一个环境变量。

历史版本的 go 语言开发时，需要将代码放在 GOPATH 目录的 src 文件夹下。go get 命令获取依赖，也会自动下载到 GOPATH 的 src 下。

go get github.com/foo/bar
会将代码下载到 $GOPATH/src/github.com/foo/bar

GOPATH 具体结构如下，必须包含三个文件夹，具体如下图所示：

GOPATH
 |── bin              // 编译生成的二进制文件
 |── pkg              // 预编译文件，以加快程序的后续编译速度
 |── src              // 所有源代码
    ├── github.com
    ...

Go Modules 介绍

go.mod是Golang1.11版本新引入的官方包管理工具用于解决之前没有地方记录依赖包具体版本的问题，方便依赖包的管理。

go.mod其实就是一个Modules

一个 Go Module 是一个 Go 包的集合。module 是有版本的，所以 module 下的包也就有了版本属性。这个 module 与这些包会组成一个独立的版本单元，它们一起打版本、发布和分发。

  • 在 Go Module 模式下，通常一个代码仓库对应一个 Go Module。一个 Go Module 的顶层目录下会放置一个 go.mod 文件，每个 go.mod 文件会定义唯一一个 module，也就是说 Go Module 与 go.mod 是一一对应的。

  • go.mod 文件所在的顶层目录也被称为 module 的根目录，module 根目录以及它子目录下的所有 Go 包均归属于这个 Go Module，这个 module 也被称为 main module。

Modules和传统的GOPATH不同，不需要包含例如src，bin这样的子目录，一个源代码目录甚至是空目录都可以作为Modules，只要其中包含有go.mod文件。

主要通过 go.mod 和 go.sum 组成，主要包括依赖模块路径定义，以及通过 checksum 方式进行保证包的安全性。并且 可以在 GOPATH 外进行创建和编译项目。

初步使用Go Modules

1. 开启 GO MODULE

export GO111MODULE=on

配置环境变量 GO111MODULE：有三个可选值： off、 on、 auto，默认值是 auto。

  • off：无模块支持，go会从 GOPATH 和 vendor 文件夹寻找包。
  • on：模块支持，go会忽略 GOPATH 和 vendor 文件夹，只根据 go.mod下载依赖。
  • auto：默认值，go命令行将会根据当前目录来决定是否启用module功能。
    1. 当前目录在GOPATH/src之外且该目录包含go.mod文件
    2. 当前文件在包含go.mod文件的目录下面。

2. 初始化项目

// 创建一个目录
$ mkdir hello
// 初始化项目
$ go mod init hello
go: creating new go.mod: module hello

已经成功使用 go mod 创建一个项目

go.mod文件一旦创建后，它的内容将会被go toolchain全面掌控。
go toolchain会在各类命令执行时，比如go get、go build、go mod等修改和维护go.mod文件。

在 非 GOPATH 目录下创建 Go项目执行 go mod init 报错: cannot determine module path for source directory xxxxxxx (outside GOPATH, module path must be specified) .
解决：go mod init 项目名
总结：非GOPATH目录下必须要加上项目名，GOPATH下可以不加

运行完之后，会在当前目录下生成一个go.mod文件，这是一个关键文件，之后的包的管理都是通过这个文件管理。

查看当前目录结构信息

$ tree
.
|____go.mod

注意：子目录里是不需要init的，所有的子目录里的依赖都会组织在根目录的go.mod文件里

// 输出go.mod内容
$ cat go.mod
module hello

go 1.16

3. 引入外部包

编写 main.go

package main

import log "github.com/sirupsen/logrus"

func main() {
	log.Info("hello")
}

通过 go get github.com/sirupsen/logrus，可以下载或者更新依赖包
也可以指定版本 path@v1.8.1

查看 go.mod 文件

module hello

go 1.16

require github.com/sirupsen/logrus v1.8.1

go.mod 介绍

go.mod 文件中可以使用到的语法关键词以及含义：

module hello //定义当前项目的模块路径

go 1.16 // 标识当前模块的 Go 语言版本，目前来看还只是个标识作用

// 说明 Module 需要什么版本的依赖 path@version
require github.com/sirupsen/logrus v1.8.1

// 用于从使用中排除一个特定的模块版本
exclude github.com/sirupsen/logrus v1.8.0 

// 替换 require 中声明的依赖，使用另外的依赖及其版本号 （用的名字 => 实际包）
replace github.com/sirupsen/logrus => github.com/sirupsen/logrus v1.8.2

go.sum 介绍

为了解决 Go Modules 的包被篡改安全隐患，Go 开发团队在引入 go.mod 的同时也引入了go.sum 文件，用于记录每个依赖包的哈希值，在构建时，如果本地的依赖包 hash值 与 go.sum 文件中记录得不一致，则会拒绝构建。

  • go.sum 文件中每行记录由 module 名、版本和哈希组成，并由空格分开；
  • 在引入新的依赖时，通常会使用 go get 命令获取该依赖，将会下载该依赖包下载到本地缓存目录 $GOPATH/pkg/mod/cache/download，该依赖包为一个后缀为 .zip 的压缩包，并且把哈希运算同步到 go.sum 文件中；
  • 在构建应用时，会从本地缓存中查找所有 go.mod 中记录的依赖包，并计算本地依赖包的哈希值 ，然后与 go.sum 中的记录进行对比，当校验失败，go 命令将拒绝构建。

注意

go.mod和go.sum都应检入版本控制。
go.sum 不需要手工维护，所以可以不用太关注。

Go Modules 代理

Go 1.13 将 GOPROXY 默认成 https://proxy.golang.org，但是国内无法访问，所以在国内需要配置代理进行使用。

GOPROXY 可以解决一些公司内部的使用问题：

  • 访问公司内网的 git 仓库
  • 防止公网仓库变更或者消失，导致线上编译失败或者紧急回退失败 （可以自己加一层代理，防止包不存在）
  • 公司审计和安全需要
  • 防止公司内部开发人员配置不当造成 import path 泄露 （使用GOPRIVATE防止访问到恶意包文件）
  • cache 热点依赖，降低公司公网出口带宽

GOPROXY

# 配置GOPROXY环境变量
# direct表示可以回源到原始的github
export GOPROXY=https://goproxy.cn,direct

GOPRIVATE

GOPRIVATE 用来控制 go 命令把哪些仓库看做是私有的仓库
这样的话，就可以跳过 proxy server 和校验检查，这个变量的值支持用逗号分隔，可以填写多个值，例如：

# 设置自己的仓库或者组（不走proxy）多个逗号相隔
export GOPRIVATE=*.corp.example.com,github.com/org_name

当配置 GOPRIVATE ，它的值同时也将作为 GONOPROXY 和 GONOSUMDB 的默认值，所以当配置 GOPRIVATE 后将会跳过代理，以及 checksum 效验检查。

通常推荐配置 GOPROXY 和 GOPRIVATE 进行使用，GOPRIVATE 也可以识别 Git SSH KEY 进行权限效验。

补充

go env方式配置

也可以使用 go env 的方式来进行配置

设置env 配置

go env -w 环境变量=值

# 开启gomod
go env -w GO111MODULE=on
# 使用七牛云代理  阿里云 https://mirrors.aliyun.com/goproxy
go env -w GOPROXY=https://goproxy.cn,direct

取消env配置

go env -u 环境变量

go mod cli 模式基本命令

命令解释
go mod init在当前目录初始化mod
go mod download下载依赖包 下载modules到本地cache 包在 GOPATH/pkg/mod 目录中，而且是只读文件
go mod vendor将依赖复制到vendor下 ，会生成vendor文件夹该文件夹下将会放置你go.mod文件描述的依赖包，文件夹下同时还有一个文件modules.txt
go mod verify验证依赖项是否达到预期的目的 如果所有的模块都没有被修改过，那么执行这条命令之后，会打印all modules verified
go mod tidy添加缺失的模块以及移除无用的模块 执行后会生成go.sum文件
go mod tidy -v可以将执行的信息，即删除和添加的包打印到命令行
go mod graph打印模块依赖图
go mod why解释为什么需要依赖
go clean -modcache清除mod下载的包

常见问题

一：依赖的包下载到哪里了？还在GOPATH/src里吗？

不在。
使用Go的包管理方式，依赖的第三方包被下载到了$GOPATH/pkg/mod路径下。

二： 依赖包的版本是怎么控制的？

在上一个问题里，可以看到最终下载在$GOPATH/pkg/mod下的包中最后会有一个版本号 v1.0.5，也就是说，$GOPATH/pkg/mod里可以保存相同包的不同版本。

版本是在go.mod中指定的。如果，在go.mod中没有指定，go命令会自动下载代码中的依赖的最新版本，本例就是自动下载最新的版本。如果，在go.mod用require语句指定包和版本 ，go命令会根据指定的路径和版本下载包，
指定版本时可以用latest，这样它会自动下载指定包的最新版本；

go get github.com/username/repository@vx.x.x下载并设置依赖项和更新go.mod文件的特定版本。

三： 可以把项目放在$GOPATH/src下吗？

可以。但是go会根据GO111MODULE的值而采取不同的处理方式，默认情况下，GO111MODULE=auto 自动模式

  1. auto 自动模式下，项目在 G O P A T H / s r c 里 会 使 用 GOPATH/src里会使用 GOPATH/src里会使用GOPATH/src的依赖包，在$GOPATH/src外，就使用go.mod 里 require的包
  2. on 开启模式，1.12后，无论在$GOPATH/src里还是在外面，都会使用go.mod 里 require的包
  3. off 关闭模式，就是老模式。

四： 依赖包中的地址失效了怎么办？比如 golang.org/x/… 下的包都无法下载怎么办？

在go快速发展的过程中，有一些依赖包地址变更了。以前的做法：

  1. 修改源码，用新路径替换import的地址
  2. git clone 或 go get 新包后，copy到$GOPATH/src里旧的路径下

无论什么方法，都不便于维护，特别是多人协同开发时。

使用go.mod就简单了，在go.mod文件里用 replace 替换包，例如
replace golang.org/x/text => github.com/golang/text latest

这样，go会用 github.com/golang/text 替代golang.org/x/text，原理就是下载github.com/golang/text 的最新版本到 $GOPATH/pkg/mod/golang.org/x/text下。

五： init生成的go.mod的模块名称有什么用？

本例里，用 go mod init hello 生成的go.mod文件里的第一行会申明module hello

因为我们的项目已经不在$GOPATH/src里了，那么引用自己怎么办？就用模块名+路径。

例如，在项目下新建目录 utils，创建一个tools.go文件:

package utils
 
import "fmt"
 
func PrintText(text string) {
    fmt.Println(text)
}

在根目录下的main.go文件就可以 import “hello/utils”引用utils

package main
 
import (
	"hello/utils"
	"github.com/astaxie/beego"
)
 
func main() {
	utils.PrintText("Hi")
	beego.Run()
}

六：以前老项目如何用新的包管理

如果用auto模式，把项目移动到$GOPATH/src外
进入目录，运行 go mod init + 模块名称
go build 或者 go run 一次

七：列出软件包的可用版本

go list -m -versions  github.com/sirupsen/logrus
github.com/sirupsen/logrus v0.1.0 v0.1.1 v0.2.0 v0.3.0 v0.4.0 v0.4.1 v0.5.0 v0.5.1 v0.6.0 v0.6.1 v0.6.2 v0.6.3 v0.6.4 v0.6.5 v0.6.6 v0.7.0 v0.7.1 v0.7.2 v0.7.3 v0.8.0 v0.8.1 v0.8.2 v0.8.3 v0.8.4 v0.8.5 v0.8.6 v0.8.7 v0.9.0 v0.10.0 v0.11.0 v0.11.1 v0.11.2 v0.11.3 v0.11.4 v0.11.5 v1.0.0 v1.0.1 v1.0.3 v1.0.4 v1.0.5 v1.0.6 v1.1.0 v1.1.1 v1.2.0 v1.3.0 v1.4.0 v1.4.1 v1.4.2 v1.5.0 v1.6.0 v1.7.0 v1.7.1 v1.8.0 v1.8.1
_wei丶
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Go-glide-Golang的包管理器
08-14
Go语言在早期版本中并未内置包管理工具，这使得在大型项目中管理依赖变得相对复杂。为了解决这个问题，社区开发了多个第三方包管理器，其中glide是早期较为流行的一个。glide是由Masterminds团队开发的，它的目标是...
Go-gom-Go包管理器
08-14
Go语言原生的包管理方式是基于`go mod`（Go Modules）系统，它允许开发者明确指定项目依赖，并且在构建时自动下载和管理这些依赖。然而，尽管`go mod`功能强大，但在某些场景下，开发者可能需要更高级或定制化的包...
GO MODULE 包管理
zhanglehes的专栏
10-22 291
本文介绍golang包管理工具。在golang v1.11版本之前使用gopath进行管理，但在不同项目对同一包不同版本依赖时会造成问题。golang v1.11之后的版本引入了go module进行包管理。 GOPATH 在1.11版本之前，golang是通过GOPATH这个环境变量来管理包依赖（包括第三方包和自己工程中的子包）。同时使用go get命令下载的包都会被放在GOPATH指定的目录下面。它的固定格式如下： $GOPATH bin/ # D
关于Go Modules环境搭建和包管理工具的使用
小哈里的博客
07-16 1068
文章目录1 GOPATH2 GoVendor3 Go Module4 一个例子 以前我经常吐槽python的包管理，直到我遇到了go… 1 GOPATH Go的依赖管理主要经历了3个阶段，分别是GOPATH, GoVendor, Go Module。 整个演进路线主要围绕实现两个目标来迭代发展的，分别是1，2 GOPATH是Go语言支持的一个环境变量，value是Go项目的工作区。 目录有以下结构: src存放Go项目的源码; pkg:存放编译的中间产物，加快编译速度; bin:存放Go项目编译
2024年Go最新Golang Proxy服务：构建高性能的网络代理_go proxy，2024年最新来一份全面的面试宝典练练手
2401_84910839的博客
05-11 983
代理服务需要处理大量的并发连接。为了提高性能，可以考虑对连接进行复用，减少连接的建立和断开开销，提高代理服务的并发处理能力。
go mod 本地包
oToyix的博客
05-15 249
go mod 本地包
3、Go mod及包管理
z2011415107的博客
01-04 383
一、 Golang 中包的介绍和定义 包（package） 是多个 Go 源码的集合， 是一种高级的代码复用方案， Go 语言为我们提供了很多内置包， 如 fmt、 strconv、 strings、 sort、 errors、 time、 encoding/json、 os、 io 等。Golang 中的包可以分为三种： 1、 系统内置包 2、 自定义包 3、 第三方包系统内置包: Golang 语言给我们提供的内置包， 引入后可以直接使用， 如 fmt、 strconv、 strings、sor...
Golang使用go.mod配置加载本地模块
热门推荐
蜗牛的专栏
05-15 2万+
Go现在通过 go.mod 文件来配置模块加载使用是非常方便了，下面说下如何在当前项目中加载另一个本地正在开发的模块： go.mod module github.com/zhouzme/test-go go 1.12 require github.com/zhouzme/snail-go v0.0.0-20190401091717-1f0218b38bc8 replace github.com...
Go Modules.docx
04-19
Go 模块（Go Modules）是自 Go 1.11 版本开始引入的用于管理 Go 项目依赖的一种机制。这个系统旨在解决早期 Go 语言依赖管理的混乱情况，如 GOPATH 和 vendoring 方式带来的问题。Go 1.14 及更高版本已经将模块支持...
go golang 1.19.2 linux 包
10-19
Go还提供了一个强大的包管理器`go modules`，帮助开发者管理和版本控制项目依赖。 5. **并发编程**：Go语言通过goroutines和channels提供了轻量级线程和通信原语，鼓励使用 CSP（Communicating Sequential ...
Go-Dep是一个Go依赖管理工具
08-14
Dep项目旨在解决Go语言早期版本中对库和依赖包管理的不足，使得开发过程更加有序和可预测。本文将深入探讨Dep的功能、用法以及它在Go开发中的重要性。 ### 1. Dep简介 Dep是由Google发起的一个开源项目，它为Go...
go module详解——导入本地包(go.mod)
General_zy的博客
05-29 1664
GOROOT和GOPATH都是环境变量，其中GOROOT是安装go开发包的路径，而从Go 1.8版本开始，Go开发包在安装完成后会为GOPATH设置一个默认目录。并且在Go1.14及之后的版本中启用了Go Module模式之后，不一定非要将代码写到GOPATH目录下，所以也就不需要再自己配置GOPATH了，使用默认的即可。想要查看电脑上的GOPATH路径，只需要打开终端输入以下命令并回车： 在终端输出的内容中找到GOPATH对应的具体路径。go module是Go1.11版本之后官方推出的版本管理工具，并且
go mod导入本地自定义包问题
lu2925028830的博客
01-16 1029
gomod导入自定义包
9012年都过了，还不会用go modules配置本地模块同学真要死了！
一个被知识诅咒的人
04-27 803
go语言从1.11开始加入了新的依赖管理模块go modules，从1.17开始，go将不再支持通过GOPATH方式设置本地模块搜索路径，所以要用本地模块的，这是最后的机会，赶紧升级吧，否则程序就无法编译了。
小白学习：Go mod本地包导入
赵凯月的博客
03-20 780
go
go mod如何导入本地包？
最新发布
2301_78108987的博客
06-21 338
我们在使用go开发的时候，经常会用到很多第三方的包，他们大多以开源的形式提供下载 ，如托管到github上，我们只需要使用就可以下载到，这很方便。但是我们也经常会遇到那种不开源的包，比如公司内别的部门开发的包，并没有开源，只是内部使用，这时如果我们要使用该包就不能再使用go get 了，本文就详细说明一下如何导入本地的包，以及过程中可能会遇到的坑。这种需要导入的包根据其是否使用go mod 管理分为两种情况。
一篇解决！小白迷惑：Go mod本地包导入
一个深技大小学生的博客
09-22 5965
Golang 本地包导入
GOROOT,GOPATH,GOMOD解析、Windows上Go环境配置、常用命令记录
Admans的专栏
06-09 63
可以设置多个，其中，第一个将会是默认的包目录，使用 go get 下载的包都会在第一个path中的src目录下，使用 go install时，在哪个GOPATH中找到了这个包，就会在哪个GOPATH下的bin目录生成可执行文件；， 初始化模块，module_name可填可不填，不填的话就是采用项目文件夹的名称，会在项目根目录下生成一个go.mod的文件。只要有开启gomod功能，go get就不会再把包放在src下的package，而是会放在。下载完成之后，一直Next，选择安装路径，Finish！
Go如何创建一个包并使用（导入本地包和注意事项）
ZhongUncle的博客
11-02 1572
Go 语言中，包（Package）的目的和其他语言中的库或模块是一样的，支持模块化、封装、单独编译和重用。有时候需要自己写一个包方便多次使用，但是在导入自己写的包时遇到了问题。我以前以为import部分直接就是包的路径，但是实际自己写了之后发现不是这样的。这部分实际上这部分是可以解释成一个标识符，是由一个go.mod文件确定，一般含义确实是路径末端。Go 中模块的概念其实还包含了一部分版本管理的功能。所以 Go 的模块和版本管理无论是学习还是开发都不是一件容易的事情，Go 团队也在一直努力调整和优化。
golang 包管理
06-07
在 Go 中，包管理是通过 Go Modules 实现的。Go Modules 是 Go 1.11 版本引入的一种包管理机制，它将包的依赖关系和版本信息存储在 go.mod 文件中，并且支持自动拉取依赖和版本控制。 使用 Go Modules 管理包的步骤如下： 1. 在项目根目录下初始化 Go Modules： ``` go mod init <module name> ``` 2. 导入需要的包： ``` import "github.com/user/package" ``` 3. 执行 `go build` 或 `go run` 命令时，Go 会自动拉取依赖并且保存到 go.mod 文件中。 4. 可以手动管理依赖版本，例如： ``` go get github.com/user/package@v1.0.0 ``` 这样会将指定包的版本锁定到 v1.0.0。 总之，Go Modules 提供了一种简单而强大的包管理方式，使得 Go 项目的依赖管理变得更加可靠和方便。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值