使用Go toolchain梳理项目module依赖关系

go mod graph是一个用于查看和分析Go模块依赖关系的工具。在使用Go语言开发时，我们通常会使用Go模块来管理我们的项目依赖。go mod graph可以帮助我们更好地了解项目的依赖关系，并找出其中可能存在的问题。

安装go mod graph

要使用go mod graph，需要先安装Go编程语言和go mod graph工具本身。如果已经安装了Go编程语言，则可以使用以下命令安装go mod graph：

go get golang.org/x/mod/graph

使用go mod graph

使用go mod graph非常简单，只需在终端窗口中运行以下命令即可：

go mod graph

运行此命令将生成一个类似于下面这样的输出：

github.com/example/project1 v1.0.0
github.com/example/project2 v1.2.3
github.com/example/project1 v1.0.0 github.com/example/project2 v1.2.3

这个输出是一个表示项目依赖关系的有向无环图（DAG）。每行都包含一个模块的名称和版本号，后跟该模块所依赖的其他模块的名称和版本号。

Go mod graph的用途

go mod graph有几个主要用途：

1. 查看依赖关系：通过运行go mod graph命令，可以查看项目中所有模块之间的依赖关系。这可以帮助开发者更好地了解项目的架构和设计，以及模块之间的相互作用。

2. 诊断问题：go mod graph还可以帮助开发者找出可能存在的依赖问题。例如，如果发现两个模块依赖于同一个模块的不同版本，那么可能需要解决版本冲突问题。

3. 优化依赖关系：通过分析go mod graph输出，可以确定哪些模块可能不需要或不再使用，从而优化项目的依赖关系。

使用Go toolchain

在使用go mod graph分析较大项目时，开发者可能需要面临非常复杂的go mod graph结果，文本形式的输出结果可能在过滤不相关的模块后仍然无法清晰得出依赖关系，此时可以考虑借助图像化工具显示输出结果，便于后续分析。

可以考虑使用graphviz类似的工具实现此目标，本文以graphviz为例，具体安装可以参考Download | Graphviz

将go mod graph的文本输出结果转化为图像输出需要借助Go toolchain进行文本的预处理，Go toolchain安装：

git clone https://github.com/lucasepe/modgv.git
cd modgv
go install

modgv从标准输入读取go mod graph生成的输出，并且生成DOT语言并写入标准输出：

go mod graph | modgv | dot -Tpng -o graph.png

得到结果类似于：

 也可以生成可以具有点击模块文档的链接的pdf文档（对于文件大小要求较高）

go mod graph | modgv | dot -Tps2 -o graph.ps
ps2pdf graph.ps graph.pdf