PlantUML

最新推荐文章于 2024-02-28 09:14:25 发布
最新推荐文章于 2024-02-28 09:14:25 发布
阅读量2.9w 收藏 105
点赞数 15
分类专栏： 环境搭建 文章标签： uml 画uml 时序图 类图
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/myfriend0/article/details/78673718
版权

PlantUML

前言

UML 对于技术文档来说，真的很重要，不管是形象展示，还是阅读理解，都发挥非常重要的作用。之前一直用 visio 画图，当然，我必须承认 visio 集成了众多微软的画图套件，visio 在手，真的可以搞定很多图，但画 UML 真的也有很多需要改进的地方。但是我一直坚持使用，因为我就是很懒，画的 UML 不算多，就懒得去学新的方式。

但是，现在，真的是需要坚定改变自我了，让画 UML 效率提上一个档次。

为什么选择PlantUML

画 UML 的工具真的很多，从之前很火的 rose、startUML，也有在线的 WebChart 和 ProcessOn，还有 md 编辑器也可以画。

从安装成本上，rose、startUML、visio、md 需要下载软件安装，而 webChart 和 ProcessOn 用浏览器访问即可使用。

从学习成本上，rose、startUML、visio、ProcessOn 都是图形化操作界面，用鼠标拉呀拖呀，键盘敲呀，就出来 UML 图了。而 md、webChart、PlantUML 需要学习专门的语法，才能开始工作。

到底应该用哪个呢？

如果你不是一个程序员，啊，不是程序员应该不用画 UML 图吧，实在要用，visio 最好不过了。

如果你是一个程序员，

你有颜控，你有图形化操作强迫症，只能选择 rose、startUML、visio、ProcessOn；

你只是偶尔需要画一画，visio、ProcessOn 是不二的选择；

你写 md，十年不画一画，用 md、ProcessOn 立马解决就可以了；

你专业，懂语法，webChart、PlantUML 是很好的伴侣；

你专业，懂语法，讲效率，讲质量，PlantUML 或许能帮助你。

PlantUML 不仅可以嵌套到各种文本编辑器，IDE 工具，也提供在线版，你用 sublime、你用 Android Studio，你用 Eclipse，你什么工具都没有，裸机到只有一款浏览器，你也可以把 PlantUML 集成到服务器，等等，你都可以用 PlantUML。

PlantUML 是什么？

PlantUML 是基于 Java 语言的开源 UML 图形绘制工具，是创建UML图形的组件，它通过简单直观的脚本来定义和创建 UML 图形。

准备工作

由于 sublime 是笔者常用的一个文本编辑器，本文就以 sublime + plantUML 的方式准备环境。

笔者操作系统：Ubuntu。

  1. 安装 Java 环境。

    为什么需要java，因为 PlantUML 是用 java 写的，执行 PlantUML 的代码需要 java。java 的安装方法本文就不再阐述了。

  2. 下载 Sublime。

    读者根据自身的系统下载相应的版本。

  3. 下载 Graphviz。读者根据自身的操作系统下载对应的软件版本。

    什么是 Graphviz？Graphviz 是开源的图形可视化软件，可以将文本语言转换成图表。

    为什么需要 Graphviz？PlantUML 用 Graphviz 来渲染输出 UML 模型。

    如果你和笔者一样使用 Ubuntu，那就：

    sudo apt-get install graphviz

    如果出现依赖安装失败，请先执行，：

    sudo apt-get -f install

    再执行安装 graphviz。

  4. 下载 PlantUML For Sublime。

    打开 Sublime，点击菜单栏的 Preferences -> Browse Packages…，把插件解压到打开的目录，重启 Sublime。

    为什么需要插件？插件可以让你在 Sublime 上写 PlantUML 语言，方便驱动 PlantUML 产出 UML 模型。

打开 Sublime 提示 Unable to load diagram plugin,check console for details.出现这个错误多数是两个原因：

  1. Graphviz 没有安装好，请确认 Graphviz 是否安装成功。
  2. 打开插件的目录，找到 Diagram.sublime-settings 文件，将”charset”: null改为”charset”: “UTF-8”。
  3. 其它，请点击 Sublime 菜单 View -> Show Console，分析错误 log。

到此，环境已经准备好了。为什么没有下载 PlantUML？

因为在第 4 步中下载 PlantUML For Sublime 已经包含了 PlantUML。打开插件目录 -> diagram，找到 plantuml-xxxx.jar。对，PlantUML 就是一个 jar 包。你也可以手动通过在终端中运行：

java -jar plantuml-xxxx.jar plantuml_text_language(后文学习)

输出 UML 模型图。

创建UML

打开 Sublime，File -> New File，点击右下角的 Plain text，选择 Diagram。PlantUML 默认保存的文件格式是 wsd。写好 plantuml language 后，在 Sublime 按 Alt + m 组合键，便会自动输出 UML 模型图，并在 Sublime 显示。

时序图

PlantUML脚本语言
@startuml
hide footbox 
title Sequence 

actor User #Blue
User->A
note left: Note on left

[o->A: message
activate A
note right: 生命线

A->B: message
deactivate A
activate B
note right: Note on right

B-->A: message
deactivate B
activate A

A->A: message
activate A
deactivate A
deactivate A

A->o C
note right: 箭头样式

A-[#blue]>C
note right: 箭头颜色

alt AD
    A->D: message
else DA
    A->D: message
end
note over D #FFAAAA: 组合消息

D->E:message
note right: Creole和HTML
note right of E
  This is **bold**
  This is //italics//
  This is ""monospaced""
  This is --stroked--
  This is __underlined__
  This is ~~waved~~
end note

== 分隔符 ==

E->F: message

...
note over A:延迟
F->A:message

box "包裹参与者DEF" #LightBlue
    participant D
    participant E
    participant F
end box
@enduml
UML模型输出

这里写图片描述

用例图

PlantUML脚本语言
@startuml
title 用例图

actor A
actor B
A<|--B
note left of A:角色

note "继承" as inherit
A .. inherit
inherit .. B

A->(Base)
B->(Inherit)
(Base)<|--(Inherit)
note right of (Base):用例

B----->(Do some things)
note "-越多，箭头越长" as things
B .. things
things .. (Do some things)

B -left->(Do some things2)
note top of (Do some things2):改变箭头方向

rectangle SomeThings {
  C -- (SomeThings)
  (SomeThings) .> (Sub some things) : message
  (Sub some things2) .> (SomeThings) : message
  (SomeThings) -- D
}
@enduml
UML模型输出

这里写图片描述

类图

PlantUML脚本语言
@startuml
title 类

abstract class Abstract
interface Interface
package com.plantuml {
    Abstract <|-- Class02:inherit
    Class02 *-- Class03:contains
    Class03 o-- Class04:aggregation
    Class04 --|> Interface:inherit

    Class01 : fun()
    Class01 : String getString()
    Class01 : void setString(String str)
}


class Dummy {
 -field1
 #field2
 ~method1()
 +method2()
}
note right of Dummy
"可访问性"
"-  private"
"#  protected"
"~ package private"
"+  public"
end note

class Dummy2 {
  {static} String id
  {abstract} void methods()
}
note bottom of Dummy2
修饰符{static}或者{abstract}
end note

Dummy2 -> Dummy:link
note on link #blue:Dummy link Dummy2

@enduml
UML模型输出

这里写图片描述

活动图

PlantUML脚本语言
@startuml
title 活动图

start

:开始;
note left: 活动标签
if (你是程序员吗？) then (我不是)
    :我和你没有共同话题;
else if (你会AI吗？) then (Yes)
        :请帮我找2个大涨的股票;
        repeat
        fork
            partition 线程一 {
                :开始爬虫;
                note left:并行处理
                -[#green]->
                :上传云计算;
                -[#green]->
                :大数据分析;
            }

        fork again
            partition 线程二 {
                :开始爬虫;
                note right:并行处理
                -[#green]->
                :上传云计算;
                -[#green]->
                :大数据分析;
            }
        end fork
        repeat while(没有符合条件的股票)

        #red:没有这样的股票;
        if(继续深造?) then (No)
            :我和你没有什么话说了;
        else 
            if(有机器学习？) then(No)
                :升级深度学习算法;
            else (Yes)
                :神经网络学习中...;
                :语音识别|
                :视觉识别>
                :动作识别<
                :while}
            endif
        endif
else (No)
    :我和你没有共同话题;
endif
stop
@enduml
UML模型输出

这里写图片描述

组件图

PlantUML脚本语言
@startuml

package "Some Group" {
  HTTP - [First Component]
  [Another Component]
}

node "Other Groups" {
  FTP - [Second Component]
  [First Component] --> FTP
} 

cloud {
  [Example 1]
}


database "MySql" {
  folder "This is my folder" {
    [Folder 3]
  }
  frame "Foo" {
    [Frame 4]
  }
}


[Another Component] --> [Example 1]
[Example 1] --> [Folder 3]
[Folder 3] --> [Frame 4]

@enduml
UML模型输出

这里写图片描述

状态图

PlantUML脚本语言
@startuml
title 状态图

scale 600 width

[*] -> State1
State1 --> State2 : Succeeded
State1 --> [*] : Aborted
State2 --> State3 : Succeeded
State2 --> [*] : Aborted
note left of State2 : this is a short\nnote
state State3 {
  state "Accumulate Enough Data\nLong State Name" as long1
  long1 : Just a test
  [*] --> long1
  long1 --> long1 : New Data
  long1 --> ProcessData : Enough Data

  [*] -> NumLockOff
  NumLockOff --> NumLockOn : EvNumLockPressed
  NumLockOn --> NumLockOff : EvNumLockPressed
  --
  [*] -> CapsLockOff
  CapsLockOff --> CapsLockOn : EvCapsLockPressed
  CapsLockOn --> CapsLockOff : EvCapsLockPressed
  --
}
State3 --> State3 : Failed
State3 --> [*] : Succeeded / Save Result
State3 --> [*] : Aborted

@enduml
UML模型输出

这里写图片描述

总结

使用 PlantUML 画 UML 模型图，你只需要简单学习一下 PlantUML language 即可开始画图，你可以用通过很简单的语法表示，不需要考虑如果去组织图形，PlantUML 便会输出=高质量的 UML 模型图。但是，PlantUML 自动生成的图片布局可能不是你最喜欢的，这点上非常不好。

参考：

  1. PlantUML 准备工作
  2. PlantUML语言参考指南 或 CSDN下载
  3. PlantUML FAQ
FamilyYuan
关注
  • 15
    点赞
  • 踩
  • 105
    收藏
    觉得还不错? 一键收藏
  • 5
    评论
专栏目录
Plantuml 手册
04-10
Plantuml 使用手册。该手册提供了详尽的 Plantuml 语法，包括时序图、类图、用例图、活动图、组件图、状态图、对象图等各种 uml 图的语法手册。
PlantUML画类图添加备注和模板
02-07
PlantUML画类图添加备注和模板
IDEA使用插件绘制UML类图+PlantUML语法讲解
记录一名在读研究生的学习笔记、感悟、开发产物
07-09 4732
介绍如何使用IDEA安装插件来绘制UML类图，并介绍绘制类图的相关语法
PlantUML简介
最新发布
鹏哥说编程
02-28 1171
​ plantUML是一款开源的UML图绘制工具，支持通过文本来生成图形，使用起来非常高效。可以支持时序图、类图、对象图、活动图、思维导图等图形的绘制。你可以在IDEA中安装插件来使用PlantUML, 或者在Visual Studio Code中安装插件。 也可以在drawon中使用UML。
plantuml-docker
04-04
植物园码头工人 提供映像的源代码。 它提供了将用作基于的cli工具的功能。 要构建映像，您需要安装Java，因为我们正在使用来管理plantuml依赖项。 配置为以自动方式更新依赖关系。 用法 ＆TLDR; 您应该能够在脚本docker run karfau/plantuml[:VERSION]将命令中的java -jar plantuml.jar替换为。 更多细节： 如您在中运行上面的命令时不带任何参数将呈现帮助输出，该输出也可以在末尾在线阅读 输入和输出当然遵循docker规则，并且目前没有准备使文件更容易使用的安装点（欢迎PR！）。 因此，您可以自己挂载目录并提供相关参数， 或者，您可以使用-p[ipe]参数来使用stdin和stdout（如）： 或者您将新的选项与-encode和-decode一起使用。 如果您找到了一种使用图像的方法，请随时提供修改test-do
plantuml.jar
12-04
plantuml导出图片必须要使用该jar包，否则将会导致生成图片失败。
plantuml的几个技巧
wwwjr00的博客
04-27 2747
关键词将某些类进行分组： 布局引擎会尝试将它们捆绑在一起（如同在一个包(package)内)，你也可以使用建立。PlantUML类图的语法：您可以定义接口，成员关系，包，泛型，注释...改变字体和颜色也有可能。显示出垂直 方向的线. 要得到水平方向使用单破折号，也可通过在箭头内部使用关键字， 例如。- 为了使所有线条笔直（但不一定是水平或垂直的），您可以使用。- 为了只绘制水平或垂直直线，您可以使用。2.1 默认采用两个破折号。有时候，默认布局并不完美...链接的方式来强制布局。
[UML专题-2]：plantUML绘制软件设计图形快速入门
文火冰糖（王文兵）的博客
01-12 1112
目录 第1章 官方快速入门入口 第2章 UML工具的整体架构 第3章plantUML的快速使用 3.1 进入编程环境 3.2 基本操作 第4章 其他复杂功能的使用 4.1 从官网拷贝参考模型的代码 4.2 从之前自己编写的代码 第5章 如何学习plantUML语法 5.1 还是从官网入手 5.2 网络视频课程 5.3 网络文章 第1章 官方快速入门入口 （1）start..
【PlantUML】-类图-布局，如何改变元素位置
记忆、理解、表达和融会贯通。
01-13 2456
本篇文章以例子为基础，简单地说几个在实际应用过程中摸索出来的PlantUML布局的原则。相信看完这篇文章（有示例），你就可以轻松驾驭PlantUML的布局，自由调动元素了。
PlantUML——程序员画架构图都靠它
热门推荐
蛮三刀酱
12-13 1万+
引言 作图可以说是程序员的必备技能，最近发现身边同学们主要还是在用 OmniGraffle、ProcessOn、draw.io 这类软件作图，用的过程中可以思考一下下面这些问题是否困扰了你： 版本管理困难、团队协作困难、二次编辑困难：假如老文档中的设计图需要修改，是你画的还好就是找源文件得费点功夫，如果不是你画的那就别想找到源文件了，别指望可以二次编辑了，重画吧； 作图效率不够高：如果希望作图质量保持一定的水准，又想画得快，多数人都做不到； 强迫症患者经常把时间浪费在了对齐矩形、对齐间距上。 鉴于上述困
使用PlantUML(IDEA)构建类图
Swing
11-23 6357
前言： 本文有参考此文：http://plantuml.com/zh/class-diagram PlantUML是一个用代码构图的工具（如关系图，时序图，组件图，类图等）本文着重其在类图中的应用 如果你可以熟练PlantUML的构图语法，工作效率不会亚于拖拽式绘图软件，并且易于拓展性是其最大的亮点 有关在IDEA中安装PlantUML方法可参考：https://www.jianshu.co...
PlantUML中文文档
05-16
代码绘图文档
PlantUML使用手册
03-10
PlantUML使用手册，里面详细的描述了各种流程图如何使用
plantuml2ddl:Intellij IDEA插件-MySQL DDL和PlantUML相互转换
05-24
PlantUML2DDL 用于Mysql DDL的Intellij IDEA插件和PlantUML转换。 安装 从插件市场和磁盘安装此插件 定义符号 象征 解释 例子 ＃ 首要的关键 # ID：BIGINT（20） << pk>> 首要的关键 id：bigint（20） <<pk>> * 非空 *类型：tinyint（4） << notnull>> 非空 类型：tinyint（4） <<notnull>> <<生成>> 自动递增 #id：bigint（20） <<generated>> << default>> 默认值{DEFAULT_VALUE} *名称：varchar（50） <<default>> 类型：tinyint（4） <<default>> -{COLUMN_COMMENT} 列C
PlantUML.zip
11-29
PlantUML是一个开源项目，支持快速绘制： 时序图 用例图 类图 活动图 (旧版语法在此处) 组件图 状态图 对象图 部署图 定时图 同时还支持以下非UML图: 线框图形界面 架构图 规范和描述语言 (SDL) Ditaa diagram 甘特图 思维导图 Work Breakdown Structure diagram 以 AsciiMath 或 JLaTeXMath 符号的数学公式 Entity Relationship diagram 通过简单直观的语言来定义这些示意图。
obsidian-plantuml
03-21
黑曜石植物 在渲染图 该插件使用进行渲染。 您还可以托管自己的服务器（ / / ）并在设置中指定其地址。 用法 使用“ plantuml”作为语言来创建受防护的代码块。在内部指定您的plantuml代码。 可以在plantuml.com上找到有关 例子 ` ` ` plantuml Bob -> Alice : hello Alice -> Wonderland: hello Wonderland -> next: hello next -> Last: hello Last -> next: hello next -> Wonderland : hello Wonderland -> Alice : hello Alice -> Bob: hello ` ` ` 结果是： ` ` ` plant
plantUML.zip
03-29
画图工具，已经编译好，只需按照 脚本提示 进行 安装即可，只支持 mac/linux 环境
PlantUML中文手册.pdf
05-15
在写文档的过程中，经常需要进行画图。最近在网上找到了一款还算不错的绘图工具-- Plantuml, 它本质上是也算一门可以快速画图的设计语言，PlantUML中文手册，详细的上手教程，适合新手上路。稳得狠……
plantuml-parser:使用JavaScript或TypeScript解析PlantUML
05-02
植物解析器 使用JavaScript或TypeScript解析PlantUML 该项目的目的是为语法提供功能完整，经过良好测试和可维护的 。 该解析器旨在用作或。 重要提示：解析器尚未完成功能。 但是我们专注于编写一个健壮的实现，可以...
plantuml教程
07-28
PlantUML 是一个开源的绘图工具，它使用简单的文本描述语言来创建 UML 图表和其他类型的图表。下面是一个简单的 PlantUML 教程，帮助你入门： 1. 安装 PlantUML：首先，你需要安装 PlantUML 工具。你可以在官方网站（https://plantuml.com/）上找到适用于不同操作系统的安装指南。 2. 编写 PlantUML 代码：使用文本编辑器创建一个以 `.puml` 或 `.plantuml` 为扩展名的文件，然后开始编写 PlantUML 代码。PlantUML 使用一种简单的语法来描述图表元素和关系。 3. 绘制类图：类图是 UML 中最常用的图表类型之一。下面是一个简单的例子： ```plantuml @startuml class Car { +speed: int +accelerate() +decelerate() } class ElectricCar { +chargeLevel: int +charge() } Car --|> ElectricCar @enduml ``` 这段代码定义了两个类 `Car` 和 `ElectricCar`，并使用箭头表示继承关系。 4. 生成图表：保存 PlantUML 代码后，使用 PlantUML 工具将其转换为图表。你可以使用命令行工具或集成到 IDE 中的插件来实现这一步骤。根据你选择的工具，执行相应的命令或操作来生成图表。 以上是一个简单的 PlantUML 教程，帮助你入门。PlantUML 还支持其他类型的图表，如时序图、用例图、活动图等。你可以在官方文档中找到更多详细的语法和示例。祝你使用 PlantUML 绘制出漂亮的图表！

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值