快捷搜索:  汽车  科技

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)该插件能够将PlantUML的代码转换成图片,还支持各种形式的导出:如svg、png等等,传递非常容易。brew install graphviz安装完毕后,我们可以开始PlantUML插件了下方展示了一个使用PlantUML绘制的用例图,其中左侧代码部分是由我们完成编写的,右侧是PlantUML根据编码自动渲染出来的UML图,当然,编码是由语法要求的。了解更多,可以查看PlantUML官网(上方已给出跳转链接)。如上图,PlantUML Parser依赖PlantUML插件(PlantUML不仅仅是一个插件,官网还提供了一个独立的Java程序(jar包),我们还可以通过这个独立程序来绘制UML图),PlantUML依赖graphviz-dot软件包,所以,我们首先需要安装graphviz-dot。下载地址:

前言

相信每一位程序员都分析过源码,在分析源码过程中,除了了解代码实现的功能(业务逻辑),还需要深入下去了解程序代码的执行过程以及结构,往往在了解代码执行过程(动态模型)前,先对代码的结构(静态模型)有个了解是非常合适的开始。那么有什么工具能够帮助我们快速了解程序代码的结构吗?在面向对象编程领域,我们常用的一种建模语言就是UML,而UML中的类图(程序静态结构的一种表示图)就非常适合表示代码的结构。那么废话不多说,我们开始介绍本文的明星:PlantUML Parser插件。

阅读本文能收获什么?

阅读本文,我们能够通过PlantUML Parser插件(IntelliJ IDEA开发功能),快速查看指定指定目录下的所有包、类构成的一个完整的UML类图(即程序的静态结构图),通过类图,你可以看到程序代码的包结构,所有的类、类的属性方法,方便看出使用的设计模式。从而帮助你快速了解程序源码,提高工作效率。

先上几个例子:

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(1)

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(2)

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(3)

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(4)

PlantUML的简单介绍

PlantUML是一个开源的、以类似于编程的方式绘制各种UML图,它的官网:开源工具,使用简单的文字描述画UML图。

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(5)

下方展示了一个使用PlantUML绘制的用例图,其中左侧代码部分是由我们完成编写的,右侧是PlantUML根据编码自动渲染出来的UML图,当然,编码是由语法要求的。了解更多,可以查看PlantUML官网(上方已给出跳转链接)。

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(6)

安装PlantUML Parser插件相关依赖

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(7)

如上图,PlantUML Parser依赖PlantUML插件(PlantUML不仅仅是一个插件,官网还提供了一个独立的Java程序(jar包),我们还可以通过这个独立程序来绘制UML图),PlantUML依赖graphviz-dot软件包,所以,我们首先需要安装graphviz-dot。

安装graphviz-dotLinux
  • Ubuntu:sudo apt install graphviz
  • Fedora:sudo yum install graphviz
  • Debian:sudo apt install graphviz
  • CentOS:sudo yum install graphviz
Windows

下载地址:

  • 32位ZIP格式:https://gitlab.com/api/v4/projects/4207231/packages/generic/graphviz-releases/5.0.1/windows_10_msbuild_Release_graphviz-5.0.1-win32.zip
  • 32位EXE格式:https://gitlab.com/api/v4/projects/4207231/packages/generic/graphviz-releases/5.0.1/windows_10_cmake_Release_graphviz-install-5.0.1-win32.exe
  • 64位EXE格式:https://gitlab.com/api/v4/projects/4207231/packages/generic/graphviz-releases/5.0.1/windows_10_cmake_Release_graphviz-install-5.0.1-win64.exe
MAC

brew install graphviz

安装完毕后,我们可以开始PlantUML插件了

安装PlantUML插件

该插件能够将PlantUML的代码转换成图片,还支持各种形式的导出:如svg、png等等,传递非常容易。

IDEA插件安装非常简单,无非就是搜索插件名,然后点击安装,这里不过多介绍,使用一个图片表示:

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(8)

安装完该插件后,我们还需要做个简单配置:为PlantUML插件指定graphviz-dot的执行程序位置:

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(9)

MAC系统配置方法

配置好后,我们可以试玩一下了:

找个目录,点击新建,选择PlantUML File

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(10)

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(11)

选择图类型,设置图名称

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(12)

左侧就是我们敲代码的地方了,右侧将会实时刷新

简单画个类图:

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(13)

示例代码:

@startuml 'https://plantuml.com/class-diagram 还贴心的给你展示了对应图形的语法文档 package pokegame <<folder>>{ class RoomStoreFactory{ -List<Room> rooms -boolean logincheck(String roomid String user) Room initRoom(String roomid Player player) } package room <<folder>>{ package core <<folder>>{ class Room { -String id void enter() } note left of Room::enter 进入房间 end note enum RoomStatusEnum { ROOM_PREPARE ROOM_RUNNING ROOM_PREPARE_END } Room *-- RoomStatusEnum class Poke{ -int category -int size } note left of Poke::category 表示黑红花片,分别用4321表示 end note note left of Poke::size 表示面值,用1-13表示, 大小王分别用 999999和999998表示 end note abstract BaseGameRule { #int seat #int pair {abstract} void start(Object obj) {abstract} void shuffle(Object obj) {abstract} void decide() } note left of BaseGameRule::seat 游戏允许的座位数 end note note left of BaseGameRule::start 开始/重置/下一把游戏 end note note left of BaseGameRule::pair 扑克牌副数 end note class Camp { #String status #List<String> players } } package levelup <<folder>>{ '升级 游戏规则 class LevelUpGameRule extends BaseGameRule{ } note top of LevelUpGameRule 打升级 游戏规则 end note class LevelUpCamp extends Camp{ -int level -boolean isCur } note top of LevelUpCamp 打升级 阵营 end note note left of LevelUpCamp::isCur 是否是进行时 end note } } class Player { -String userId -Session session } } Room *-- BaseGameRule Room o-- Player BaseGameRule *-- Camp BaseGameRule o-- Poke RoomStoreFactory "1"-->"*" Room @enduml

回归正题,我们接下来安装PlantUML Parser插件

安装PlantUML Parser插件

该插件安装就更简单了,安装后不需要做任何额外的配置了

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(14)

安装完毕后,重启IDEA 然后选择源码的某个目录,右击PlantUML Parser,输入生成的文件名,点击generate,即可看到该目录的UML类图了。

uml图可以自动生成吗(分享一个从源码快速生成UML类图的插件)(15)

至此,本文完。

如果觉得本文写的不错,就点赞、转发、评论吧[呲牙]

猜您喜欢: