IDEA 如何生成 PUML 类文件以及高清类图

1 概述

• 在 IDEA 中生成 PUML 类文件以及高清类图是软件开发过程中一个重要的步骤，它能够帮助开发者清晰地定义和展示类之间的关系、结构以及交互。这不仅有助于代码设计和架构的优化，还能提升团队协作的效率和沟通的准确性。
• 那么 IDEA 又如何生成 PUML 类图，以及生成其对应的高清类图呢？
• 本文将以 Mac 设备下的 Android Studio 为例进行示例操作说明，其它 IDEA 工具类同。

2 相关 IDEA 插件安装

2.1 PlantUML Integration

• 地址：PlantUML Integration
• 说明：PlantUML 图表工具集成，具有代码导航和突出显示功能。

2.2 PlantUML Parser

• 地址：PlantUML Parser
• 说明：该插件可以将 Java 或 Kotlin 源代码转换成 PlantUML 语法，并可以借助 PlantUML 集成或者 Markdown 进行展示，这将大大节省你编写 PUML 的时间。

3 如何生成 PUML 类文件

• 1）安装 PlantUML Parser 插件：
  • 在 IDEA 中安装 PlantUML Parser 插件。
• 2）生成 PUML 类文件：
  • 在项目资源管理中，右键点击需要生成 PUML 类文件的包或类。
  • 选择 PlantUML Parser -> ParserConfig 配置 -> generate，即可生成对应的 .puml 类文件。

4 如何编辑和预览 PUML 类文件

• 1）安装 PlantUML Integration 插件：
  • 在 IDEA 中安装 PlantUML Integration 插件。
• 2）编辑和预览 PUML 类文件：
  • 在项目资源管理中，点击并打开要编辑和预览的 .puml 类文件，即可进行编辑和预览。

5 如何导出高清 PUML 类图

• 1）安装 PlantUML Integration 插件和 Mac OmniGraffle 软件：
  • 在 IDEA 中安装 PlantUML Integration 插件。
  • 安装 Mac OmniGraffle 软件。
• 2）导出高清 PUML 类图：
  • 利用 IDEA PlantUML Integration 插件，将 .puml 文件保存或导出为 .svg 图片文件。
  • 使用 Mac OmniGraffle 打开 .svg 图片文件，然后将其输出成 .png 或 .jpeg 图片，图片分辨率可以按需调整，从而最终生成高清的 PUML 类图。

6 其它（SequenceDiagram）

• 地址：SequenceDiagram
• 说明：SequenceDiagram 是一种从 Java、Kotlin、Scala（Beta）代码生成简单序列图（UML）的工具。
• 注意：该生成方式只能以方法为入口去进行生成。
• 其它：该插件有收费功能，可以去淘宝找一个 key 进行验证使用。