go mod使用
Posted
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了go mod使用相关的知识,希望对你有一定的参考价值。
参考技术A目前,golang的包管理工具有很多,用的比较多的包括:govendor、godep、glide等等。但是,一直以来,golang官方都没有提供一个标准的包管理工具,知道go1.11发布后,出现了一个实验中的go module。
a、全局启用
b、当前shell窗口启用
c、常用代理地址
3.1 初始化
4.1 查看所有依赖包
4.2 查看包有哪些版本
4.3 如何更换版本
4.4 使用go mod edit直接修改
4.5 删除未使用的依赖项
4.6 查看所有命令
Go 1.11版本支持临时环境变量GO111MODULE,通过该环境变量来控制依赖包的管理方式。当GO111MODULE的值为on时,那么就会使用modules功能,这种模式下,
当GO111MODULE的值为off时,不再使用modules功能。此时软件包的使用顺序为:
优先使用vendor目录下面的包,如果vendor下面没有搜索到,再搜索
要么完整使用vendor下面的包,要么完整使用$GOPATH下面的包,不会混合使用。
当使用go mod vendor指令,将依赖包全部拷贝至当前项目下后,当前项目就可以随意拷贝分发,避免因网络问题造成接收者安装依赖包的麻烦。
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
,该命令做两件事:
- 解析项目文件,并找到所使用的包
- 生成 go.sum 文件,其中保存了所使用包的版本
然后执行 go run main.go
,来执行项目。
现在,项目应该已经可以正常执行,并返回执行结果了。
假设我们此时想调用一个过滤字符串中,HTML 标签的方法,但翻了一下并没有,于是 fork 了一份这个库,我们自己添加了进去:
https://github.com/shiweifu/strutil/blob/master/escape.go
下面我们来看如何调用这个新的方法。
第一种方式:
- fork strutil 库,打开 go.mod 文件,将第一行中的 module name 修改为一个新的 name
- 增加所需要的方法
- 增加新的 git tag
- 在你当前项目中,引用你修改后的这个 repo,替换地址以及版本号
这种方式相当于引用了一个新的库,与之前那个库已经没有什么关系了。大多数时候,因为对代码修改过多,我们并不会想要这么用。go mod 当然也考虑到了这一点,go mod 提供了 go mod replace 方法来应对这种场景。
第二种方式:
- fork strutil 库
- 增加所需要的方法
- 在当前项目中,执行
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
语句给删除掉,这种方式没有破坏原有的代码。
以上是关于go mod使用的主要内容,如果未能解决你的问题,请参考以下文章