PlantUML Language specification Class Diagram

       

Edit in DokuwikiEdit in AsciidocEdit in Markdown

类图

• 文本输入，图形输出。 用几行代码声明类、字段和关系。
• 像代码一样可读。 +、-、# 表示可见性，: 表示类型，() 表示方法。
• 自由添加注解。 注释、颜色和构造型都可以直接写在文本中。

Edit in DokuwikiEdit in AsciidocEdit in Markdown

元素声明

@startuml abstract abstract abstract class "abstract class" annotation annotation circle circle () circle_short_form class class class class_stereo <<stereotype>> diamond diamond <> diamond_short_form entity entity enum enum exception exception interface interface metaclass metaclass protocol protocol stereotype stereotype struct struct @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

类之间的关系

@startuml Class01 <|-- Class02 Class03 *-- Class04 Class05 o-- Class06 Class07 .. Class08 Class09 -- Class10 @enduml

@startuml Class11 <|.. Class12 Class13 --> Class14 Class15 ..> Class16 Class17 ..|> Class18 Class19 <--* Class20 @enduml

@startuml Class21 #-- Class22 Class23 x-- Class24 Class25 }-- Class26 Class27 +-- Class28 Class29 ^-- Class30 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

关系上的标签

@startuml 类01 "1" *-- "many" 类02 : 包含 类03 o-- 类04 : 聚合 类05 --> "1" 类06 @enduml

@startuml class 汽车 发动机 - 汽车 : 驱动 > 汽车 *- 轮子 : 拥有 4 > 汽车 -- 人 : < 所属 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

在元素名称和关系标签中使用非字母

• 在类定义中使用as 关键字来指定一个别名
• 在类名称周围加上引号""

@startuml class "This is my class" as class1 class class2 as "It works this way too" class2 *-- "foo/dummy" : use @enduml

以$

开始的名称注意，以$ 开始的名称以后不能被隐藏或删除，因为hide 和remove 命令会认为该名称是$tag 而不是一个组件名称。要想以后删除这些元素，它们必须有一个别名或必须被标记。

@startuml class $C1 class $C2 $C2 class "$C2" as dollarC2 remove $C1 remove $C2 remove dollarC2 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

添加方法

@startuml Object <|-- ArrayList Object : equals() ArrayList : Object[] elementData ArrayList : size() @enduml

@startuml class Dummy { String data void methods() } class Flight { flightNumber : Integer departureTime : Date } @enduml

@startuml class Dummy { {field} A field (despite parentheses) {method} Some method } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

定义能见度(可访问性)

字符	图标(属性)	图标(方法)	可访问性
-			private 私有
#			protected 受保护
~			package private 包内可见
+			public 公有

@startuml class Dummy { -field1 #field2 ~method1() +method2() } @enduml

@startuml skinparam classAttributeIconSize 0 class Dummy { -field1 #field2 ~method1() +method2() } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Visibility on compositions and aggregations

@startuml class Aaa { -bbb : int +ccc : string #aa : float +void addEntry(mmm : Entry) +int setFactory(ddd : string) } class Factory { #fff : string } class Entry { -yyy : int } class Parent { } Aaa *--> "1..100" Entry : -entries Aaa o--> Factory : #factory Aaa o--> Parent : +parent @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

抽象与静态

@startuml class Dummy { {static} String id {abstract} void methods() } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

高级类体

@startuml class Foo1 { You can use several lines .. as you want and group == things together. __ You can have as many groups as you want -- End of class } class User { .. Simple Getter .. + getName() + getAddress() .. Some setter .. + setName() __ private data __ int age -- encrypted -- String password } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

备注和版型

@startuml class Object << general >> Object <|--- ArrayList note top of Object : In java, every class\nextends this one. note "This is a floating note" as N1 note "This note is connected\nto several objects." as N2 Object .. N2 N2 .. ArrayList class Foo note left: On last defined class @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

备注中的更多功能

• <b>
• <u>
• <i>
• <s>, <del>, <strike>
• <font color="#AAAAAA"> or <font color="colorName">
• <color:#AAAAAA> or <color:colorName>
• <size:nn> to change font size
• <img src="file"> or <img:file>: the file must be accessible by the filesystem

@startuml class Foo note left: On last defined class note top of Foo In java, <size:18>every</size> <u>class</u> <b>extends</b> <i>this</i> one. end note note as N1 This note is <u>also</u> <b><color:royalBlue>on several</color> <s>words</s> lines And this is hosted by <img:sourceforge.jpg> end note @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

注释属性 (field, attribute, member) 或方法

⚠ 注意

• 不能与top和bottom同时使用 (只支持left和right)
• 不能与表示命名空间的分隔符::同时使用

注释属性或方法

@startuml class A { {static} int counter +void {abstract} start(int timeout) } note left of A::counter 该成员已注释 end note note right of A::start 在 UML 注释了此方法 end note @enduml

给同名方法注释

@startuml class A { {static} int counter +void {abstract} start(int timeoutms) +void {abstract} start(Duration timeout) } note left of A::counter 该成员已注释 end note note right of A::"start(int timeoutms)" 这个start方法的参数是int类型 end note note right of A::"start(Duration timeout)" 这个start方法的参数是Duration类型 end note @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

链接的注释

@startuml class Dummy Dummy --> Foo : A link note on link #red: note that is red Dummy --> Foo2 : Another link note right on link #blue this is my note on right link and in blue end note @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

抽象类和接口

@startuml abstract class AbstractList abstract AbstractCollection interface List interface Collection List <|-- AbstractList Collection <|-- AbstractCollection Collection <|- List AbstractCollection <|- AbstractList AbstractList <|-- ArrayList class ArrayList { Object[] elementData size() } enum TimeUnit { DAYS HOURS MINUTES } annotation SuppressWarnings @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

隐藏属性、函数等

• empty fields 或者 empty attributes 空属性,
• empty methods 空函数，
• fields 或 attributes 隐藏字段或属性，即使是被定义了
• methods 隐藏方法，即使是被定义了
• members 隐藏字段 和 方法，即使是被定义了
• circle 类名前带圈的，
• stereotype 原型。

• class 所有类，
• interface 所有接口，
• enum 所有枚举，
• <<foo1>> 实现 foo1 的类，
• 一个既定的类名。

@startuml class Dummy1 { +myMethods() } class Dummy2 { +hiddenMethod() } class Dummy3 <<Serializable>> { String name } hide members hide <<Serializable>> circle show Dummy1 methods show <<Serializable>> fields @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

隐藏类

@startuml class Foo1 class Foo2 Foo2 *-- Foo1 hide Foo2 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

删除类

@startuml class Foo1 class Foo2 Foo2 *-- Foo1 remove Foo2 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

隐藏、删除或还原标记元素或通配符

@startuml class C1 $tag13 enum E1 interface I1 $tag13 C1 -- I1 @enduml

• hide $tag13 组件：

@startuml class C1 $tag13 enum E1 interface I1 $tag13 C1 -- I1 hide $tag13 @enduml

• 或remove $tag13 组件：

@startuml class C1 $tag13 enum E1 interface I1 $tag13 C1 -- I1 remove $tag13 @enduml

• 或remove $tag13 and restore $tag1 组件：

@startuml class C1 $tag13 $tag1 enum E1 interface I1 $tag13 C1 -- I1 remove $tag13 restore $tag1 @enduml

• 或remove * and restore $tag1 组件：

@startuml class C1 $tag13 $tag1 enum E1 interface I1 $tag13 C1 -- I1 remove * restore $tag1 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

隐藏或删除未关联的类

@startuml class C1 class C2 class C3 C1 -- C2 @enduml

• hide @unlinked 来隐藏未关联的类:

@startuml class C1 class C2 class C3 C1 -- C2 hide @unlinked @enduml

• 或者使用 remove @unlinked 来删除未关联的类:

@startuml class C1 class C2 class C3 C1 -- C2 remove @unlinked @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

泛型（generics）

@startuml class Foo<? extends Element> { int size() } Foo *- Element @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

指定标记（Spot）

@startuml class System << (S,#FF7700) Singleton >> class Date << (D,orchid) >> @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

包

@startuml package "Classic Collections" #DDDDDD { Object <|-- ArrayList } package net.sourceforge.plantuml { Object <|-- Demo1 Demo1 *- Demo2 } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

包样式

@startuml scale 750 width package foo1 <<Node>> { class Class1 } package foo2 <<Rectangle>> { class Class2 } package foo3 <<Folder>> { class Class3 } package foo4 <<Frame>> { class Class4 } package foo5 <<Cloud>> { class Class5 } package foo6 <<Database>> { class Class6 } @enduml

@startuml skinparam packageStyle rectangle package foo1.foo2 { } package foo1.foo2.foo3 { class Object } foo1.foo2 +-- foo1.foo2.foo3 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

命名空间（Namespaces）

@startuml class BaseClass namespace net.dummy #DDDDDD { .BaseClass <|-- Person Meeting o-- Person .BaseClass <|- Meeting } namespace net.foo { net.dummy.Person <|- Person .BaseClass <|-- Person net.dummy.Meeting o-- Person } BaseClass <|-- net.unused.Person @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

自动创建命名空间

@startuml set namespaceSeparator :: class X1::X2::foo { some info } @enduml

@startuml set namespaceSeparator none class X1.X2.foo { some info } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

棒棒糖接口

• bar ()- foo
• bar ()-- foo
• foo -() bar

@startuml class foo类 bar ()- foo类 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

改变箭头方向

@startuml 教室 o- 学生 教室 *-- 椅子 @enduml

@startuml 学生 -o 教室 椅子 --* 教室 @enduml

@startuml foo -left-> dummyLeft foo -right-> dummyRight foo -up-> dummyUp foo -down-> dummyDown @enduml

@startuml left to right direction foo -left-> dummyLeft foo -right-> dummyRight foo -up-> dummyUp foo -down-> dummyDown @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

“关系”类

@startuml class Student { Name } Student "0..*" - "1..*" Course (Student, Course) .. Enrollment class Enrollment { drop() cancel() } @enduml

@startuml class Student { Name } Student "0..*" -- "1..*" Course (Student, Course) . Enrollment class Enrollment { drop() cancel() } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

同级关联(Association on same classe)

@startuml class 站台 { +名称: 字符串 } class 通道 { +花费: 剩余时间 } <> 结点 通道 . 结点 结点 - "从 0..*" 站台 结点 - "到 0..* " 站台 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

样式参数

• 在图示的定义中，
• 在引入的文件中，
• 在命令行或者ANT任务提供的配置文件中。

@startuml skinparam class { BackgroundColor PaleGreen ArrowColor SeaGreen BorderColor SpringGreen } skinparam stereotypeCBackgroundColor YellowGreen 类01 "1" *-- "many" 类02 : 包含 类03 o-- 类04 : 聚合 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

模板样式

@startuml skinparam class { BackgroundColor PaleGreen ArrowColor SeaGreen BorderColor SpringGreen BackgroundColor<<Foo>> Wheat BorderColor<<Foo>> Tomato } skinparam stereotypeCBackgroundColor YellowGreen skinparam stereotypeCBackgroundColor<< Foo >> DimGray 类1 <<Foo>> 类3 <<Foo>> 类1 "1" *-- "*" 类2 : 包含(contains) 类3 o-- 类4 : 聚合(aggregation) @enduml

• `BackgroundColor_<<Foo>> Wheat`
• `skinparam stereotypeCBackgroundColor_<<Foo>> DimGray`

Edit in DokuwikiEdit in AsciidocEdit in Markdown

渐变颜色

• |,
• /,
• \,
• -,

@startuml skinparam backgroundcolor AntiqueWhite/Gold skinparam classBackgroundColor Wheat|CornflowerBlue class 类1 #red-green note left of 类1 #blue\9932CC 这是foo类的 渐变颜色 end note package 包1 #GreenYellow/LightGoldenRodYellow { class 类2 } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

辅助布局

@startuml class Bar1 class Bar2 together { class Together1 class Together2 class Together3 } Together1 - Together2 Together2 - Together3 Together2 -[hidden]--> Bar1 Bar1 -[hidden]> Bar2 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

拆分大文件

@startuml ' Split into 4 pages page 2x2 skinparam pageMargin 10 skinparam pageExternalColor gray skinparam pageBorderColor black class BaseClass namespace net.dummy #DDDDDD { .BaseClass <|-- Person Meeting o-- Person .BaseClass <|- Meeting } namespace net.foo { net.dummy.Person <|- Person .BaseClass <|-- Person net.dummy.Meeting o-- Person } BaseClass <|-- net.unused.Person @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

继承(Extends) 和 实现(implements)

@startuml class ArrayList implements List class ArrayList extends AbstractList @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

方括号表示关系(连接或箭头)的样式

线样式

• 没有标签

@startuml title 使用方括号([])表示的线样式（无标签版） class foo类 class bar类 bar类1 : [bold] bar类2 : [dashed] bar类3 : [dotted] bar类4 : [hidden] bar类5 : [plain] foo类 --> bar类 foo类 -[bold]-> bar类1 foo类 -[dashed]-> bar类2 foo类 -[dotted]-> bar类3 foo类 -[hidden]-> bar类4 foo类 -[plain]-> bar类5 @enduml

• 有标签

@startuml title 使用方括号([])表示的线样式（有标签版） class foo类 class bar类 bar类1 : [bold] bar类2 : [dashed] bar类3 : [dotted] bar类4 : [hidden] bar类5 : [plain] foo类 --> bar类 : ∅ foo类 -[bold]-> bar类1 : [bold] foo类 -[dashed]-> bar类2 : [dashed] foo类 -[dotted]-> bar类3 : [dotted] foo类 -[hidden]-> bar类4 : [hidden] foo类 -[plain]-> bar类5 : [plain] @enduml

线颜色

@startuml title 使用方括号([])表示的线颜色 class foo类 class bar类 bar类1 : [#red] bar类2 : [#green] bar类3 : [#blue] foo类 --> bar类 foo类 -[#red]-> bar类1 : [#red] foo类 -[#green]-> bar类2 : [#green] foo类 -[#blue]-> bar类3 : [#blue] 'foo类 -[#blue;#yellow;#green]-> bar类4 @enduml

线宽度

@startuml title 使用方括号([])表示的线宽度 class foo类 class bar类 bar类1 : [thickness=1] bar类2 : [thickness=2] bar类3 : [thickness=4] bar类4 : [thickness=8] bar类5 : [thickness=16] foo类 --> bar类 : ∅ foo类 -[thickness=1]-> bar类1 : [1] foo类 -[thickness=2]-> bar类2 : [2] foo类 -[thickness=4]-> bar类3 : [4] foo类 -[thickness=8]-> bar类4 : [8] foo类 -[thickness=16]-> bar类5 : [16] @enduml

混合样式

@startuml title 使用方括号([])表示的线混合样式 class foo类 class bar类 bar类1 : [#red,thickness=1] bar类2 : [#red,dashed,thickness=2] bar类3 : [#green,dashed,thickness=4] bar类4 : [#blue,dotted,thickness=8] bar类5 : [#blue,plain,thickness=16] foo类 --> bar类 : ∅ foo类 -[#red,thickness=1]-> bar类1 : [#red,1] foo类 -[#red,dashed,thickness=2]-> bar类2 : [#red,dashed,2] foo类 -[#green,dashed,thickness=4]-> bar类3 : [#green,dashed,4] foo类 -[#blue,dotted,thickness=8]-> bar类4 : [blue,dotted,8] foo类 -[#blue,plain,thickness=16]-> bar类5 : [blue,plain,16] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

改变关系(线和箭头)的颜色和样式(单行样式)

• #color;line.[bold|dashed|dotted];text:color

@startuml class foo类 foo类 --> bar类 : 默认 foo类 --> bar类1 #line:red;line.bold;text:red : 红色粗线 foo类 --> bar类2 #green;line.dashed;text:green : 绿色断线 foo类 --> bar类3 #blue;line.dotted;text:blue : 蓝色点线 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

改变类颜色和样式 (单行样式)

• #color ##[style]color

@startuml abstract 抽象类 annotation 标注 #pink ##[bold]red class 类 #palegreen ##[dashed]green interface 接口 #aliceblue ##[dotted]blue @enduml

• #[color|back:color];header:color;line:color;line.[bold|dashed|dotted];text:color

@startuml abstract 抽象类 annotation 标注 #pink;line:red;line.bold;text:red class 类 #palegreen;line:green;line.dashed;text:green interface 接口 #aliceblue;line:blue;line.dotted;text:blue @enduml

@startuml class bar类 #line:green;back:lightblue class bar类2 #lightblue;line:green class Foo类1 #back:red;line:00FFFF class Foo类Dashed #line.dashed:blue class Foo类Dotted #line.dotted:blue class Foo类Bold #line.bold class Demo类1 #back:lightgreen|yellow;header:blue/red @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

类成员的箭头方向(Arrows from/to class members)

@startuml class Foo类 { + 字段1 + 字段2 } class Bar类 { + 字段3 + 字段4 } Foo类::字段1 --> Bar类::字段3 : foo Foo类::字段2 --> Bar类::字段4 : bar @enduml

@startuml left to right direction class User类 { id : INTEGER .. 其他id : INTEGER } class Email类 { id : INTEGER .. 用户_id : INTEGER 地址 : STRING } User类::id *-- Email类::用户_id @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

分组继承关系(Grouping inheritance arrow heads)

GroupInheritance 1 (不合并)

@startuml skinparam groupInheritance 1 A1 <|-- B1 A2 <|-- B2 A2 <|-- C2 A3 <|-- B3 A3 <|-- C3 A3 <|-- D3 A4 <|-- B4 A4 <|-- C4 A4 <|-- D4 A4 <|-- E4 @enduml

GroupInheritance 2 (从2个组开始合并)

@startuml skinparam groupInheritance 2 A1 <|-- B1 A2 <|-- B2 A2 <|-- C2 A3 <|-- B3 A3 <|-- C3 A3 <|-- D3 A4 <|-- B4 A4 <|-- C4 A4 <|-- D4 A4 <|-- E4 @enduml

GroupInheritance 3 (从3个组开始合并)

@startuml skinparam groupInheritance 3 A1 <|-- B1 A2 <|-- B2 A2 <|-- C2 A3 <|-- B3 A3 <|-- C3 A3 <|-- D3 A4 <|-- B4 A4 <|-- C4 A4 <|-- D4 A4 <|-- E4 @enduml

GroupInheritance 4 (从4个组开始合并)

@startuml skinparam groupInheritance 4 A1 <|-- B1 A2 <|-- B2 A2 <|-- C2 A3 <|-- B3 A3 <|-- C3 A3 <|-- D3 A4 <|-- B4 A4 <|-- C4 A4 <|-- D4 A4 <|-- E4 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Display JSON Data on Class or Object diagram

Simple example

@startuml class Class object Object json JSON { "fruit":"Apple", "size":"Large", "color": ["Red", "Green"] } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Packages and Namespaces Enhancement

@startuml class A.B.C.D.Z { } @enduml

@startuml set separator none class A.B.C.D.Z { } @enduml

@startuml !pragma useIntermediatePackages false class A.B.C.D.Z { } @enduml

@startuml set separator none package A.B.C.D { class Z { } } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Qualified associations

Minimal example

@startuml class class1 class class2 class1 [Qualifier] - class2 @enduml

Another example

@startuml interface Map<K,V> class HashMap<Long,Customer> Map <|.. HashMap Shop [customerId: long] ---> "customer\n1" Customer HashMap [id: Long] -r-> "value" Customer @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Change diagram orientation

• top to bottom direction (by default)
• left to right direction

Top to bottom (by default)

With Graphviz (layout engine by default)

@startuml class a class b package A { class a1 class a2 class a3 class a4 class a5 package sub_a { class sa1 class sa2 class sa3 } } package B { class b1 class b2 class b3 class b4 class b5 package sub_b { class sb1 class sb2 class sb3 } } @enduml

With Smetana (internal layout engine)

@startuml !pragma layout smetana class a class b package A { class a1 class a2 class a3 class a4 class a5 package sub_a { class sa1 class sa2 class sa3 } } package B { class b1 class b2 class b3 class b4 class b5 package sub_b { class sb1 class sb2 class sb3 } } @enduml

Left to right

With Graphviz (layout engine by default)

@startuml left to right direction class a class b package A { class a1 class a2 class a3 class a4 class a5 package sub_a { class sa1 class sa2 class sa3 } } package B { class b1 class b2 class b3 class b4 class b5 package sub_b { class sb1 class sb2 class sb3 } } @enduml

With Smetana (internal layout engine)

@startuml !pragma layout smetana left to right direction class a class b package A { class a1 class a2 class a3 class a4 class a5 package sub_a { class sa1 class sa2 class sa3 } } package B { class b1 class b2 class b3 class b4 class b5 package sub_b { class sb1 class sb2 class sb3 } } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Role label to associations

@startuml class User class Item User "owner which is very long"/1 -- "0..n"/items Item @enduml