Golang go mod graph 输出转为可视化的DOT文件

7次阅读

最稳做法是用管道过滤+格式重写:先grep剔除标准库和golang.org模块,再sed加引号转dot边语法,头尾补digraph和rankdir=lr,生成合规deps.dot供graphviz渲染。

Golang go mod graph 输出转为可视化的DOT文件

go mod graph 输出太乱,怎么转成 dot 格式画图

直接用 go mod graph 输出的文本没法直接喂给 Graphviz,它缺 DOT 头尾和边的双引号包裹,还会混入 Go 工具链内部模块(比如 cmd/compile)导致渲染失败或爆炸式增长。

最稳的做法是管道过滤 + 格式重写,不依赖第三方工具,纯 shell + sed/awk 就够用:

go mod graph |    grep -v '^[a-z]+/|golang.org/' |    sed -E 's/^([^ ]+) +([^ ]+)$/  "1" -> "2";/' |    sed '1i digraph deps {n  rankdir=LR;' |    sed '$a }' > deps.dot
  • grep -v '^[a-z]+/|golang.org/' 干掉标准库伪路径和 golang.org 域名模块(它们不是你项目依赖树的一部分)
  • sed -E 's/^([^ ]+) +([^ ]+)$/ "1" -> "2";/' 把每行 a b 转成 "a" -> "b";,DOT 要求节点名带引号,尤其含 /- 的模块名
  • 头尾加 digraph deps { ... }rankdir=LR 让图横向展开,避免纵向挤成一条线

为什么不能直接用 go mod graph | dot -Tpng

会报错:Error: <stdin>:x:y: syntax error in line x near '</stdin>。因为 go mod graph 输出是空格分隔的纯文本,不是合法 DOT 语法 —— 缺节点声明、缺图类型定义、没引号、没分号,Graphviz 一眼就拒收。

更麻烦的是,某些模块名含特殊字符(如 github.com/sirupsen/logrus@v1.9.3),不加引号在 DOT 里会被当多个 Token 解析,直接崩溃。

立即学习go语言免费学习笔记(深入)”;

  • DOT 规范要求:所有含 /@、空格、连字符的标识符必须用双引号包裹
  • go mod graph 默认输出包含 replace 和 indirect 模块,但它们没有显式出现在 go.mod 里,画出来容易误导依赖关系
  • 不加 rankdir=LR,默认是竖向布局,大型项目一渲染就是几十层高,根本看不清

生成 dot 后怎么快速出图(Mac / linux

装了 Graphviz 就能直接转:dot -Tpng deps.dot -o deps.png。但实际中常卡在字体或中文支持上 —— 图里如果模块名含中文或 emoji(比如注释里写了“支付模块”),默认会显示方框。

  • Mac 上用 Homebrew 安装后,Graphviz 默认不带中文字体,得手动指定:dot -Tpng -Gfontname="PingFang SC" deps.dot -o deps.png
  • Linux(ubuntu/debian)需先装中文字体:sudo apt install fonts-wqy-zenhei,再加参数:-Gfontname="WenQuanYi Zen Hei"
  • 如果只想要 SVG(缩放不失真),把 -Tpng 换成 -Tsvg,浏览器直接打开就能交互缩放

想排除 test-only 依赖或特定模块怎么办

go mod graph 不区分 normal / test / build 依赖,所有 import 都拉进来。如果你的 xxx_test.go 里 import 了 github.com/stretchr/testify,它也会出现在图里,但其实不属于主构建流。

这时候得靠 go list 配合 -f 模板精准控制输入源:

go list -f '{{if not .Indirect}}{{range .Deps}}{{.}} {{$.Module.Path}}n{{end}}{{end}}' ./... 2>/dev/NULL |    grep -v '^[a-z]+/|golang.org/' |    sed -E 's/^([^ ]+) +([^ ]+)$/  "1" -> "2";/' |    sed '1i digraph deps {n  rankdir=LR;' |    sed '$a }' > deps-clean.dot
  • go list -f 只取非 Indirect 模块的 Deps,天然过滤掉 test-only 引入的间接依赖
  • 2>/dev/null 屏蔽 go list 对 vendor 或无效包的报错,避免中断管道
  • 如果要彻底去掉某模块(比如 golang.org/x/tools),在 grep -v 后再加一道 grep -v 'golang.org/x/tools'

真正麻烦的是 vendor 目录和 replace 指向本地路径的情况 —— 这些路径在 DOT 里会变成绝对路径(如 /Users/you/project/internal/util),画图时节点名过长且不可移植。处理它们需要额外 sed 替换,但多数人其实只需要看清语义依赖,不是路径拓扑。

text=ZqhQzanResources