原文地址:https://waylau.com/use-plantuml-in-eclipse/
PlantUML 支持多个 IDE 的集成,比如 Eclipse、NetBeans、Intellij idea 等。
辅助快速下载链接:plantuml Jar包+graphviz-2.38安装包+PlantUML中文帮助文档
PlantUML 是一个开源项目,通过简单并带指引性语言定义来定义各种视图。该工具支持快速绘制以下 UML 图:
同时还支持以下非UML图:
通过简单直观的语言来定义这些示意图。 (语言参考指南).
新用户可以阅读快速开始. 也可以看看常见问题回答. 很多其他工具在使用 PlantUML.
尝试 PlantUML 最简单快捷的方法就是使用在线编辑服务,可访问 online server.
当您对PlantUML有了基本的了解, 就可以在本地安装和使用PlantUML了.
如果安装和使用中遇到任何问题,可以先尝试在这里找找答案(FAQ)
软件要求:
接下来, 需要下载 plantuml.jar 文件, 保存到本地安装目录.
双击 plantuml.jar 文件, 启动 plantUML界面. 可以点击"Change Directory"按钮 来重新指定工作目录. 保持界面处于打开状态,不要关闭.
这时候,就可以尝试绘制您的第一个本地UML图了. 可以使用任何您喜欢的文本工具, 例如, 在工作目录中建立一个sequenceDiagram.txt, 内容如下:
@startuml
Alice -> Bob: test
@enduml
PlantUML 会扫描和检测工作目录中的文件修改, 并且自动生成UML图像文件, 例如 sequenceDiagram.png.
当然 PlantUML 也可以通过命令行的方式来执行
java -jar plantuml.jar sequenceDiagram.txt
png图像文件中的UML图, 效果还是很不错呢!! ^_^
PlantUML for Eclipse 插件主要用于在 Eclipse 中使用 PlantUML,插件源码托管在GitHub。
安装 Graphviz 完成后,在 Eclipse 的 PlantUML 中,设置路径到 Graphviz 的 dot.exe。 如下图:
拓展:Graphviz安装成功后,可以将其配置到Windows的Path环境变量中,这样在Eclipse中就可以默认找到了,当然也可以在Eclipse中的上图显示的位置配置一下都可以。
如果 Graphviz 没有安装 成功,或者配置路径错误,则会有如下错误提示。
首先打开PlantUML视图:
PlantUML视图可以自动显示正在编辑的类的UML建模:
If you write some comment in PlantUML language, the corresponding diagram is automatically displayed. And if you have several comments with diagrams, it selects the one the cursor is in.
在 Eclipse 中编辑如下脚本:
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
PlantUML 插件会自动识别上述脚本,从而在预览窗口生成一张时序图图片。该图片可以被用于导出、复制、打印。
更多示例,可以参考官方文档 http://translate.plantuml.com/zh/PlantUML_Language_Reference_Guide_ZH.pdf
该插件不仅限于Java源文件,还适用于Ecore/Xcore文件。So that you can see the corresponding class diagram in a view side-by-side the Ecore/Xcore editor :