plantuml画类图 - 穆世明博客

大家平日在写技术文档时，往往都有画 UML 图的需要，很多人使用 PrecessOn 或者 darw.io 等来绘制 UML ，勉强可用但是不够专业。这里为大家推荐一个专门画UML的工具: PlantUML

PlantUML 诞生于 2009 年，知道的人多但是使用的人少。因为它使用特殊的 DSL 进行画图，相较与其他工具，PlantUML 的图不是“画”出来的而是“写”出来的。

虽然有一定学习成本，但是却可以画出更专业的UML图，而且文本格式也便于保存。本文总结 PlantUML 的基本用法，帮助大家快速入门。

PlantUML 是一个 java 程序，所以有 JDK 就能跑。可以从官网直接下载 jar 文件执行，当然它也提供了 IDEA 和 VSCode 的插件。

需要注意的是，PlantUML 的本地渲染依赖 Graphviz ，需要提前安装并配置环境变量。如果你使用 VSCode 插件，也可以借助云端渲染，只需要作如下配置：

之后就可以在 VSCode 中一边“写” UML 一边预览了。

接下来我们学习如何写出漂亮的 UML ，像学习其他语言一样从开始。

PlantUML 文件通常以为后缀，

命令行指定，

在当前目录下会将与之间的部分生成生成同名的 png

需要注意，一组对应一张 png，如果一个文件中有多组，则生成的 png 文件名会添加自增数字后缀。此外也可以紧跟在之后指定文件名

单引号后面跟随的内容是注释

后跟标题

多行 title

与之间的输入可以换行

标题样式

PlantUML 支持使用 Creole 这种标记语言，来丰富文字样式，Creole 的用法类似 markdown。

参考：https://en.wikipedia.org/wiki/Creole_%28markup%29

之后跟的内容显示为图注

可以在头部和尾部追加注释。默认右对齐，居中对齐。

对齐方式

在前加可以设置对齐方式

多行 header/footer

跟一样, ,

可以为UML设置防大率

指定类

指定接口

指定抽象类

指定枚举，定义枚举值

UML中类型之间有六大关系：

泛化（Generalization）
实现（Realization）
关联（Association)
聚合（Aggregation）
组合(Composition)
依赖(Dependency)

接下来逐一说明：

泛化

泛化关系就是类的继承，java 中对应关键字。

指定继承关系

实现

实现关系，对应关键字

, ，圆点表示虚线

依赖

依赖表示使用关系，java中, 被依赖的对象/类, 以方法参数, 局部变量和静态方法调用的形式出现。比如, 厨师在烹饪的时候看了一眼菜谱, 厨师"使用"了菜谱, 照着它炒完菜后，这种使用关系就结束了(临时性).

关联

关联关系，表示"拥有"。相比依赖关系的临时性和单向性，关联关系具有长期性、平等性(可双向)，所以关联表示的关系比依赖更强。比如现实生活中的夫妻, 师生等关系。长期存在并且是相互的关系。此外关联可以表示一对一，一对多，多对一，多对多等各种关系。

因为比依赖关系更强, 所以是实线+箭头。双向关联可以省略箭头。

后面两种关系 “聚合” 和 “组合”，都属于关联关系，用来表示关联关系中整体与部分的关系。java 中一个 Class 与其成员变量 Class 类型之间就是这种整体与部分的关联关系。

聚合

聚合关系相对于组合弱一些，整体与部分是可分离的。比如部门与员工，部门有许多员工，员工离职了部门仍然存在，不受影响。反之部门解散了，员工可以去其他部门(整体与部分可分离)

表示空心菱形

组合

组合关系中，整体与部分是不可分离的，整体与部分的生命周期保持一致，少了对方自己的存在无意义。例如人体是有四肢组成的，四肢不能脱离人体存在，人体少了四肢也难言完整

表示实心菱形

同时也看到了一对多时的数字表示方法，双引号包裹，放在线段与Class之间。多对多也同样。

最后再总结一下六大关系

继承实现依赖关联聚合组合 关系含义功能扩展功能实现使用拥有整体-部分（has-a）整体-部分（contains-a） 关系特性--临时性，单向性长期性，可双向（平等性）整体与部分可分离整体与部分不可分离，生命周期一致 java语法extendsimplements方法参数，局部变量，静态方法调用成员变量成员变量成员变量 关系强弱强强弱较强较强非常强 现实事例父子飞机/鸟可以飞厨师使用菜谱夫妻，师生部门-员工人体-四肢 图形指向箭头指向父类箭头指向接口箭头指向被使用者指向被拥有者，可双向箭头指向部分，菱形指向整体箭头指向部分，菱形指向整体