用PlantUML让状态图“动”起来 —— 快速绘制老师申报课程流程

**对于程序员来说，编写验收文档中的各种UML图是最让人头疼的事情之一，相信各位读者对此深有体会。**

本文将探讨如何利用AI驱动的PlantUML来快速生成专业级别的UML图表中的状态图。

PlantUML简介

PlantUML 是一种开源的、易于使用的工具，它允许用户通过简单的文本描述来生成各种类型的统一建模语言（Unified Modeling Language, UML）图表。PlantUML 支持多种 UML 图表类型，包括但不限于类图、序列图（时序图）、组件图、部署图等。

特点： PlantUML 的强大之处在于其简单易学且功能丰富，非常适合软件开发者和技术文档编写者用于快速创建清晰、专业的 UML 图表。

简洁性：用户可以使用简洁明了的文本语法来定义图表的内容。
可集成性：PlantUML 可以轻松地与多种文本编辑器和开发环境集成。
多样化输出：支持生成多种格式的图表输出，如 PNG 图片、SVG 矢量图以及 PDF 文档等。
扩展性：可以通过自定义样式和主题来增强图表的表现力。
实时预览：许多集成环境提供了实时预览功能，便于用户即时查看图表的变化。

PlantUML应用场景及解决的痛点需求

PlantUML 在多种应用场景中都非常有用，它主要解决了以下几个方面的痛点需求：

软件工程和系统设计：
- 痛点需求：在软件开发过程中，团队成员需要理解和沟通复杂的系统架构、模块间交互、数据流等。
- 应用场景：使用 PlantUML 创建类图、组件图、部署图、序列图等，帮助团队成员更好地理解系统的结构和行为。
文档编写和知识分享：
- 痛点需求：技术文档和知识分享材料需要包含清晰易懂的图表，但传统的图形工具使用起来较为繁琐。
- 应用场景：利用 PlantUML 生成高质量的图表，嵌入到技术文档、教程、博客文章中，使读者更容易理解内容。
项目管理和协作：
- 痛点需求：项目管理中需要明确各个阶段的任务分配和流程安排，但这些信息通常难以直观表达。
- 应用场景：使用 PlantUML 制作甘特图、流程图等，清晰展示项目进度和任务关系，促进团队间的协作。
教育和培训：
- 痛点需求：教育和培训材料需要包含直观的视觉辅助，帮助学生更好地学习和记忆。
- 应用场景：教师和培训师可以利用 PlantUML 创作概念图、流程图、用例图等，帮助学生理解复杂概念。
需求分析和产品规划：
- 痛点需求：在需求分析阶段，需要明确产品的功能和用户交互方式，但这些往往很难用文字描述清楚。
- 应用场景：使用 PlantUML 绘制用例图、活动图等，帮助团队成员和利益相关者理解产品的需求和工作流程。
敏捷开发和迭代：
- 痛点需求：敏捷开发过程中，需求和设计经常发生变化，需要快速更新图表以反映最新的设计决策。
- 应用场景：由于 PlantUML 文件是纯文本格式，因此可以很容易地进行版本控制并快速更新图表以适应变化。
技术面试和技术交流：
- 痛点需求：在技术面试和技术讨论中，需要清晰地表达系统架构和技术解决方案。
- 应用场景：准备面试或会议时，使用 PlantUML 快速绘制所需的图表，以便更有效地进行交流。

总之，PlantUML 通过提供一种简便的方式来创建和更新图表，极大地提高了工作效率，减少了沟通成本，并促进了更好的团队合作。

任务准备

大多数程序员使用的开发工具包括 Visual Studio Code (VSCode)。本文将以 VSCode为例进行讲解。插件中搜索plantuml、PlantUML Previewer、Fitten code。 注意plantuml需要Java环境支持。

任务描述

老师申报课程的状态图老师申报课程的状态图可以用状态机图来表示，通常会包含以下几个状态和转换过程：

初始状态
- 老师开始申报课程。
课程信息填写
- 老师填写课程名称、课程大纲、授课时间等信息。
- 转换条件：完成信息填写。
课程信息审核
- 系统或相关人员对填写的课程信息进行审核。
- 转换条件：
  - 审核通过 → 进入"课程审核通过"状态。
  - 审核不通过 → 返回"课程信息填写"状态，并提示修改原因。
课程审核通过
- 课程信息审核通过，准备发布课程。
- 转换条件：点击发布按钮。
课程发布
- 系统将课程信息发布到平台上。
- 转换条件：发布成功。

6 结束状态

diff 复制代码

-   课程申报流程结束，老师可以等待学生报名。

可以使用UML工具绘制出状态图，以便更清晰地展示各个状态及其转换关系。

任务实施

步骤一：向Fitten Code提问：使用 PlantUML 生成的老师申报课程的状态图

步骤二：新建文件后缀名为.puml 例如：subject.puml文件，复制Fitten code生成的代码

less 复制代码

@startuml
skin rose
[*] --> 入口 : 开始

入口 --> 初始状态 : 进入流程

初始状态 --> 课程信息填写 : 开始申报课程
课程信息填写 : 进行操作: 填写课程信息
课程信息填写 --> 课程信息审核 : 完成信息填写

课程信息审核 : 进行操作: 审核课程信息
课程信息审核 --> 课程审核通过 : 审核通过
课程信息审核 --> 课程信息填写 : 审核不通过\n并提示修改原因

课程审核通过 : 进行操作: 准备发布课程
课程审核通过 --> 课程发布 : 点击发布按钮
课程发布 : 进行操作: 系统发布课程
课程发布 --> 出口 : 发布成功
出口 --> [*] : 结束流程

@enduml

如果要生成跟IBM rose工具图接近，加上皮肤，在源代码中加入：skin rose 步骤三：预览效果在线生成效果比vscode好：把源代码直接复制到在线编辑器中 www.plantuml.com/plantuml

vscode中预览的效果如下：不是很清楚。

通过本文的学习，我们不仅掌握了使用PlantUML创建状态图的基本方法，还了解了它在多种场景下的应用价值。无论是提升个人技能还是加强团队协作，PlantUML都是值得尝试的好工具。希望您能将其应用到实际工作中，让您的设计更加直观、高效。