实用脚本能自动生成类图吗？

wen 实用脚本 2026-07-23 5

本文目录导读：

实用脚本能自动生成类图吗？

基于Python的终极方案：pyreverse + pylint
面向多语言的通用方案：Graphviz + dot
针对特定语言的专属利器
总结：如何选择“实用脚本”？
一句话推荐

这是一个很实用的需求，答案是：能，不仅能，而且有很多成熟的方案。

但需要明确一点：“实用脚本”通常是指通过解析代码（反向工程）来自动生成UML类图，而不是AI凭空想象画一个，因为类图的核心在于展示代码中的继承、实现、关联、聚合等关系,这些必须从实际代码中提取。

以下是几种主流、实用的“脚本式”自动生成类图方案,按语言和场景分类：

基于Python的终极方案：`pyreverse` + `pylint`

几乎适用于所有代码库,无需安装额外重量级软件。

核心脚本：pyreverse（pylint自带的子工具）。
功能：扫描Python代码，自动检测类、接口、继承、关联关系，生成.dot、.png或.svc图。

一句话用法：

# 安装 pylint
pip install pylint
# 生成单个模块的类图 (输出为 .dot 文件)
pyreverse -o png -p MyProject my_script.py
# 生成整个包的类图 (输出为 .png 文件)
pyreverse -o png -p MyProject ./my_package/

优点：纯命令行，可集成进CI/CD；自动处理依赖。
输出：会生成 classes_MyProject.png 和 packages_MyProject.png。
实用技巧：如果你需求更精细的控制（如过滤掉某些类、调整布局），可以写个简单的Python脚本调用 astroid 库（pyreverse的底层）来自定义输出。

面向多语言的通用方案：`Graphviz` + `dot`

这不是一个单一脚本，而是一种可编程的图描述语言，任何能生成 .dot 文件的语言（Python、JavaScript、Java等）都可以画类图。

核心脚本：dot（Graphviz工具集）。
功能：将 .dot 格式的文本描述渲染成矢量图。
典型流程：
1. 写一个小脚本（比如Python）来解析你的源代码。
2. 生成 .dot 文本（描述类、属性、方法、箭头关系）。
3. 调用 dot 命令 生成图片。

示例（Python生成.dot文本）：

from graphviz import Digraph
dot = Digraph(comment='My UML Class Diagram')
dot.node('A', 'Car\n---\n- speed : int\n+ drive()')
dot.node('B', 'Vehicle\n---\n+ move()')
dot.edge('A', 'B', arrowhead='empty', label='extends')
dot.render('car_class_diagram', format='png', cleanup=True)

优点：彻底可控，可以自定义任何逻辑（比如只显示public方法、隐藏setter/getter）。
缺点：需要自己写代码解析AST（抽象语法树），对于大项目工程量略大,但对于固定模板的项目非常实用。

针对特定语言的专属利器

Java：PlantUML 的 PlantUML-Generator 插件或 C4-PlantUML
- 脚本方式：java -jar plantuml.jar -tpng "class_diagram.puml"。
- 自动生成puml文件：使用 grep、awk 或更高级的工具（如 grep-ast）扫描Java代码，生成 .puml 文件，或直接使用IDE插件（如 Eclipse的ObjectAid，它也算半脚本化）。
- 命令示例：find . -name "*.java" -exec grep -l "class\|interface" {} \; > /tmp/list; ./your_script_to_plantuml_converter.sh
C++：doxygen + dot
- 脚本方式：配置 Doxyfile，设置 HAVE_DOT = YES，CLASS_DIAGRAMS = YES。
- 运行：doxygen Doxyfile 自动生成所有类图，虽然Doxygen不是纯粹的“脚本”，但它是通过配置文件驱动的自动化工具，生成后通常会有大量的 .png 或 .svg 类图。
JavaScript/TypeScript：tsuml / js2uml
- 命令：npx tsuml --glob ./src/**/*.ts -o diagram.puml 或直接 npx js2uml ./src -o diagram.png。
- 核心：基于AST解析器（如TypeScript Compiler API）生成PlantUML或直接渲染。

如何选择“实用脚本”？

你的代码语言	推荐方案	“脚本”性质	输出质量	复杂度
Python	`pyreverse -o png -p MyProj .`	纯命令行单行命令	★★★★★ （继承、关联清晰）	极低
Java / C++ / 通用	`PlantUML` + 自定义AST解析	脚本生成 `.puml` 文件 + 一键渲染	★★★★☆ （可定制性极高）	中
JS/TS	`tsuml` / `js2uml`	`npx` 运行命令	★★★★☆	低
任何静态语言	`Doxygen`	配置文件驱动	★★★☆☆ （图较粗糙）	低
需要极致控制	自写 `Graphviz` + `ast` 库	完全自定义的Python/Shell脚本	★★★★★ （你想画什么画什么）	高