IntelliJ-IDEA快速生成序列图

在平时的学习/工作中,我们会经常面临如下场景:

  1. 阅读别人的代码
  2. 阅读框架源码
  3. 阅读自己很久之前写的代码。

千万不要觉得工作就是单纯写代码,实际工作中,你会发现你的大部分时间实际都花在了阅读和理解已有代码上。

为了能够更快更清晰地搞清对象之间的调用关系,我经常需要用到序列图。手动画序列图还是很麻烦费时间的,不过 IDEA 提供了一个叫做SequenceDiagram 的插件帮助我们解决这个问题。通过 SequenceDiagram 这个插件,我们一键可以生成时序图。

哪些场景下需要查看类的时序图?

我们在很多场景下都需要时序图,比如说:

  1. 阅读源码 :阅读源码的时候,你可能需要查看调用目标方法涉及的相关类的调用关系。特别是在代码的调用层级比较多的时候,对于我们理解源码非常有用。(题外话:实际工作中,大部分时间实际我们都花在了阅读理解已有代码上。
  2. 技术文档编写 :我们在写项目介绍文档的时候,为了让别人更容易理解你的代码,你需要根据核心方法为相关的类生成时序图来展示他们之间的调用关系。
  3. 梳理业务流程 :当我们的系统业务流程比较复杂的时候,我们可以通过序列图将系统中涉及的重要的角色和对象的之间关系可视化出来。
  4. ……

如何使用 IDEA 根据类中方法生成时序图?

通过 SequenceDiagram 这个插件,我们一键可以生成时序图。

并且,你还可以:

  1. 点击时序图中的类/方法即可跳转到对应的地方。
  2. 从时序图中删除对应的类或者方法。
  3. 将生成的时序图导出为 PNG 图片格式。

安装

我们直接在 IDEA 的插件市场即可找到这个插件。

如果你因为网络问题没办法使用 IDEA 自带的插件市场的话,也可以通过IDEA 插件市场的官网手动下载安装。

简单使用

  1. 选中方法名(注意不要选类名),然后点击鼠标右键,选择 Sequence Diagram 选项即可!

  1. 配置生成的序列图的一些基本的参数比如调用深度之后,我们点击 ok 即可!

你还可以通过生成的时序图来定位到相关的代码,这对于我们阅读源码的时候尤其有帮助!

时序图生成完成之后,你还可以选择将其导出为图片。



IntelliJ-IDEA快速生成序列图
https://blog.ityet.com/2018/10/15/2018-10-15-idea-squence-diagram/
作者
Leo
发布于
2018年10月15日
许可协议