「IDEA插件精选」安利一个IDEA骚操作:一键生成方法的序列图

ゝ一纸荒年。 2022-12-18 06:56 223阅读 0赞

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

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

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

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

## 何为序列图？ ##

网上对于序列图的定义有很多，我觉得都不太好理解，太抽象了。最神奇的是，大部分文章对于序列图的定义竟然都是一模一样，看来大家是充分发挥了写代码的“精髓”啊！

我还是简单说一说我的理解吧！不过，说实话，我自己对于 Sequence Diagram 也不是很明朗。下面的描述如有问题和需要完善的地方，还请指出。

> **序列图**（Sequence Diagram），亦称为**循序图**，是一种[UML][]行为图。表示系统执行某个方法/操作（如登录操作）时，对象之间的顺序调用关系。
> 
> 这个顺序调用关系可以这样理解：你需要执行系统中某个对象 a 提供的方法/操作 login（登录），但是这个对象又依赖了对象 b 提供的方法 getUser(获取用户)。因此，这里就有了 a -> b 调用关系之说。

再举两个例子来说一下！

下图是微信支付的业务流程时序图。这个图描述了微信支付相关角色（顾客，商家…）在微信支付场景下，基础支付和支付的的顺序调用关系。

![img][]

下图是我写的一个 HTTP 框架中的执行某个方法的序列图。这个图描述了我们在调用 `InterceptorFactory`类的 `loadInterceptors()` 方法的时候，所涉及到的类之间的调用关系。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MzM3Mjcy_size_16_color_FFFFFF_t_70_pic_center][]

另外，国内一般更喜欢称呼序列图为"时序图"。

*  如果你按照纯翻译的角度来说， sequence 这个单词并无"时间"的意思，只有序列，顺序等意思，因此也有人说“时序图”的说法是不准确的。
 *  如果从定义角度来说，时序图这个描述是没问题的。因为 Sequence Diagram 中每条消息的触发时机确实是按照时间顺序执行的。

我觉得称呼 Sequence Diagram 为时序图或者序列图都是没问题的，不用太纠结。

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

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

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

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

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

并且，你还可以：

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

### 安装 ###

我们直接在 IDEA 的插件市场即可找到这个插件。我这里已经安装好了。

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MzM3Mjcy_size_16_color_FFFFFF_t_70_pic_center 1][]

### 简单使用 ###

1.  选中方法名（注意不要选类名），然后点击鼠标右键，选择 **Sequence Diagram** 选项即可！

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MzM3Mjcy_size_16_color_FFFFFF_t_70_pic_center 2][]

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

![c5040f1105c762ddf8689892913bc02d.png][]

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MzM3Mjcy_size_16_color_FFFFFF_t_70_pic_center 3][]

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MzM3Mjcy_size_16_color_FFFFFF_t_70_pic_center 4][]

## 我的开源项目推荐 ##

1.  [JavaGuide][] ：「Java学习+面试指南」一份涵盖大部分Java程序员所需要掌握的核心知识。准备 Java 面试，首选 JavaGuide！
2.  [guide-rpc-framework][] ：A custom RPC framework implemented by Netty+Kyro+Zookeeper.（一款基于 Netty+Kyro+Zookeeper 实现的自定义 RPC 框架-附详细实现过程和相关教程）
3.  [jsoncat][] ：仿 Spring Boot 但不同于 Spring Boot 的一个轻量级的 HTTP 框架
4.  [programmer-advancement][] ：程序员应该有的一些好习惯+面试必知事项！
5.  [springboot-guide][] ：Not only Spring Boot but also important knowledge of Spring（不只是SpringBoot还有Spring重要知识点）
6.  [awesome-java][] ：Collection of awesome Java project on Github(Github 上非常棒的 Java 开源项目集合).

[UML]: https://zh.m.wikipedia.org/wiki/UML
[img]: /images/20221122/050bb3345b714e659fd50e32043c16db.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MzM3Mjcy_size_16_color_FFFFFF_t_70_pic_center]: /images/20221122/aa646f06e99d419bae75b7771f1e4fd1.png
[IDEA]: https://plugins.jetbrains.com/idea
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MzM3Mjcy_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221122/a80095c2aa1a4a0f8ccc9cb1f4917389.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MzM3Mjcy_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221122/36259dbfa6ba4f20bb0498e16b5b7e8c.png
[c5040f1105c762ddf8689892913bc02d.png]: /images/20221122/e3ec518a79b1416ca5c2cfe7cb3dd52c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MzM3Mjcy_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221122/0fca01d5acc04fe2a3edc5054e95cf69.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MzM3Mjcy_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221122/d14c540391184fcb833bc2f3ae01cc40.png
[JavaGuide]: https://github.com/Snailclimb/JavaGuide
[guide-rpc-framework]: https://github.com/Snailclimb/guide-rpc-framework
[jsoncat]: https://github.com/Snailclimb/jsoncat
[programmer-advancement]: https://github.com/Snailclimb/programmer-advancement
[springboot-guide]: https://github.com/Snailclimb/springboot-guide
[awesome-java]: https://github.com/Snailclimb/awesome-java