PlantUML 的安装及配置

 

 

PlantUML 支持在多个平台上安装使用，比如 Eclipse，NetBeans，oneline servlet 等，它也支持多种语言的编辑，例如 C/C++，PHP，Java，Html 等。用户可以从 PlantUML 的官方网站上下载所需用的相应的文件。http://plantuml.sourceforge.net/download.html。

下面本文仅以 Eclipse 开发操作平台为例简要地介绍 PlantUML 的安装及配置方法。

1. 下载更新 PlantUML Eclipse 插件，打开 Eclipse，Help-> Install new software...。

   填入相应的 URL：

   http://basar.idi.ntnu.no/svn/tdt4100/anonymous/trunk/updatesite/

   http://plantuml.sourceforge.net/updatesite/

   图 1. 下载安装 PlantUML 插件

   
2. 下载安装成功后，重启 Eclipse。会在 Windows->Show View->Other 看到 PlantUML 的图标。

   图 2 . PlantUML 图标成功显示

   

   用户也可以下载相应的plantuml.jar文件，进行手动安装。

 

回页首

PlantUML 的使用实例

用户可以根据不同的需要，利用 PlantUML 可以生成不同的视图。操作非常简单方便。

图 3. PlantUML 操作界面

下面本文将用实际的语法实例对应用 PlantUML 生成的各种视图进行说明介绍。

时序图

时序图亦称为序列图或循序图，是一种 UML 行为图。它通过描述对象之间发送消息的时间顺序显示多个对象之间的动态协作。它可以表示用例的行为顺序，当执行一个用例行为时，时序图中的每条消息对应了一个类操作或状态机中引起转换的触发事件。

语法实例：

?

1 2 3 4 5 6 7

@startuml title Sequence Diagram Example actor Tester1 #red actor Tester2 #Yellow Tester1 -> Tester2: 发送请求 Tester2 --> Tester1: 回复请求 @enduml

图 4. 时序图视图

用例图

用例图 - 由主角、用例以及它们之间的关系构成的图。

语法实例：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14

@startuml : 管理员 : as Admin << 管理员 >> ( 应用程序 ) as (Use) Tester1 -> ( 开始 ) Tester2 --> (Use) Admin ---> (Use) note right of Admin : 管理员身份 note left of (Use)  实现 Notes Domino 的功能 end note note "测试人员进行测试工作" as user ( 开始 ) .. user user .. (Use) @enduml

图 5. 用例图视图

类图

类图 - 显示了模型的静态结构，特别是模型中存在的类、类的内部结构以及它们与其他类的关系等。

语法实例：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

@startuml skinparam classAttributeIconSize 12 class Test << 主函数 >> { -Function1 +Function2 #Function3 ~Function4 ~method1() +method2() #method3() ~method4() } Test <|-- Test2 Test1 o-- Test2 Test *-- Test3: 调用 @enduml

图 6. 类图视图

转存失败重新上传取消

活动图

活动图 - 阐明了业务用例实现的工作流程。业务用例工作流程说明了业务为向所服务的业务主角提供其所需的价值而必须完成的工作。业务用例由一系列活动组成，它们共同为业务主角生成某些工件。工作流程通常包括一个基本工作流程和一个或多个备选工作流程。

语法实例：

?

1 2 3 4 5 6 7 8 9 10 11 12

@startuml (*) --> "Start" note right: Start Testing if "result" then  -->[true] "Next Testing"  --> "End"  -right-> (*) else  ->[false] "Change Testing"  -->[Ending process] (*) endif @enduml

图 7. 活动图视图

组件图

组件图 - 用来反映代码的物理结构。从组件图中，您可以了解各软件组件（如源代码文件或动态链接库）之间的编译器和运行时依赖关系。使用组件图可以将系统划分为内聚组件并显示代码自身的结构。

语法实例：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14

@startuml title Lotus interface "IBMDocs" as SC package "Test1" { SC - [ 第一个组件 ] Notes - [ 第一个组件 ]: use Symphony - [ 第二个组件 ] [ 其他组件 ] } package "Test2" { Connections - [ 第三个组件 ] [ 第一个组件 ] --> iNotes } @enduml

图 8. 组件图视图

状态图

状态图 - 描述一个实体基于事件反应的动态行为，显示了该实体如何根据当前所处的状态

对不同的事件做出反应的。

语法实例：

?

1 2 3 4 5 6 7 8 9 10 11

@startuml [*] --> Test state "Test" as Test {  state "Testing Module" as TM  state "Configuring Module" as CM  [*] --> CM  TM --> CM : Testing1  CM --> TM : Testing2 } note right of Test : 状态图实例 @enduml

图 9. 状态图视图

对象图

对象图 - 显示了一组对象和他们之间的关系。使用对象图来说明数据结构，类图中的类或组件等的实例的静态快照。对象图和类图一样反映系统的静态过程，但它是从实际的或原型化的情景来表达的。对象图显示某时刻对象和对象之间的关系。一个对象图可看成一个类图的特殊用例，实例和类可在其中显示。对象也和合作图相联系，合作图显示处于语境中的对象原型（类元角色）。

语法实例：

?

1 2 3 4

@startuml object Test1 object Test2 @enduml

图 10. 对象图实例

下面本文将简要地介绍一个具体实例的应用。

这个实例是由其官方网站提供：

http://plantuml.sourceforge.net/unicode.html

图 11 是由 PlantUML 的方法生成的实例图。

图 11. 具体实例图

在 PlantUML 的官方主页中，有对各种方法更为详尽的描述及说明。文本仅仅列举了一些简单的语法规则，利用 PlantUML 做出的各种视图。可以看到 PlantUML 提供了非常简单的语法规则，为用户进行编辑提供了较为便捷的方法。

PlantUML 提供了多种语言的编辑方式，如 TXT 文本，HTML，Java，C/C++，LaTex，APT，Word 及 URL 等多种方式，满足不同的用户需求。

回页首

总结

本文向读者介绍了一种开源的软件— PlantUML，它是一种简单快速的 UML 编辑软件，PlantUML 是一个用来绘制 UML 图的 Java 类库。提供了各种简单有效地方法，支持的 UML 各种视图，包括：时序图、用例图、类图、组件图、活动图等。PlantUML 可以帮助开发人员建立和编辑 UML，为开发人员提供了更多的开发条件，有较好的应用前景。