PlantUML制图-概述

图在程序设计,开发中十分重要, 如果开发一个新功能,它能帮助开发者缕清思路; 如果阅读一个就功能代码, 它能帮助开发者理解作者的想法. 一般会使用: 活动图, 时序图, 用例图, 状态图, 类图.

环境搭建

安装

1. Visual Studio Code download
2. vs code 插件
   1. PlantUML download
   2. PlantUML Previewer download
   3. Yog PlantUML Hightlight download
3. Graphviz download
4. plantuml.jar download

使用

vs code

{
    "plantuml.exportFormat": "png",
    "plantuml.jar": "D:\\myjar\\plantuml.jar"
}

生成图片: 编写puml文件， Ctrl+Shift+P 输入plantuml, 选择导出模式.
预览图片: 光标处于puml文件内的@startuml和@enduml之间, Alt+D, 右侧弹出预览框.

活动图

如果系统中超过两个对象之间存在协作关系, 并且需要表示复杂的处理流程, 则需要活动图描述过程

• 活动图

时序图

如果系统中某个功能的调用链路上涉及的对象超过3个, 则需要使用时序图来表达各个环节的输入和输出

• 时序图

用例图

需求分析阶段, 如果与系统交互的User超过1个, 并且想相关的Use Case 超过5个, 需要使用用例图表示结构化需求会更加清晰

• 用例图

状态图

如果某个业务的对象的状态超过3个, 那么需要状态图来表达各个状态变化的触发条件

• 状态图

类图

如果系统中建模类超过5个, 并存在复杂的依赖关系, 则需要类图表达各个类之间的关系

• UML类图