Go mod replace 使用

平常開發離不開第三方庫，大部分的時候，這些庫都是知足咱們的須要，但有的時候，咱們須要 fork 一份，作一些修改。go mod 做爲當前 go 語言的官方包管理器，天然也考慮到了這種狀況。在 go.mod 文件中，經過 replace 指令，將舊的庫地址，替換爲新的庫地址來實現這一操做。

下面經過一個示例來說解 go replace 的使用，以及常見問題的處理。

咱們首先新建一個項目，並在其中引用 ozgio/strutil: String utilities for Go (github.com) 這個字符串處理庫，而後隨便寫段代碼，確保其能夠正常工做：

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 命令執行後，會自動生成 go.mod 文件，該文件中，列出了項目所依賴的第三方包，以及所使用的版本。

而後執行 go mod tidy，該命令作兩件事：

1. 解析項目文件，並找到所使用的包
2. 生成 go.sum 文件，其中保存了所使用包的版本

而後執行 go run main.go，來執行項目。

如今，項目應該已經能夠正常執行，並返回執行結果了。

假設咱們此時想調用一個過濾字符串中，HTML 標籤的方法，但翻了一下並無，因而 fork 了一份這個庫，咱們本身添加了進去：

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

下面咱們來看如何調用這個新的方法。

第一種方式：

1. fork strutil 庫，打開 go.mod 文件，將第一行中的 module name 修改成一個新的 name
2. 增長所須要的方法
3. 增長新的 git tag
4. 在你當前項目中，引用你修改後的這個 repo，替換地址以及版本號

這種方式至關於引用了一個新的庫，與以前那個庫已經沒有什麼關係了。大多數時候，由於對代碼修改過多，咱們並不會想要這麼用。go mod 固然也考慮到了這一點，go mod 提供了 go mod replace 方法來應對這種場景。

第二種方式：

1. fork strutil 庫
2. 增長所須要的方法
3. 在當前項目中，執行 go mod edit -replace 命令：

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

執行完命令後，咱們打開 go.mod 文件，發現最下面多了一條指令：

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

go mod replace 指令支持指定版本號，能夠爲 git tag，也能夠爲 git commit 日期 + git commit hash 的組合。

能夠經過如下指令，來獲取某個分支的最新版本：

go get github.com/shiweifu/strutil@master

此時會輸出 master 分支的最新 commit 記錄：

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

把這段版本號複製到 go.mod 文件replace 指令，將對應的版本號替換成這個，而後再次執行，就能夠使用咱們本身 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 這個庫，而 EscapeHTMLTag 是咱們新添加的方法，這種方式只是對 go.mod 進行了修改，而後咱們能夠對 ozgio/strutil 提一個 pr，若是咱們的代碼被合併進倉庫，咱們能夠把 replace 語句給刪除掉，這種方式沒有破壞原有的代碼。