在工作中经常会编写技术文档,用专业的图形(用例图、时序图、ER图等等)能够更加准确表达我们的想法,别一段乏味的文字更加有意义,也便于别人理解。
虽然现在有很多类似viso之类的可视化画图工具,但是还是需要花费大量时间在拖拉组件上,效率十分低下。业内主流的绘制UML语言,都用的工具Visio、StartUML、PlantUML。我们选择PlantUML:http://plantuml.com/,在vscode、webstorm都有相关的插件可以使用。
1. 选择PlantUML的原因
PlantUML是开源的,有一个相对比较成熟的网站,通过简单的UML语言来实现想要的效果,有点极客范;
PlantUML有比较详细的各类语言的guide文档;
PlantUML做了很多的适配,比如常用的编译器eclipse,IDEA intellij都有对应的插件,同时还和Maven和JQuery都做了集成,还提供了war包形式,可以在本地的JavaEE容器(比如Tomcat)中运行起来;
PlantUML语言简单直接易学,就好像Markdown语法一样,简单高效。
2. UML语言介绍
简而言之,UML语言是一种面向对象的模型语言,通过UML语言的组合来表达某些事物之间的逻辑关系。
详细概念请参见https://www.w3cschool.cn/uml_tutorial/uml_tutorial-c1gf28pd.html
3. PlantUML语言参考文档
HTML版本:http://plantuml.com/zh/
pdf版本:https://pan.baidu.com/s/1Eq68CaSmqw3vo5972macNA ,提取码:g1f2
4. PlantUML语言编写环境
目前官方网站给出了好多种的环境搭建方式,下面着重介绍四种
5. 下面是引用标准库生成的一个逻辑图
PlantUML语言如下
SpringBoot+PlantUML(https://github.com/joelbinn/plant-uml-springboot-server)
7. 时序图
时序图相对来说是比较经常画的一种设计图稿,在这里记录一下plantuml中相关的语法。
基本用法
例子
极牛科技公众号
微信号 : jnkjnl
博客:niuzhendong.com
Github:github.com/niuzhendonglm