Go?mod?replace使用方法及常見(jiàn)問(wèn)題分析

更新時(shí)間：2023年08月04日 10:25:08 作者：shiweifu

這篇文章主要為大家介紹了Go?mod?replace使用方法及常見(jiàn)問(wèn)題分析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪

引言

日常開(kāi)發(fā)離不開(kāi)第三方庫(kù)，大部分的時(shí)候，這些庫(kù)都是滿(mǎn)足我們的需要，但有的時(shí)候，我們需要 fork 一份，做一些修改。

go mod 作為當(dāng)前 go 語(yǔ)言的官方包管理器，自然也考慮到了這種情況。

在 go.mod 文件中，通過(guò) replace 指令，將舊的庫(kù)地址，替換為新的庫(kù)地址來(lái)實(shí)現(xiàn)這一操作。

go replace 的使用

下面通過(guò)一個(gè)示例來(lái)講解 go replace 的使用，以及常見(jiàn)問(wèn)題的處理。

我們首先新建一個(gè)項(xiàng)目，并在其中引用 ozgio/strutil: String utilities for Go (github.com) 這個(gè)字符串處理庫(kù)，然后隨便寫(xiě)段代碼，確保其可以正常工作：

package main
import (
    "fmt"
    "github.com/ozgio/strutil"
)
func main() {
    fmt.Println(strutil.Align("lorem ipsum", strutil.Right, 20))
}

go mod 的初始化

go mod init project_name

go mod init 命令執(zhí)行后，會(huì)自動(dòng)生成 go.mod 文件，該文件中，列出了項(xiàng)目所依賴(lài)的第三方包，以及所使用的版本。

然后執(zhí)行 go mod tidy，該命令做兩件事：

解析項(xiàng)目文件，并找到所使用的包
生成 go.sum 文件，其中保存了所使用包的版本

然后執(zhí)行 go run main.go，來(lái)執(zhí)行項(xiàng)目。

現(xiàn)在，項(xiàng)目應(yīng)該已經(jīng)可以正常執(zhí)行，并返回執(zhí)行結(jié)果了。

假設(shè)我們此時(shí)想調(diào)用一個(gè)過(guò)濾字符串中，HTML 標(biāo)簽的方法，但翻了一下并沒(méi)有，于是 fork 了一份這個(gè)庫(kù)，我們自己添加了進(jìn)去：

https://github.com/shiweifu/strutil/blob/master/escape.go

調(diào)用新的方法

下面我們來(lái)看如何調(diào)用這個(gè)新的方法。

第一種方式：

fork strutil 庫(kù)，打開(kāi) go.mod 文件，將第一行中的 module name 修改為一個(gè)新的 name
增加所需要的方法
增加新的 git tag
在你當(dāng)前項(xiàng)目中，引用你修改后的這個(gè) repo，替換地址以及版本號(hào)

這種方式相當(dāng)于引用了一個(gè)新的庫(kù)，與之前那個(gè)庫(kù)已經(jīng)沒(méi)有什么關(guān)系了。大多數(shù)時(shí)候，因?yàn)閷?duì)代碼修改過(guò)多，我們并不會(huì)想要這么用。go mod 當(dāng)然也考慮到了這一點(diǎn)，go mod 提供了 go mod replace 方法來(lái)應(yīng)對(duì)這種場(chǎng)景。

第二種方式：

fork strutil 庫(kù)
增加所需要的方法
在當(dāng)前項(xiàng)目中，執(zhí)行 go mod edit -replace 命令：

go mod edit -replace [old git package]@[version]=[new git package]@[version]

執(zhí)行完命令后，我們打開(kāi) go.mod 文件，發(fā)現(xiàn)最下面多了一條指令：

replace github.com/ozgio/strutil v0.3.0 => github.com/shiweifu/strutil v0.3.0

go mod replace 指令支持指定版本號(hào)，可以為 git tag，也可以為 git commit 日期 + git commit hash 的組合。

可以通過(guò)以下指令，來(lái)獲取某個(gè)分支的最新版本：

go get github.com/shiweifu/strutil@master

此時(shí)會(huì)輸出 master 分支的最新 commit 記錄：

github.com/shiweifu/strutil@v0.3.1-0.20210615145512-3bd39e22cb0d

把這段版本號(hào)復(fù)制到 go.mod 文件replace 指令，將對(duì)應(yīng)的版本號(hào)替換成這個(gè)，然后再次執(zhí)行，就可以使用我們自己 fork 的 strutil 了：

package main
import (
    "fmt"
    "github.com/ozgio/strutil"
)
func main() {
    out := strutil.EscapeHTMLTag("<script>abc</script>")
    fmt.Println(out)
}

我們引用的還是 github.com/ozgio/strutil 這個(gè)庫(kù)，而 EscapeHTMLTag 是我們新添加的方法，這種方式只是對(duì) go.mod 進(jìn)行了修改，然后我們可以對(duì) ozgio/strutil 提一個(gè) pr，如果我們的代碼被合并進(jìn)倉(cāng)庫(kù)，我們可以把 replace 語(yǔ)句給刪除掉，這種方式?jīng)]有破壞原有的代碼。

以上就是Go mod replace使用方法示例的詳細(xì)內(nèi)容，更多關(guān)于Go mod replace的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: