Go 代码层次结构如何可视化?

embedded-struct-visualizer

该工具通过扫描 Go 代码所在目录，然后将 Go 代码层次结构可视化。这对于复杂项目的数据结构或识别特定结构的依赖关系非常有用。

使用方法

安装 embedded-struct-visualizer

$ go install github.com/davidschlachter/embedded-struct-visualizer@latest

我默认大家已经安装好 go 环境了

embedded-struct-visualizer[1] 的用法：

$ embedded-struct-visualizer -out demo.gv .
Usage: embedded-struct-visualizer [OPTIONS] DirToScan
If the directory to scan is not provided, it defaults to './'
OPTIONS:
  -out <file>  path to output file (default: write to stdout)
  -v           verbose logging

实操

main.go 代码文件：

package main

import (
 "time"
 "domain.tld/user"
)

type A struct {
 B
 C map[string]D
}

type B struct {
 E, F  string
 G     user.Status
 Timer H
}

type D struct {
 I uint64
}

type H struct {
 Timer time.Ticker
 J     chan D
}

我们通过 embedded-struct-visualizer 生成的 Go 结构关系如下：

digraph {
"main.A" -> { "main.D" "main.B" };
"main.B" -> { "user.Status" "main.H" };
"main.H" -> { "main.D" "time.Ticker" };
}

这个看起来并不美观，那只是我们打开的姿势不对。这里需要用到 graphviz 。

首先你要确保你安装了 graphviz ，安装方法很简单（Mac） brew install graphviz 。

其他环境，可参考官网安装：https://graphviz.org/download/[2]

安装成功之后，我们就可以使用命令 dot -Tps fancy.gv -o fancy.ps ，生成 ps 文件，然后使用 Mac 自带 Preview 即可打开。

如果你还想对层次图上的对象做一些美化，那你可以再了解一下 graphviz guide[3]。

稍微复杂的一个示例 fancy.ps：

digraph G {
 size ="4,4";
 main [shape=box]; /* this is a comment */
 main -> parse [weight=8];
 parse -> execute;
 main -> init [style=dotted];
 main -> cleanup;
 execute -> { make_string; printf}
 init -> make_string;
 edge [color=red]; // so is this
 main -> printf [style=bold,label="100 times"];
 make_string [label="make a\nstring"];
 node [shape=box,style=filled,color=".7 .3 1.0"];
 execute -> compare;
}

执行命令：dot -Tps fancy.gv -o fancy.ps，即可得到如下图：

注：

如果你指定的字体找不到，可能会报以下错误： Converting the PostScript file “fancy.ps” produced the following warnings: · Handlee not found, using Courier.

其他 graphviz example https://sketchviz.com/graphviz-examples

[1]embedded-struct-visualizer: https://github.com/davidschlachter/embedded-struct-visualizer

[2]https://graphviz.org/download/: https://graphviz.org/download/

[3]graphviz guide: https://www.graphviz.org/pdf/dotguide.pdf