关于java:解放双手根据代码自动生成时序图这款IDEA插件真香

在咱们平时看代码的时候,往往会遇到一些流程比较复杂的办法,此时画个时序图有助于咱们了解办法的执行过程。不过这些办法执行过程往往比拟长,手绘时序图切实太麻烦了!明天给大家举荐一款IDEA插件,能间接依据办法生成时序图,极大提高效率!

SpringBoot实战电商我的项目mall(50k+star)地址:https://github.com/macrozheng/mall

SequenceDiagram简介

SequenceDiagram是一款能依据代码生成时序图的插件,它的性能非常弱小,次要个性如下:

  • 能间接依据代码生成时序图;
  • 能够从时序图上间接导航到对应代码;
  • 能够间接在时序图上编辑类和办法;
  • 能够将时序图导出为图片或者PlantUML文件。

应用

上面咱们来聊聊SequenceDiagram插件的应用,通过它来绘制一张mall我的项目的登录流程图。

  • 首先咱们须要在IDEA的插件市场中装置SequenceDiagram插件;
  • 而后找个办法试试,这里以我的mall我的项目中的登录办法为例,右键办法抉择生成时序图;
  • 此时在底部的时序图面板中能够看到生成的时序图,这里简略介绍下左侧几个按钮的用法;
  • 点击设置按钮,咱们能够进行生成层级、只显示我的项目中的类、跳过Getter/Setter及跳过构造函数的设置;
  • 在时序图中咱们任选一个类或者办法,能够间接跳转到源码;
  • 间接生成的时序图有些类和办法比拟多余,咱们能够应用删除节点的操作来编辑下;
  • 通过一番精简之后,一张流程清晰的时序图就制作好了,是不是很简略!
  • 咱们能够导出为图片,目前只反对svg格局;
  • 也能够导出为PlantUML文件,之前介绍过一个十分好用的PlantUML插件 ,应用它就能够对PlantUML文件进行预览和编辑了;
  • 装置胜利后关上PlantUML文件进行预览,成果还是挺不错的;
  • 主动生成的正文全是办法名称,如果咱们想要改成有意义的中文正文,能够应用PlantUML插件进行批改,批改实现后成果如下。

总结

绘制时序图,的确有助于咱们对简单办法执行流程的了解,不过手绘切实太麻烦了。咱们能够通过SequenceDiagram来生成最后的时序图,而后去除一些无用的类和办法,再通过PlantUML插件进行批改,这样就能够疾速失去一份称心的时序图了,大家感兴趣的无妨尝试下!

参考资料

官方网站:https://github.com/Vanco/Sequ…

评论

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

这个站点使用 Akismet 来减少垃圾评论。了解你的评论数据如何被处理