在使用 Go module 过程中,随着引入的依赖增多,也许你会发现go.mod文件中部分依赖包后面会出现一个// indirect的标识。这个标识总是出现在require指令中,其中// 与代码的行注释一样表示注释的开始,indirect表示间接的依赖。
在执行命令go mod tidy时,Go module 会自动整理go.mod 文件,如果有必要会在部分依赖包的后面增加// indirect注释。一般而言,被添加注释的包肯定是间接依赖的包,而没有添加// indirect注释的包则是直接依赖的包,即明确的出现在某个import语句中。
然而,这里需要着重强调的是:并不是所有的间接依赖都会出现在 go.mod文件中。
间接依赖出现在go.mod文件的情况,可能符合下面所列场景的一种或多种:
直接依赖未启用 Go module
直接依赖go.mod 文件中缺失部分依赖
直接依赖未启用 Go module
如下图所示,Module A 依赖 B,但是 B 还未切换成 Module,也即没有go.mod文件,此时,当使用go mod tidy命令更新A的go.mod文件时,B的两个依赖B1和B2将会被添加到A的go.mod文件中(前提是A之前没有依赖B1和B2),并且B1 和B2还会被添加// indirect的注释。
此时Module A的go.mod文件中require部分将会变成:
require (
B vx.x.x
B1 vx.x.x // indirect
B2 vx.x.x // indirect
)
依赖B及B的依赖B1和B2都会出现在go.mod文件中。
直接依赖 go.mod 文件不完整
如上面所述,如果依赖B没有go.mod文件,则Module A 将会把B的所有依赖记录到A 的go.mod文件中。即便B拥有go.mod,如果go.mod文件不完整的话,Module A依然会记录部分B的依赖到go.mod文件中。
如下图所示,Module B虽然提供了go.mod文件中,但go.mod文件中只添加了依赖B1,那么此时A在引用B时,则会在A的go.mod文件中添加B2作为间接依赖,B1则不会出现在A的go.mod文件中。
此时Module A的go.mod文件中require部分将会变成:
require (
B vx.x.x
B2 vx.x.x // indirect
)
由于B1已经包含进B的go.mod文件中,A的go.mod文件则不必再记录,只会记录缺失的B2。
总结
为什么要记录间接依赖
在上面的例子中,如果某个依赖B 没有go.mod文件,在A 的go.mod文件中已经记录了依赖B及其版本号,为什么还要增加间接依赖呢?
我们知道Go module需要精确地记录软件的依赖情况,虽然此处记录了依赖B的版本号,但B的依赖情况没有记录下来,所以如果B的go.mod文件缺失了(或没有)这个信息,则需要在A的go.mod文件中记录下来。此时间接依赖的版本号将会跟据Go module的版本选择机制确定一个最优版本。
如何处理间接依赖
综上所述间接依赖出现在go.mod中,可以一定程度上说明依赖有瑕疵,要么是其不支持Go module,要么是其go.mod文件不完整。
由于Go 语言从v1.11版本才推出module的特性,众多开源软件迁移到go module还需要一段时间,在过渡期必然会出现间接依赖,但随着时间的推进,在go.mod中出现// indirect的机率会越来越低。
出现间接依赖可能意味着你在使用过时的软件,如果有精力的话还是推荐尽快消除间接依赖。可以通过使用依赖的新版本或者替换依赖的方式消除间接依赖。
如何查找间接依赖来源
Go module提供了go mod why 命令来解释为什么会依赖某个软件包,若要查看go.mod中某个间接依赖是被哪个依赖引入的,可以使用命令go mod why -m 来查看。
比如,我们有如下的go.mod文件片断:
require (
github.com/Rican7/retry v0.1.0 // indirect
github.com/google/uuid v1.0.0
github.com/renhongcai/indirect v1.0.0
github.com/spf13/pflag v1.0.5 // indirect
golang.org/x/text v0.3.2
)
```go
-> % go mod why -m all
# grpc/test
grpc/test
# cloud.google.com/go
(main module does not need module cloud.google.com/go)
# github.com/BurntSushi/toml
(main module does not need module github.com/BurntSushi/toml)
# github.com/Shopify/sarama
(main module does not need module github.com/Shopify/sarama)
# github.com/Shopify/toxiproxy
(main module does not need module github.com/Shopify/toxiproxy)
# github.com/census-instrumentation/opencensus-proto
(main module does not need module github.com/census-instrumentation/opencensus-proto)
# github.com/client9/misspell
(main module does not need module github.com/client9/misspell)
# github.com/cncf/udpa/go
(main module does not need module github.com/cncf/udpa/go)
# github.com/davecgh/go-spew
grpc/test/src/client/zipkin_simple_client
我们希望确定间接依赖github.com/Rican7/retry v0.1.0 // indirect是被哪个依赖引入的,则可以使用命令go mod why来查看:
-> % go mod why -m github.com/openzipkin/zipkin-go
# github.com/openzipkin/zipkin-go
grpc/test/src/client/zipkin_simple_client
github.com/openzipkin/zipkin-go
上面的打印信息中# github.com/openzipkin/zipkin-go 表示当前正在分析的依赖,后面几行则表示依赖链。grpc/test/src/client/zipkin_simple_client 依赖github.com/openzipkin/zipkin-go,以此类推。由此我们就可以判断出间接依赖github.com/openzipkin/zipkin-go是被grpc/test/src/client/zipkin_simple_client引入的。
另外,命令go mod why -m all则可以分析所有依赖的依赖链。