PlantUML-更便捷的做图工具

PlantUML-更便捷的做图工具

马草原 787 2022-05-22

PlantUML-更便捷的做图工具

作图可以说是程序员的必备技能,很多人还是在用 OmniGraffleProcessOndraw.io 这类软件作图。
这些作图工具都有一些通病:

  • 版本管理困难
  • 团队协作困难
  • 二次编辑困难

假如老文档中的设计图需要修改,是你画的还好就是找源文件得费点功夫,如果不是你画的那就别想找到源文件了,别指望可以二次编辑了,重画吧

  • 作图效率不够高

如果希望作图质量保持一定的水准,又想画得快,多数人都做不到
强迫症患者经常把时间浪费在了对齐矩形、对齐间距上。

所以我们有必要学一下PlantUML的语法!

PlantUML 简介

官网:https://plantuml.com

PlantUML 是绘图语言,PlantUML并不是一个软件,类似MarkDown一样,固定的语法。源文件是纯文本的非常好管理和再次修改。

PlantUML 优点:

  • 上手快:学习成本超低,在语雀中使用甚至几乎没有学习成本
  • 作图心智舒适:绝大多数情形不用关心布局、样式等问题,告别对齐矩形、调间距这种繁琐无意义的事情,我们只用把心里所想表达出来即可,心智自然
  • 超强的可维护性:永远不用担心图的源文件丢了,它自己本身就是源文件,避免了文档维护的割裂
  • 容易实现版本管理、团队协同,源文件就是文本,在语雀文档很方便协同编辑

PlantUML Demo

下面是一个简单的UML图的源文件Demo

@startuml

autonumber

actor "用户" as User
participant "浏览器" as Browser
participant "服务端" as Server #orange

activate User

User -> Browser: 输入 URL
activate Browser

Browser -> Server: 请求服务器
activate Server

Server -> Server: 模板渲染
note right of Server: 这是一个注释

Server -> Browser: 返回 HTML
deactivate Server

Browser --> User

@enduml

我们在语雀、或者主流IDE中打开(上面文本保存为.puml文件)都可自动渲染


在IDEA中打开的样子:

PlantUML1

在语雀中使用(强烈推荐)

语雀对PlantUML的支持十分到位,渲染出来的图片也非常漂亮,并且还可以协同编辑!

添加 文本绘图

PlantUML3

效果

PlantUML2

PlantUML语法

PlantUML语法和MarkDown类似,纯文本的。大家可以从下面的链接进入官方文档
官方文档有中文版本介绍十分详细:
https://plantuml.com/zh/guide