绘图利器PlantUML使用学习

最近同事推荐了一个工具PlantUML,利用文本来绘制程序的复杂逻辑。体验下觉得不错,这里学习记录下。

插件下载

Visual Studio Code和JetBrains公司的IDEA等都有对应的插件支持,这里贴下链接。

上定义

工具有了,开始学习。

UML是啥

统一建模语言(英语:Unified Modeling Language,縮寫 UML)是非专利的第三代建模和规约语言。UML是一种开放的方法,用于说明、可视化、构建和编写一个正在开发的、面向对象的、软件密集系统的制品的开放方法。UML展现了一系列最佳工程实践,这些最佳实践在对大规模,复杂系统进行建模方面,特别是在软件架构层次已经被验证有效。

完整介绍,戳这里

PlantUML

PlantUML是款,可以利用文本语言来绘制UML图形的开源工具。PlantUML的语言是一种领域语言。它使用Graphviz来实现流程图的渲染布局。

完整介绍,戳这里

图种类

这里只列下图类别

  • 时序图
  • 用例图
  • 类图
  • 活动图
  • 组件图
  • 状态图
  • 对象图
  • 部署图
  • 定时图

各个图的使用场景,有很详细的文章,戳这里

常见问题

在了解了常用图和语法之后,实际使用中还是会有些坑,这里列下常见的问题。

文件后缀

目前支持*.wsd, *.pu, *.puml, *.plantuml, *.iuml

个人喜欢.puml,毕竟带了uml方便了解是UML

文本换行

比如图注释,经常文本需要换行,如何实现呢,\n即可

命令行操作

有时需要利用命令行实现自动化生成图片,命令如下

1
2
# 生成UML PNG
java -jar ./plantuml.jar -o "./out-png" -progress -tpng -config "./config.txt" ./internal-quote-btn
  1. jar包下载,戳这里

  2. config.txt用于图表自定义配置,比如DPI,默认生成的图表不清晰,如下配置即可。

    1
    skinparam dpi 200

写在最后

个人觉得plantuml的美妙之处是你可以以代码形式快速生成图片,高效,美观,正如markdown快速排版文章一样。

so,熟悉它即可提高出图生产力,奥利给。

相关文档