平常开发离不开第三方库,大部分的时候,这些库都是知足咱们的须要,但有的时候,咱们须要 fork 一份,作一些修改。go mod 做为当前 go 语言的官方包管理器,天然也考虑到了这种状况。在 go.mod 文件中,经过 replace 指令,将旧的库地址,替换为新的库地址来实现这一操做。git
下面经过一个示例来说解 go replace 的使用,以及常见问题的处理。github
咱们首先新建一个项目,并在其中引用 ozgio/strutil: String utilities for Go (github.com) 这个字符串处理库,而后随便写段代码,确保其能够正常工做:code
package main import ( "fmt" "github.com/ozgio/strutil" ) func main() { fmt.Println(strutil.Align("lorem ipsum", strutil.Right, 20)) }
go mod init project_name
ip
go mod init 命令执行后,会自动生成 go.mod
文件,该文件中,列出了项目所依赖的第三方包,以及所使用的版本。开发
而后执行 go mod tidy
,该命令作两件事:rem
而后执行 go run main.go
,来执行项目。字符串
如今,项目应该已经能够正常执行,并返回执行结果了。get
假设咱们此时想调用一个过滤字符串中,HTML 标签的方法,但翻了一下并无,因而 fork 了一份这个库,咱们本身添加了进去:字符串处理
https://github.com/shiweifu/strutil/blob/master/escape.go
下面咱们来看如何调用这个新的方法。hash
第一种方式:
这种方式至关于引用了一个新的库,与以前那个库已经没有什么关系了。大多数时候,由于对代码修改过多,咱们并不会想要这么用。go mod 固然也考虑到了这一点,go mod 提供了 go mod replace 方法来应对这种场景。
第二种方式:
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
语句给删除掉,这种方式没有破坏原有的代码。