如何画调用关系图？

本文目录导读：

1. 手动绘制（用于架构设计、文档或快速沟通）
2. 静态代码分析工具（自动生成，不需要运行代码）
3. 动态追踪工具（需要运行程序，能看到真实调用链路）
4. 最佳实践建议
5. 总结命令（直接可复制）

绘制调用关系图的方法有很多,具体取决于你的技术栈（编程语言、框架）和目的（静态分析、动态追踪、手动设计）。

以下分手动绘制、静态工具生成和动态工具生成三种场景，为你提供最实用的方案。

---

手动绘制（用于架构设计、文档或快速沟通）

当你需要对现有代码进行梳理,或者在设计阶段规划模块交互时，可以使用下面的方法。

工具推荐

• 白板/纸笔：最适合思路梳理。
• 绘图软件：
  • Draw.io/app.diagrams.net：免费、支持导出多种格式、有UML模板。
  • ProcessOn：在线协作，适合团队。
  • Excalidraw：手绘风格，美观且随意。
  • PlantUML：代码即图表，支持嵌入Markdown，适合技术文档。

绘制步骤（以PlantUML为例，最推荐）

PlantUML通过纯文本描述生成图表,非常高效。

示例代码：

@startuml
skinparam packageStyle rect
actor User
rectangle "Web API" {
    component "AuthController" as Auth
    component "UserController" as User
}
rectangle "Service Layer" {
    component "AuthService" as AuthService
    component "UserService" as UserService
}
rectangle "Repository" {
    component "UserRepo" as Repo
}
User -> Auth : POST /login
Auth -> AuthService : authenticate()
AuthService -> Repo : findByEmail()
Repo -right-> AuthService : User
AuthService -up-> Auth : Token
Auth -up-> User : 200 OK
User -> User : GET /profile
User -> UserService : getProfile()
UserService -> Repo : findById()
@enduml

输出效果： （你会得到一个清晰的层级调用图，包含控制器、服务、仓储层。）

核心原则：

• 从上到下：请求入口（Controller）调用业务逻辑（Service），再调用数据访问（Repository）。
• 用箭头标注方向：-> 表示调用，-up->、-down-> 控制箭头位置。
• 关键参数/返回值：在箭头上标注重要入参或返回结果。

---

静态代码分析工具（自动生成，不需要运行代码）

这类工具直接分析源代码,生成调用关系图，适合大型项目重构或理解遗留代码。

Java生态（最强）

• IntelliJ IDEA（自带）：
  • 选中函数/方法 -> 右键 -> Diagrams -> Show Diagram。
  • 可以添加类或包,并且可以按层次展开（Show Implementations）。
  • 优势：最精确、交互式、支持分析Spring框架的依赖注入。
• Doxygen + Graphviz：
  • 配置Doxygen文件,生成类图和调用图。
  • 强大但配置稍复杂。

Python生态

• PyCharm：同样自带Diagrams功能（与IntelliJ类似）。
• pyan：轻量级工具，生成调用图（Call Graph）。

  pip install pyan3
  pyan3 my_project.py --graphviz > call_graph.dot
  dot -Tpng call_graph.dot -o output.png

• depends：功能更强，支持多种语言。

JavaScript/TypeScript生态

• dependency-cruiser：推荐，可以分析ESM、CommonJS等模块依赖。

  npx depcruise src --include-only "^src" --output-type dot | dot -T svg > dependency-graph.svg

• WebStorm/VS Code：VS Code插件（如 CodeGraph、Dependency Graph）。

通用工具

• SourceTrail：免费、跨语言、交互式，可以Ctrl+点击跳转。
• Understand：商业软件，极为强大，支持多种语言。

---

动态追踪工具（需要运行程序，能看到真实调用链路）

当你需要分析运行时状态（如性能瓶颈、多线程、异步调用）时使用。

通用方法

• 埋点/日志 + 链路ID：
  • 每个请求生成唯一trace_id。
  • 在每个函数入口输出日志,格式如：[trace_id:xxx] Enter MyService.handle(userId)。
  • 用grep或日志分析平台（如ELK）进行可视化。
  • 这是最灵活的方法，适合复杂系统。

特定语言

• Java：JProfiler、Async Profiler（火焰图 + 调用树）。
• Python：cProfile + snakeviz（可视化调用时间和调用路径）。
• Go：pprof + go tool trace。
• 分布式系统：Jaeger、Zipkin（基于OpenTelemetry）。

---

最佳实践建议

1. 不要画所有调用：一个大型系统可能有成千上万的调用，全部画出来会变成“毛线球”。只关注关键路径（核心业务流、高耗时点）。
2. 分层显示：将图分为几层（如：API层 -> 业务层 -> 数据层 -> 外部系统），用不同颜色或形状区分。
3. 标注关键信息：在箭头上标注方法名和关键的输入输出（如参数类型、返回值）。
4. 从自动化开始：先用 IntelliJ Diagrams 或 pyan 生成一个粗糙的图，然后手动删减和美化。
5. 使用版本控制：将生成的UML文件（如 .puml 文件）纳入Git管理，方便团队查看和更新。

总结命令（直接可复制）

针对一个Python项目生成调用图：

# 1. 安装
pip install pyan3 graphviz
# 2. 生成
pyan3 your_project.py --uses --no-defines --grouped --annotated --graphviz > call_graph.dot
# 3. 导出图片
dot -Tpng -Gdpi=300 call_graph.dot -o call_graph.png

针对一个Java项目（使用IntelliJ）：

1. 选中项目文件夹 -> 右键 -> Diagrams -> Show Diagram -> Packages。
2. 选择要分析的包 -> 右键 -> Show Dependencies。

希望这些方法能帮你画出清晰、有用的调用关系图！

标签： 关系图谱