PlantUML入门

by tot in unsplash

1. 背景

随着工作时间的增长,越发觉得用专业的图形(用例图,时序图,ER图等等)去准确表达想法是很重要的。比如针对某个需求绘制的的用例图,比一段乏味的文字来的更加有意义,也便于别人理解。加之最近在学习源码的时候,发现很多书籍中都会使用类图,时序图等UML语言来描述逻辑关系。于是就在网上找了找绘制UML语言时,业界主流的一些工具都用什么,找了半天,大部分都用了下面的工具VisioStartUMLPlantUML。最终经过比较选择了PlantUML

2. 选择PlatnUML原因

  • PlantUML是开源的,有一个相对比较成熟的网站,通过简单的UML语言来实现想要的效果,有点极客范
  • PlantUML有比较详细的各类语言的guide文档
  • PlantUML做了很多的适配,比如常用的编译器eclipseIDEA intelliJ都有对应的插件,同时还和MavenJQuery都做了集成,还提供了war包形式,可以在本地的JavaEE容器(比如Tomcat)中运行起来
  • PlantUML语言简单直接易学,就好像Markdown语法一样,简单高效

3. UML语言介绍

简而言之,UML语言是一种面向对象的模型语言,通过UML语言的组合来表达某些事物之间的逻辑关系。

详细概念请参见https://www.w3cschool.cn/uml_tutorial/uml_tutorial-c1gf28pd.html

4. PlantUML语言参考文档

5. PlantUML语言编写环境

目前官方网站给出了好多种的环境搭建方式,下面着重介绍四种

  • 在线通过PlantUML语言绘制对应的UML图,plantUML官网提供了免费的在线编辑服务,通过在左侧输入对应的UML语言来生成对应的UML图,地址如下:online-site

    1553415664042.png

  • 通过本地的JavaEE容器启动plantUML.war

    下载Java J2EE WAR File(plantuml.war),将其放在本地的Tomcatwebapps目录下,启动后然后访问http://localost:8080/plantuml,就可以看到如下图所示画面,左侧编写PlantUML语言的代码,下面是效果图
    plantuml.war下载地址:https://sourceforge.net/projects/plantuml/files/plantuml.war/download

    tomcat-plantuml.war.png

  • 使用IDEA intelliJ插件绘制

    使用之前请安装PlantUML integration插件,然后就可以愉快的书写UML语言,右侧会生成对应的预览图片,可以复制或保存生成的图片到指定的目录

1553416433082.png
  • 使用SpringBoot集成plantUML
    pom.xml中添加如下依赖,更多关于PlantUML api的使用请参见具体的官方文档。参考资料2是一个简单的demo。
<dependency>
        <groupId>net.sourceforge.plantuml</groupId>
        <artifactId>plantuml</artifactId>
        <version>RELEASE</version>
</dependency>

5. 下面是引用标准库生成的一个逻辑图

  • PlantUML语言如下
@startuml
!include <cloudinsight/tomcat>
!include <cloudinsight/kafka>
!include <cloudinsight/java>
!include <cloudinsight/cassandra>
title Cloudinsight sprites example
skinparam monochrome true
rectangle "<$tomcat>\nwebapp" as webapp
queue "<$kafka>" as kafka
rectangle "<$java>\ndaemon" as daemon
database "<$cassandra>" as cassandra
webapp -> kafka
kafka -> daemon
daemon --> cassandra
@enduml
  • 效果图


    sequence.png

6. 参考资料

  1. PlantUML官网
  2. SpringBoot+PlantUML
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 作为一名开发人员,你是否只关注代码,从未绘制过UML?从现在开始,你应该开始绘制它了!作为绘制UML的工具,你选择...
    梦07阅读 20,585评论 5 13
  • 转载自VR设计云课堂[https://www.jianshu.com/u/c7ffdc4b379e]Unity S...
    水月凡阅读 1,069评论 0 0
  • 第一部分 插件的介绍 Google 在2013年5月的I/O开发者大会推出了基于IntelliJ IDEA Jav...
    Jannonx阅读 2,341评论 0 13
  • 一直没有一个好的画图工具,一般的画图工具如Visio和亿图,还需要拖拽各种操作不方便,今天实践一下plantUML...
    robot_test_boy阅读 5,325评论 0 7
  • 数年前,曾在《读者》中阅读过梁晓声的一篇文――《感恩》,具体内容详叙不出,依稀记得文中细说感恩的人与事,朴实...
    如歌姐阅读 526评论 2 0