腳本之家服務器常用軟件

快捷導航

Go Module依賴管理的實現(xiàn)

更新時間：2024年06月27日 11:49:50 作者：2021dragon

Go Module是Go語言的官方依賴管理解決方案,其提供了一種簡單、可靠的方式來管理項目的依賴關(guān)系,本文主要介紹了Go Module依賴管理的實現(xiàn),感興趣的可以了解一下

基本介紹

Go Module是Go語言的官方依賴管理解決方案，其提供了一種簡單、可靠的方式來管理項目的依賴關(guān)系。Go Module于Go1.11發(fā)布，并于Go1.14準備正式用于生產(chǎn)，Go官方也鼓勵用戶從其他的依賴管理工具遷移到Go Module。

Go Module主要解決了如下幾個問題：

依賴管理：在引入Go Module之前，Go語言沒有官方的依賴管理系統(tǒng)，開發(fā)人員需要手動下載和管理項目的依賴包。Go Module中提供了一種標準化的依賴管理解決方案，使開發(fā)人員能夠輕松定義、下載和更新項目的依賴項。
版本沖突：在原始的GOPATH模式中，多個項目共享同一個全局的依賴包集合，往往會導致版本沖突。Go Module中引入了模塊版本的概念，每個模塊都有明確的版本號，并通過go.mod文件中的版本要求來解決版本沖突問題。
可重復構(gòu)建：在GOPATH模式中，項目的構(gòu)建結(jié)果受到GOPATH環(huán)境變量的影響，同一項目在不同環(huán)境下可能產(chǎn)生不一致的構(gòu)建結(jié)果。Go Module中使用go.mod文件明確指定項目的依賴關(guān)系和版本要求，確保在不同環(huán)境下構(gòu)建結(jié)果的一致性和可重復性。
跨模塊引用：在GOPATH模式中，無法直接引用其他項目中的代碼，必須將代碼復制到自己的項目中，或使用第三方工具來管理跨項目的共享代碼。Go Module中允許直接引用其他模塊中的代碼，簡化了代碼的復用和共享，提高了開發(fā)效率。
私有庫支持：在GOPATH機制中，私有庫的使用相對復雜，需要設置特殊的目錄結(jié)構(gòu)或使用第三方工具。Go Module中提供了對私有庫的官方支持，開發(fā)人員可以使用私有代碼塊，并通過身份驗證或代理來管理私有模塊的訪問權(quán)限。

Go Module的使用

初始化項目（go mod init）

初始化項目

go mod init命令用于初始化一個新的Go模塊，該命令會在當前目錄下創(chuàng)建一個名為go.mod的文件。如下：

在這里插入圖片描述

生成的go.mod文件如下：

module github.com/chenlong-cxy/go-module-test

go 1.20

鑒于當前go.mod文件的內(nèi)容過于簡單，為了進一步講解go.mod文件的內(nèi)容，下面給出一個較為復雜的go.mod文件示例。如下：

module module-path

go 1.20

require (
	github.com/zhagnsan/test1 v1.1.3
	github.com/zhagnsan/test2 v1.2.3
	github.com/zhagnsan/test3 v1.2.4 // indirect
)

replace github.com/zhangsan/test1 v1.1.3 => github.com/lisi/test1 v1.3.4
replace github.com/zhangsan/test2 v1.2.3 => github.com/lisi/test2 v1.3.4

exclude (
	github.com/zhangsan/test1 v1.1.1
	github.com/lisi/test2 v1.2.3
)

go.mod文件大致包括如下幾個部分：

module：表示模塊聲明，用于定義當前項目的模塊路徑。
go：表示Go版本要求，用于標識當前模塊的Go語言版本，值為初始化模塊時的Go版本。
require：表示依賴項聲明，用于指明當前模塊所依賴的其他模塊，每個依賴項由模塊路徑和模塊版本組成，indirect表示間接依賴。
replace：表示依賴項替換，用于指明所依賴的某個模塊的替代模塊。
exclude：表示依賴排除，用于指明需要被排除的特定模塊及其版本，以阻止某些模塊被下載或用作依賴項。

說明一下：

使用go mod init命令時，需要在命令后指明待初始化模塊的模塊路徑，所指明的模塊路徑將被設置為go.mod文件中的模塊聲明。模塊路徑通常是項目的版本控制倉庫的地址，這樣當其他開發(fā)人員使用該模塊時，Go Module就能直接從該模塊的導入路徑對應的源代碼倉庫下載該模塊。如果項目只是用于本地測試，也可以將模塊路徑簡單的設置為項目名稱。

管理依賴項（go mod edit）

管理依賴項

go mod edit命令用于編輯go.mod文件的內(nèi)容。常用的選項如下：

-require：用于添加或更新當前模塊所依賴的某個模塊，即在go.mod文件中添加或更新require條目。
-replace：用于指明當前模塊所依賴的某個模塊的替代模塊，即在go.mod文件中添加replace條目。
-exclude：用于指明需要被排除的特定模塊及其版本，即在go.mod文件中添加exclude條目。
-droprequire：用于刪除當前模塊所依賴的某個模塊，即在go.mod文件中刪除require條目。

為了演示Go Module的使用，我們在項目目錄下分別創(chuàng)建main文件夾和model文件夾，main文件夾中包含一個main.go文件，model文件夾中包含一個student.go文件。如下：

在這里插入圖片描述

其中，student.go文件中定義了一個Student結(jié)構(gòu)體，并對外提供了一個函數(shù)用于創(chuàng)建Student實例。如下：

package model

type Student struct {
	Name string
	Age  int
}

func NewStudent(name string, age int) Student {
	return Student{
		Name: name,
		Age:  age,
	}
}

main.go中創(chuàng)建了一個Student實例，并通過logrus模塊中的Infof函數(shù)對其進行了打印。如下：

package main

import (
	"github.com/chenlong-cxy/go-module-test/model"
	"github.com/sirupsen/logrus"
)

func main() {
	stu := model.NewStudent("Alice", 14)
	logrus.Infof("student info is %+v", stu)
}

由于項目當中用到了logrus模塊，因此需要通過go mod edit命令在go.mod文件中添加logrus模塊的依賴聲明。如下：

在這里插入圖片描述

執(zhí)行命令后可以看到，go.mod文件中新增了對應的require條目。如下：

module github.com/chenlong-cxy/go-module-test

go 1.20

require github.com/sirupsen/logrus v1.9.3

說明一下：

logrus是一個流行的Go語言日志庫，其提供了豐富的日志記錄功能和靈活的配置選項，被廣泛應用于Go語言項目中。
在Go Module模式下，通過import "模塊路徑/包相對于模塊的路徑"的方式導入對應的包，導入當前項目中的包也是如此。

獲取依賴項（go mod download）

獲取依賴項

go mod download命令用于下載項目所依賴的各個模塊，其會根據(jù)go.mod文件下載相應的模塊到Go Module緩存中。如下：

在這里插入圖片描述

執(zhí)行g(shù)o mod download命令后，會在當前目錄下生成一個名為go.sum的文件，該文件用于記錄當前模塊所依賴的各個模塊的校驗和信息。當前go.sum文件內(nèi)容如下：

github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

與此同時，在Go Module緩存路徑下可以看到被下載的模塊。如下：

在這里插入圖片描述

說明一下：

在Go Module模式中，原則上不必再設置GOPATH環(huán)境變量，這時$HOME/go/pkg/mod將會作為Go Module的緩存路徑，用于存放Go Module下載的模塊，但如果你設置了GOPATH環(huán)境變量，那么$GOPATH/pkg/mod將優(yōu)先作為Go Module的緩存路徑。
在使用go mod download命令時，也可以在后面指明需要下載的模塊及其版本，這時Go Module會下載相應的模塊到Go Module緩存中，以供后續(xù)構(gòu)建使用。
當使用Go Module下載項目依賴的模塊時，每個下載的模塊都會有一個相應的校驗和，go.sum文件記錄了這些校驗和以及每個模塊的版本信息，用于驗證模塊文件在下載和使用過程中是否被篡改或損壞。

整理依賴項（go mod tidy）

整理依賴項

go mod tidy命令用于自動管理項目的依賴項，該命令會檢測當前項目缺失的依賴項、不再使用的依賴項以及依賴項的版本是否需要更新，并自動對所需的依賴項進行下載，然后更新go.mod和go.sum文件。如下：

在這里插入圖片描述

例如，在當前項目執(zhí)行g(shù)o mod tidy命令后，其檢測到項目中有一個間接依賴的模塊未被添加，于是會自動下載缺失的依賴項，并將其添加到go.mod文件中。如下：

module github.com/chenlong-cxy/go-module-test

go 1.20

require github.com/sirupsen/logrus v1.9.3

require golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect

至此當前的項目已經(jīng)可以運行了，運行程序后可以看到通過logrus模塊輸出的Student信息。如下：

在這里插入圖片描述

導入vendor目錄（go mod vendor）

導入vendor目錄

go mod vendor命令用于將項目依賴的各個模塊，復制到項目的vendor目錄中。如下：

在這里插入圖片描述

執(zhí)行g(shù)o mod vendor命令后，在項目目錄下會生成一個vendor目錄，該目錄下包含了當前項目依賴的各個模塊的代碼。如下：

在這里插入圖片描述

說明一下：

在構(gòu)建和部署項目時，如果項目中存在vendor目錄，那么Go會直接使用vendor目錄中的依賴項，如果vendor目錄中沒有對應的依賴項則會產(chǎn)生報錯，因此需要確保vendor目錄下包含當前項目的所有依賴項。
vendor目錄只包含各個依賴模塊的源代碼，各個模塊的測試文件不會被復制到vendor目錄下。此外，修改vendor目錄下各個模塊的源代碼，不會影響到Go Module緩存中對應模塊的源代碼。

查詢依賴原因（go mod why）

查詢依賴原因

go mod why命令用于解析模塊依賴關(guān)系，并解釋為什么某個模塊被包含在項目的依賴項中。如下：

在這里插入圖片描述

查詢依賴結(jié)構(gòu)（go mod graph）

查詢依賴結(jié)構(gòu)

go mod graph命令用于生成當前模塊的依賴關(guān)系圖，以展示項目中各個模塊之間的依賴關(guān)系。如下：

在這里插入圖片描述

驗證依賴項完整性（go mod verify）

驗證依賴完整性

go mod verify命令用于驗證當前模塊的依賴項的完整性和一致性，它會檢查Go Module緩存中當前項目所依賴的各個模塊的校驗和，與go.sum文件中記錄的校驗和是否一致，以確保所依賴的模塊未被篡改或損壞。如下：

在這里插入圖片描述

說明一下：

如果go mod verify命令輸出錯誤信息，表明Go Module緩存中對應模塊的代碼與最初下載的代碼不一致，該模塊的代碼可能被篡改或損壞，此時應該重新下載該模塊的代碼。

go get命令

go get命令用于下載指定的模塊，并將其存放到Go Module緩存中。常用的選項如下：

-u：表示獲取并更新指定模塊及其依賴項的最新版本。
-t：表示獲取指定模塊及其相關(guān)的測試依賴項。
-d：表示僅獲取指定模塊的源代碼，而不進行安裝。
-insecure：表示允許在不驗證HTTPS證書的情況下獲取指定模塊。

例如，下面演示了如何通過go get命令獲取logrus模塊。如下：

在這里插入圖片描述

說明一下：

在使用go get命令下載指定模塊時，如果沒有指明模塊的版本，則默認獲取該模塊的最新版本。
go get在獲取模塊時，如果被獲取的模塊中包含bin目錄，那么go get會將bin目錄中的可執(zhí)行文件安裝到Go Module緩存中的bin目錄下，如果只希望下載模塊的源代碼而不進行安裝，則需要攜帶-d選項。

go get與go mod download

go get和go mod download命令都用于下載模塊，但它們之間存在一些區(qū)別。主要區(qū)別如下：

go get在下載指定模塊時，會自動下載該模塊所依賴的其他模塊，而go mod download在下載指定模塊時，只會下載指定的模塊，不會下載該模塊所依賴的其他模塊。
go get在下載指定模塊的源代碼后，還會進行安裝操作，而go mod download只會下載指定模塊的源代碼，不會進行安裝操作。
go get在下載指定模塊后，會將該模塊作為依賴添加到go.mod文件中，并將該模塊對應的檢驗和信息添加到go.sum文件中，而go mod download不會對go.mod和go.sum文件進行更新。
go get在下載指定模塊時，如果沒有指明模塊的版本，會默認獲取該模塊的最新版本，而go mod download在下載指定模塊時必須指明待下載的版本。