AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

Go mod包依赖管理工具使用详解

2023-01-04 498
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Go mod包依赖管理工具使用详解

我个人觉得，一个包管理工具应该有以下功能：

基本功能

  1. 依赖管理
  2. 依赖包版本控制
  3. 对应的包管理平台
  4. 可以私有化部署

加分：

  1. 代码包是否可以复用
  2. 构建，测试,打包
  3. 发布上线

对比上面几点：

目前做的最好的也就 maven了，gradle没有使用过，不知道。

今天主角是go mod，先来谈谈没有使用go mod之前的问题。

使用go path问题

  1. 代码开发必须在go path src目录下，不然，就有问题。
  2. 依赖手动管理
  3. 依赖包没有版本可言

从这个看， go path不算包管理工具

govendor

  1. 解决了包依赖，一个配置文件就管理
  2. 依赖包全都下载到项目vendor下，每个项目都把有一份。拉取项目时,开始怀疑人生。

go mod介绍

go modules 是 golang 1.11 新加的特性。现在1.12 已经发布了，是时候用起来了。Modules官方定义为：

模块是相关Go包的集合。modules是源代码交换和版本控制的单元。 go命令直接支持使用modules，包括记录和解析对其他模块的依赖性。modules替换旧的基于GOPATH的方法来指定在给定构建中使用哪些源文件。

如何使用go mod

首先，必须升级go到1.11,目前版本是1.14

下面我以我自己升级演示：

### 卸载旧版本，删除对应文件
brew uninstall -f go
### 更新一下brew
brew update
### 安装go
brew install go

上面升级完了，使用 go version看下版本

go version go1.14.1 darwin/amd64

下面设置go mod和go proxy

go env -w GOBIN=/Users/youdi/go/bin
go env -w GO111MODULE=on
go env -w GOPROXY=https://goproxy.cn,direct // 使用七牛云的

注意： go env -w会将配置写到 GOENV="/Users/youdi/Library/Application Support/go/env"

下面看下我的配置

GO111MODULE="on"
GOARCH="amd64"
GOBIN="/Users/youdi/go/bin"
GOCACHE="/Users/youdi/Library/Caches/go-build"
GOENV="/Users/youdi/Library/Application Support/go/env"
GOEXE=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="darwin"
GOINSECURE=""
GONOPROXY=""
GONOSUMDB=""
GOOS="darwin"
GOPATH="/Users/youdi/go"
GOPRIVATE=""
GOPROXY="https://goproxy.cn,direct"
GOROOT="/usr/local/go"
GOSUMDB="off"
GOTMPDIR=""
GOTOOLDIR="/usr/local/go/pkg/tool/darwin_amd64"
GCCGO="gccgo"
AR="ar"
CC="clang"
CXX="clang++"
CGO_ENABLED="1"
GOMOD="/dev/null"
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -fdebug-prefix-map=/var/folders/8m/v_1j4dgs7rzgqq4p_4_8k_nr0000gn/T/go-build221113671=/tmp/go-build -gno-record-gcc-switches -fno-common"

我们看一下，我修改的内容

cat /Users/youdi/Library/Application Support/go/env

GO111MODULE=on
GOBIN=/Users/youdi/go/bin
GOPROXY=https://goproxy.cn,direct
GOSUMDB=off

GO111MODULE

GO111MODULE 有三个值：off, on和auto（默认值）。

GO111MODULE=off，go命令行将不会支持module功能，寻找依赖包的方式将会沿用旧版本那种通过vendor目录或者GOPATH模式来查找。

GO111MODULE=on，go命令行会使用modules，而一点也不会去GOPATH目录下查找。

GO111MODULE=auto，默认值，go命令行将会根据当前目录来决定是否启用module功能。这种情况下可以分为两种情形：

当前目录在GOPATH/src之外且该目录包含go.mod文件
当前文件在包含go.mod文件的目录下面。
复制代码

当modules功能启用时，依赖包的存放位置变更为$GOPATH/pkg，允许同一个package多个版本并存，且多个项目可以共享缓存的 module

我们看下目录：

cd /Users/youdi/go/pkg

├── darwin_amd64
│   ├── github.com
│   ├── go.etcd.io
│   ├── golang
│   ├── golang.org
│   ├── gopkg.in
│   ├── quickstart
│   └── uc.a
├── mod
│   ├── cache
│   ├── github.com
│   ├── golang.org
│   ├── google.golang.org
│   └── gopkg.in
└── sumdb
    └── sum.golang.org

go mod命令

golang 提供了 go mod命令来管理包。

go help mod

Go mod provides access to operations on modules.
Note that support for modules is built into all the go commands,
not just 'go mod'. For example, day-to-day adding, removing, upgrading,
and downgrading of dependencies should be done using 'go get'.
See 'go help modules' for an overview of module functionality.
Usage:
    go mod <command> [arguments]
The commands are:
    download    download modules to local cache
    edit        edit go.mod from tools or scripts
    graph       print module requirement graph
    init        initialize new module in current directory
    tidy        add missing and remove unused modules
    vendor      make vendored copy of dependencies
    verify      verify dependencies have expected content
    why         explain why packages or modules are needed
Use "go help mod <command>" for more information about a command.

go mod 有以下命令：

image.png

命令

说明

download

download modules to local cache(下载依赖包)

edit

edit go.mod from tools or scripts（编辑go.mod)

graph

print module requirement graph (打印模块依赖图)

verify

initialize new module in current directory（在当前目录初始化mod）

tidy

add missing and remove unused modules(拉取缺少的模块，移除不用的模块)

vendor

make vendored copy of dependencies(将依赖复制到vendor下)

verify

verify dependencies have expected content (验证依赖是否正确）

why

explain why packages or modules are needed(解释为什么需要依赖)

比较常用的是 init,tidy, edit

使用go mod管理一个新项目

1. 初始化项目

可以随便找一个目录创建项目，我使用习惯用IDEA进行创建

mkdir Gone
cd Gone
go mod init Gone

查看一下 go.mod文件

module Gone
go 1.14

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

go.mod 提供了module, require、replace和exclude 四个命令

  • module 语句指定包的名字（路径）
  • require 语句指定的依赖项模块
  • replace 语句可以替换依赖项模块
  • exclude 语句可以忽略依赖项模块

2. 添加依赖

创建 main.go文件

package main
import (
    "github.com/gin-gonic/gin"
)
func main() {
    r := gin.Default()
    r.GET("/ping", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "pong",
        })
    })
    r.Run() // listen and serve on 0.0.0.0:8080 (for windows "localhost:8080")
}

执行 go run main.go 运行代码会发现 go mod 会自动查找依赖自动下载

再查看 go.mod

module Gone
go 1.14
require github.com/gin-gonic/gin v1.6.3

go module 安装 package 的原則是先拉最新的 release tag，若无tag则拉最新的commit

go 会自动生成一个 go.sum 文件来记录 dependency tree

01ebd755782e4c909dad0843d3544acf.jpeg

再次执行脚本 go run main.go发现跳过了检查并安装依赖的步骤。

可以使用命令 go list -m -u all 来检查可以升级的package，使用go get -u need-upgrade-package 升级后会将新的依赖版本更新到go.mod * 也可以使用 go get -u 升级所有依赖

去mod包缓存下看看

/Users/youdi/go/pkg/mod/github.com/gin-gonic/gin@v1.6.3

go get升级

  • 运行 go get -u 将会升级到最新的次要版本或者修订版本(x.y.z, z是修订版本号， y是次要版本号)
  • 运行 go get -u=patch 将会升级到最新的修订版本
  • 运行 go get package@version 将会升级到指定的版本号version
  • 运行go get如果有版本的更改，那么go.mod文件也会更改

使用replace替换无法直接获取的package

由于某些已知的原因，并不是所有的package都能成功下载，比如：golang.org下的包。

modules 可以通过在 go.mod 文件中使用 replace 指令替换成github上对应的库，比如：

replace (
    golang.org/x/crypto v0.0.0-20190313024323-a1f597ede03a => github.com/golang/crypto v0.0.0-20190313024323-a1f597ede03a
)

go mod发布和使用

参考Roberto Selbach写的go mod入门文章，文末，我给出链接

Creating a Module

如果你设置好go mod了，那你就可以在任何目录下随便创建

$mkdir gomodone
$cd gomodone

在这个目录下创建一个文件say.go

package gomodone
import "fmt" 
// say Hi to someone
func SayHi(name string) string {
   return fmt.Sprintf("Hi, %s", name)
}

初始化一个 go.mod文件

$ go mod init github.com/jacksonyoudi/gomodone
go: creating new go.mod: module github.com/jacksonyoudi/gomodone

查看 go.mod内容如下：

github.com/jacksonyoudi/gomodone
go 1.14

下面我们要将这个module发布到github上，然后在另外一个程序使用

$git init
$vim .gitiiignore
$git commit -am "init"
// github创建对应的repo
$git remote add origin git@github.com:jacksonyoudi/gomodone.git
$git push -u origin master

执行完，上面我们就相当于发布完了。

如果有人需要使用，就可以使用

go get github.com/jacksonyoudi/gomodone

这个时候没有加tag，所以，没有版本的控制。默认是v0.0.0后面接上时间和commitid。如下：

gomodone@v0.0.0-20200517004046-ee882713fd1e

官方不建议这样做，没有进行版本控制管理。

module versioning

使用tag，进行版本控制

making a release

git tag v1.0.0
git push --tags

操作完，我们的module就发布了一个v1.0.0的版本了。

推荐在这个状态下，再切出一个分支，用于后续v1.0.0的修复推送,不要直接在master分支修复

$git checkout -b v1
$git push -u origin v1

use our module

上面已经发布了一个v1.0.0的版本，我们可以在另一个项目中使用，创建一个go的项目

$mkdir Gone
$cd Gone
$vim main.go
package main
import (
    "fmt"
    "github.com/jacksonyoudi/gomodone"
)
func main() {
    fmt.Println(gomodone.SayHi("Roberto"))
}

代码写好了，我们生成 go mod文件

go mod init Gone

上面命令执行完，会生成 go mod文件

看下mod文件：

module Gone
go 1.14
require (
    github.com/jacksonyoudi/gomodone v1.0.0
)
$go mod tidy
go: finding module for package github.com/jacksonyoudi/gomodone
go: found github.com/jacksonyoudi/gomodone in github.com/jacksonyoudi/gomodone v1.0.0

同时还生成了go.sum, 其中包含软件包的哈希值，以确保我们具有正确的版本和文件。

github.com/jacksonyoudi/gomodone v1.0.1 h1:jFd+qZlAB0R3zqrC9kwO8IgPrAdayMUS0rSHMDc/uG8=
github.com/jacksonyoudi/gomodone v1.0.1/go.mod h1:XWi+BLbuiuC2YM8Qz4yQzTSPtHt3T3hrlNN2pNlyA94=
github.com/jacksonyoudi/gomodone/v2 v2.0.0 h1:GpzGeXCx/Xv2ueiZJ8hEhFwLu7xjxLBjkOYSmg8Ya/w=
github.com/jacksonyoudi/gomodone/v2 v2.0.0/go.mod h1:L8uFPSZNHoAhpaePWUfKmGinjufYdw9c2i70xtBorSw=

这个内容是下面的，需要操作执行的结果

go run main.go就可以运行了

Making a bugfix release

假如fix一个bug,我们在v1版本上进行修复

修改代码如下：

// say Hi to someone
func SayHi(name string) string {
-       return fmt.Sprintf("Hi, %s", name)
+       return fmt.Sprintf("Hi, %s!", name)
}

修复好，我们开始push

$ git commit -m "Emphasize our friendliness" say.go
$ git tag v1.0.1
$ git push --tags origin v1

Updating modules

刚才fix bug，所以要在我们使用项目中更新

这个需要我们手动执行更新module操作

我们通过使用我们的好朋友来做到这一点go get：

  • 运行 go get -u 以使用最新的 minor 版本或修补程序版本（即它将从1.0.0更新到例如1.0.1，或者，如果可用，则更新为1.1.0）
  • 运行 go get -u=patch 以使用最新的 修补程序 版本（即，将更新为1.0.1但不更新 为1.1.0）
  • 运行go get package@version 以更新到特定版本（例如github.com/jacksonyoud…）

目前module最新的也是v1.0.1

// 更新最新
$go get -u
$go get -u=patch
//指定包，指定版本
$go get github.com/jacksonyoudi/gomodone@v1.0.1

操作完，go.mod文件会修改如下:

module Gone
go 1.14
require (
    github.com/jacksonyoudi/gomodone v1.0.1
)

Major versions

根据语义版本语义，主要版本与次要版本 不同。主要版本可能会破坏向后兼容性。从Go模块的角度来看，主要版本是 完全不同的软件包。乍一看这听起来很奇怪，但这是有道理的：两个不兼容的库版本是两个不同的库。

比如下面修改，完全破坏了兼容性。

package gomodone
import (
    "errors"
    "fmt"
)
// Hi returns a friendly greeting
// Hi returns a friendly greeting in language lang
func SayHi(name, lang string) (string, error) {
    switch lang {
    case "en":
        return fmt.Sprintf("Hi, %s!", name), nil
    case "pt":
        return fmt.Sprintf("Oi, %s!", name), nil
    case "es":
        return fmt.Sprintf("¡Hola, %s!", name), nil
    case "fr":
        return fmt.Sprintf("Bonjour, %s!", name), nil
    default:
        return "", errors.New("unknown language")
    }
}

如上，我们需要不同的大版本，这种情况下

修改 go.mod如下

module github.com/jacksonyoudi/gomodone/v2
go 1.14

然后，重新tag，push

$ git commit say.go -m "Change Hi to allow multilang"
$ git checkout -b v2 # 用于v2版本，后续修复v2
$ git commit go.mod -m "Bump version to v2"
$ git tag v2.0.0
$ git push --tags origin v2

Updating to a major version

即使发布了库的新不兼容版本，现有软件 也不会中断，因为它将继续使用现有版本1.0.1。go get -u 将不会获得版本2.0.0。

如果想使用v2.0.0,代码改成如下：

package main
import (
    "fmt"
    "github.com/jacksonyoudi/gomodone/v2"
)
func main() {
    g, err := gomodone.SayHi("Roberto", "pt")
    if err != nil {
        panic(err)
    }
    fmt.Println(g)
}

执行 go mod tidy

go: finding module for package github.com/jacksonyoudi/gomodone/v2
go: downloading github.com/jacksonyoudi/gomodone/v2 v2.0.0
go: found github.com/jacksonyoudi/gomodone/v2 in github.com/jacksonyoudi/gomodone/v2 v2.0.0

当然，两个版本都可以同时使用, 使用别名

如下：

package main
import (
    "fmt"
    "github.com/jacksonyoudi/gomodone"
    mv2 "github.com/jacksonyoudi/gomodone/v2"
)
func main() {
    g, err := mv2.SayHi("Roberto", "pt")
    if err != nil {
        panic(err)
    }
    fmt.Println(g)
    fmt.Println(gomodone.SayHi("Roberto"))
}

执行一下 go mod tidy

Vendoring

默认是忽略vendor的，如果想在项目目录下有vendor可以执行下面命令

$go vendor

当然，如果构建程序的时候，希望使用vendor中的依赖，

$ go build -mod vendor

IDEA下Golang开发GO

  1. 创建go项目

01ebd755782e4c909dad0843d3544acf.jpeg

  1. 创建完项目，会自动生成go mod文件
    如果需要修改，可以手动修改，加入git等操作
  2. 写业务逻辑代码

01ebd755782e4c909dad0843d3544acf.jpeg

  1. 解决依赖，更新go.mod

01ebd755782e4c909dad0843d3544acf.jpeg

  1. go build


文章标签：
Java
Go
开发工具
git
Maven
缓存
关键词：
Go包
Go mod
Go管理工具
owenzhang
目录
相关文章
张飞的猪
|
11天前
|
Linux Go iOS开发
怎么禁用 vscode 中点击 go 包名时自动打开浏览器跳转到 pkg.go.dev
本文介绍了如何在 VSCode 中禁用点击 Go 包名时自动打开浏览器跳转到 pkg.go.dev 的功能。通过将 gopls 的 `ui.navigation.importShortcut` 设置为 &quot;Definition&quot;，可以实现仅跳转到定义处而不打开链接。具体操作步骤包括：打开设置、搜索 gopls、编辑 settings.json 文件并保存更改，最后重启 VSCode 使设置生效。
张飞的猪
36 7
怎么禁用 vscode 中点击 go 包名时自动打开浏览器跳转到 pkg.go.dev
听风de歌
|
25天前
|
Go 索引
go语言使用strings包
go语言使用strings包
听风de歌
23 3
听风de歌
|
1月前
|
编译器 Go 开发者
go语言中导入相关包
【11月更文挑战第1天】
听风de歌
32 3
小王老师呀
|
2月前
|
存储 Go 数据库
Go语言Context包源码学习
【10月更文挑战第21天】Go 语言中的 `context` 包用于在函数调用链中传递请求上下文信息，支持请求的取消、超时和截止时间管理。其核心接口 `Context` 定义了 `Deadline`、`Done`、`Err` 和 `Value` 方法，分别用于处理截止时间、取消信号、错误信息和键值对数据。包内提供了 `emptyCtx`、`cancelCtx`、`timerCtx` 和 `valueCtx` 四种实现类型，满足不同场景需求。示例代码展示了如何使用带有超时功能的上下文进行任务管理和取消。
小王老师呀
22 0
尹正杰
|
3月前
|
存储 Go
Golang语言基于go module方式管理包(package)
这篇文章详细介绍了Golang语言中基于go module方式管理包(package)的方法，包括Go Modules的发展历史、go module的介绍、常用命令和操作步骤，并通过代码示例展示了如何初始化项目、引入第三方包、组织代码结构以及运行测试。
尹正杰
69 3
白如意i
|
4月前
|
人工智能 IDE Go
go mod 依赖管理
go mod 依赖管理
白如意i
42 1
爱发白日梦的后端
|
4月前
|
编译器 数据库连接 Go
Go Sync 包：并发的 6 个关键概念
Go Sync 包：并发的 6 个关键概念
爱发白日梦的后端
116 6
左诗右码
|
4月前
|
存储 SQL Go
一文弄懂Go语言的Context包，值得收藏！
在开发高效的Go应用程序时，处理超时、取消操作和传递请求范围的数据至关重要。Go标准库中的`context`包提供了一套强大的工具，用于在不同层级间传递取消信号、超时和截止时间等信息。本文首先概述了`context`包的核心功能，接着详细介绍了关键方法，如`WithCancel`、`WithDeadline`、`WithTimeout`和`WithValue`的使用场景。通过创建和派生上下文，开发者能更好地管理请求的生命周期，控制长时间运行的操作，并在并发环境中传递必要的数据。
左诗右码
57 1
wljslmz
|
4月前
|
Go 开发者
什么是 Golang 包？详解 Go 语言的包系统
【8月更文挑战第31天】
wljslmz
69 0
wljslmz
|
4月前
|
编译器 Go 开发者
Go 程序中的包：定义、作用与应用指南
【8月更文挑战第31天】
wljslmz
96 0