🎉 Copied!  | @startuml
abstract abstract
abstract class "abstract class"
annotation annotation
circle circle
() circle_short_form
class class
diamond diamond
<> diamond_short_form
entity entity
enum enum
interface interface
@enduml
|
Отношения между классами определяются с помощью следующих символов: | Type | Symbol | Drawing | | Extension | <|-- |  | | Composition | *-- |  | | Aggregation | o-- |  |
Можно заменить - на .., чтобы создать пунктирную линию. Зная эти правила можно нарисовать следующие изображения: 🎉 Copied! | @startuml
Class01 <|-- Class02
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 -- Class10
@enduml
|
🎉 Copied! | @startuml
Class11 <|.. Class12
Class13 --> Class14
Class15 ..> Class16
Class17 ..|> Class18
Class19 <--* Class20
@enduml
|
🎉 Copied! | @startuml
Class21 #-- Class22
Class23 x-- Class24
Class25 }-- Class26
Class27 +-- Class28
Class29 ^-- Class30
@enduml
|
Для отношения можно добавить метку. Делается это с помощью указания символа :, после которого указывается текст метки. Для указания количества элементов на каждой стороне отношения можно использовать двойные кавычки "". 🎉 Copied! | @startuml
Class01 "1" *-- "many" Class02 : contains
Class03 o-- Class04 : aggregation
Class05 --> "1" Class06
@enduml
|
Вы можете добавить дополнительные стрелки < или > в начале или в конце метки, указывающие на использование одного из объектов другим объектом. 🎉 Copied! | @startuml
class Car
Driver - Car : drives >
Car *- Wheel : have 4 >
Car -- Person : < owns
@enduml
|
Для объявления полей и методов вы можете использовать символ :, после которого указывается имя поля или метода. Для определения того, что вы указали метод или поле, система ищет скобки. 🎉 Copied! | @startuml
Object <|-- ArrayList
Object : equals()
ArrayList : Object[] elementData
ArrayList : size()
@enduml
|
Также можно группировать все поля и методы между фигурными скобками {}. Синтаксис порядка описания типа/имени довольно гибок. 🎉 Copied! | @startuml
class Dummy {
String data
void methods()
}
class Flight {
flightNumber : Integer
departureTime : Date
}
@enduml
|
You can use {field} and {method} modifiers to override default behaviour of the parser about fields and methods. 🎉 Copied! | @startuml
class Dummy {
{field} A field (despite parentheses)
{method} Some method
}
@enduml
|
Определяя методы и поля, вы можете использовать символы указания видимости, приведённые в таблице ниже: | Character | Icon for field | Icon for method | Visibility | - |  |  | private | # |  |  | protected | ~ |  |  | package private | + |  |  | public |
🎉 Copied! | @startuml
class Dummy {
-field1
#field2
~method1()
+method2()
}
@enduml
|
Убрать значки можно командой skinparam classAttributeIconSize 0: 🎉 Copied! | @startuml
skinparam classAttributeIconSize 0
class Dummy {
-field1
#field2
~method1()
+method2()
}
@enduml
|
WARNING This translation need to be updated. WARNING Вы можете определить статические или абстрактные методы и поля используя модификаторы {static} и {abstract} соответственно. Эти модификаторы могут располагаться как в начале так и в конце строки. Вы так же можете использовать {classifier} как замену для {static}. 🎉 Copied! | @startuml
class Dummy {
{static} String id
{abstract} void methods()
}
@enduml
|
По умолчанию, методы и поля автоматически группируются PlantUML. Вы можете использовать разделители, чтобы определить собственный порядок полей и методов. Можно использовать следующие разделители: --..==__. Вы также можете использовать заголовки внутри разделителей: 🎉 Copied! | @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
|
Шаблоны задаются ключевым словом class, << и >>. Также вы можете создать заметку, используя ключевые слова note left of , note right of , note top of , note bottom of. Вы также можете добавить заметку к последнему определённому классу, используя note left, note right, note top, note bottom. Ключевым словом note легко создать заметку без привязи, а после, используя символ .., привязать её к другим объектам. 🎉 Copied! | @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
|
Также допускается использование некоторых HTML-тегов, таких как: <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
Заметка может быть из нескольких строк. Можно определить заметку для класса, заданного последним, с помощью note left, note right, note top, note bottom. 🎉 Copied! | @startuml
class Foo
note left: On last defined class
note top of Object
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
|
WARNING This translation need to be updated. WARNING It is possible to add a note on field (field, attribut, member) or on method. Note on field or method 🎉 Copied! | @startuml
class A {
{static} int counter
+void {abstract} start(int timeout)
}
note right of A::counter
This member is annotated
end note
note right of A::start
This method is now explained in a UML note
end note
@enduml
|
Note on method with the same name 🎉 Copied! | @startuml
class A {
{static} int counter
+void {abstract} start(int timeoutms)
+void {abstract} start(Duration timeout)
}
note left of A::counter
This member is annotated
end note
note right of A::"start(int timeoutms)"
This method with int
end note
note right of A::"start(Duration timeout)"
This method with Duration
end note
@enduml
|
[Ref. QA-3474 and QA-5835] Возможно добавить заметку на связь, сразу после определения связи, используя note on link. Вы также можете использовать note left on link, note right on link, note top on link, note bottom on link если вы хотите изменить относительную позицию заметки с надписью. 🎉 Copied! | @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
|
Вы можете определить класс как абстрактный, используя ключевые слова abstract или abstract class. Классы будут нарисованы курсивом. Вы также можете использовать ключевые слова interface, annotation и enum. 🎉 Copied! | @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
|
*[Ref. 'Annotation with members' [Issue#458](https://github.com/plantuml/plantuml/issues/458)]* WARNING This translation need to be updated. WARNING Если вы хотите использовать не буквенные символы в названии класса (или другого объекта), вы можете использовать 2 способа : - Использовать ключевое слово
as в определении класса - Поставить кавычки
"" вокруг имени класса
🎉 Copied! | @startuml
class "This is my class" as class1
class class2 as "It works this way too"
class2 *-- "foo/dummy" : use
@enduml
|
Вы можете управлять видимостью классов с помощью команды hide/show. Базовая команда это - hide empty members. Команда скроет атрибуты или методы, если они пусты. Вместо empty members, вы можете использовать: empty fields или empty attributes для пустых полей,empty methods для пустых методов,fields или attributes, которые скроют поля, даже если они были описаны,methods, которые скроют методы, даже если они были описаны,members, которые скроют поля и методы, даже если они были описаны,circle для круглых символов перед именем класса,stereotype для шаблона.
Вы также можете указать ключевое слово, сразу за hide или show: class для всех классов,interface для всех интерфейсов,enum для всех перечислений,<<foo1>> для классов, к которым применен шаблон с помощью foo1,- имя существующего названия класса.
Для определения большого набора, состоящего из правил и исключений, можно использовать несколько команд show/hide. 🎉 Copied! | @startuml
class Dummy1 {
+myMethods()
}
class Dummy2 {
+hiddenMethod()
}
class Dummy3 <<Serializable>> {
String name
}
hide members
hide <<Serializable>> circle
show Dummy1 methods
show <<Serializable>> fields
@enduml
|
Вы также можете использовать команду show/hide, чтобы скрывать классы. Это может быть полезно, если вы определяете большой !подключенный файл, и если вы хотите скрыть некоторые классы после включения. 🎉 Copied! | @startuml
class Foo1
class Foo2
Foo2 *-- Foo1
hide Foo2
@enduml
|
WARNING This translation need to be updated. WARNING You can also use the remove commands to remove classes. This may be useful if you define a large !included file, and if you want to remove some classes after file inclusion. 🎉 Copied! | @startuml
class Foo1
class Foo2
Foo2 *-- Foo1
remove Foo2
@enduml
|
By default, all classes are displayed: 🎉 Copied! | @startuml
class C1
class C2
class C3
C1 -- C2
@enduml
|
But you can: 🎉 Copied! | @startuml
class C1
class C2
class C3
C1 -- C2
hide @unlinked
@enduml
|
- or
remove @unlinked classes:
🎉 Copied! | @startuml
class C1
class C2
class C3
C1 -- C2
remove @unlinked
@enduml
|
[Adapted from QA-11052] Вы также можете использовать скобки < и > чтобы указать на использование дженериков в классе. 🎉 Copied! | @startuml
class Foo<? extends Element> {
int size()
}
Foo *- Element
@enduml
|
Вы можете отключить отрисовку этих элементов, используя команду skinparam genericDisplay old. Обычно, метка с буквой (C, I, E or A) испольуется для классов, интерфейсов, перечисления и абстрактных классов. Но также вы можете использовать свою собственную метку для класса, когда создаёте шаблон, добавляя одну букву и цвет, как в этом примере: 🎉 Copied! | @startuml
class System << (S,#FF7700) Singleton >>
class Date << (D,orchid) >>
@enduml
|
Вы можете определить пакет, используя ключевое слово package, с возможностью объявить ещё и цвет его фона, (используя html-код цвета или его имя). Обратите внимание, что определения пакета могут быть вложенными. 🎉 Copied! | @startuml
package "Classic Collections" #DDDDDD {
Object <|-- ArrayList
}
package net.sourceforge.plantuml {
Object <|-- Demo1
Demo1 *- Demo2
}
@enduml
|
Доступны различные стили для пакетов. Можно задать стили по умолчанию с помощью команды: skinparam packageStyle, или применить шаблоны на пакет: 🎉 Copied! | @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
|
Вы также можете определить связи между пакетами, как в данном примере: 🎉 Copied! | @startuml
skinparam packageStyle rectangle
package foo1.foo2 {
}
package foo1.foo2.foo3 {
class Object
}
foo1.foo2 +-- foo1.foo2.foo3
@enduml
|
В пакетах, имя класса является уникальным идентификатором этого класса. Это значит, что у вас не может быть двух одноименных классов в разных блоках. В этом случае, вам следует использовать пространства имен вместо пакетов. Вы можете ссылаться на классы из других пространств имён по их полному определению. Классы из пространства имён по умолчанию определяются ведущей точкой. Обратите внимание, что вы не обязаны явно создавать пространство имен: полностью определенный класс автоматически попадает в правильное пространство имен. 🎉 Copied! | @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
|
Вы также можете задать другой разделитель (не точку) используя команду : set namespaceSeparator ???. 🎉 Copied! | @startuml
set namespaceSeparator ::
class X1::X2::foo {
some info
}
@enduml
|
Вы можете отключить автоматическое создание пакетов используя команду set namespaceSeparator none. 🎉 Copied! | @startuml
set namespaceSeparator none
class X1.X2.foo {
some info
}
@enduml
|
Вы также можете задать lollipops интерфейсы на классах, используя следующий синтаксис: bar ()- foobar ()-- foofoo -() bar
🎉 Copied! | @startuml
class foo
bar ()- foo
@enduml
|
По умолчанию, связи между классами имеют два тире --и вертикально ориентированны. Возможно создать горизонтальную связь, используя одно тире (or dot) вот так: 🎉 Copied! | @startuml
Room o- Student
Room *-- Chair
@enduml
|
Вы можете изменить направление перевернув связь: 🎉 Copied! | @startuml
Student -o Room
Chair --* Room
@enduml
|
Также возможно изменять направление стрелок, добавляя ключевые слова left, right, up или down внутри стрелки: 🎉 Copied! | @startuml
foo -left-> dummyLeft
foo -right-> dummyRight
foo -up-> dummyUp
foo -down-> dummyDown
@enduml
|
Вы можете укоротить запись, используя только первую букву направления (например, -d- вместо -down-) или две первые буквы (-do-). Заметьте, что вам не стоит пользоваться этой функциональностью без особой надобности: Graphviz обычно предоставляет хорошие результаты без дополнительной настройки. Вы можете задать ассоциацию класса после того, как была задана связь между двумя классами, как в примере: 🎉 Copied! | @startuml
class Student {
Name
}
Student "0..*" - "1..*" Course
(Student, Course) .. Enrollment
class Enrollment {
drop()
cancel()
}
@enduml
|
Вы можете задать это в другом направлении: 🎉 Copied! | @startuml
class Student {
Name
}
Student "0..*" -- "1..*" Course
(Student, Course) . Enrollment
class Enrollment {
drop()
cancel()
}
@enduml
|
🎉 Copied! | @startuml
class Station {
+name: string
}
class StationCrossing {
+cost: TimeInterval
}
<> diamond
StationCrossing . diamond
diamond - "from 0..*" Station
diamond - "to 0..* " Station
@enduml
|
[Ref. Incubation: Associations] Вы можете использовать команду skinparam для изменения шрифтов и цветов диаграммы Вы можете использовать данную команду : - В определении диаграммы, как любую другую команду,
- В подключенном файле,
- В конфигурационном файле, указанном в командной строке в задании ANT.
🎉 Copied! | @startuml
skinparam class {
BackgroundColor PaleGreen
ArrowColor SeaGreen
BorderColor SpringGreen
}
skinparam stereotypeCBackgroundColor YellowGreen
Class01 "1" *-- "many" Class02 : contains
Class03 o-- Class04 : aggregation
@enduml
|
Вы можете задать цвет или шрифт для шаблонов классов. 🎉 Copied! | @startuml
skinparam class {
BackgroundColor PaleGreen
ArrowColor SeaGreen
BorderColor SpringGreen
BackgroundColor<<Foo>> Wheat
BorderColor<<Foo>> Tomato
}
skinparam stereotypeCBackgroundColor YellowGreen
skinparam stereotypeCBackgroundColor<< Foo >> DimGray
Class01 <<Foo>>
Class03 <<Foo>>
Class01 "1" *-- "many" Class02 : contains
Class03 o-- Class04 : aggregation
@enduml
|
Можно объявить индивидуальный цвет для классов или примечаний, используя # обозначения. Можно использовать как стандартные названия цветов, так и RGB-код. Так же возможно использование градиента для фона, используя следующие символы для разделения пары цветов: в зависимости от направления градиента Например так : 🎉 Copied! | @startuml
skinparam backgroundcolor AntiqueWhite/Gold
skinparam classBackgroundColor Wheat|CornflowerBlue
class Foo #red-green
note left of Foo #blue\9932CC
this is my
note on this class
end note
package example #GreenYellow/LightGoldenRodYellow {
class Dummy
}
@enduml
|
WARNING This translation need to be updated. WARNING Sometimes, the default layout is not perfect... You can use together keyword to group some classes together : the layout engine will try to group them (as if they were in the same package). You can also use hidden links to force the layout. 🎉 Copied! | @startuml
class Bar1
class Bar2
together {
class Together1
class Together2
class Together3
}
Together1 - Together2
Together2 - Together3
Together2 -[hidden]--> Bar1
Bar1 -[hidden]> Bar2
@enduml
|
Иногда могут получиться очень большие файлы изображений. Вы можете использовать команду page (hpages)x(vpages) чтобы разделить создаваемое изображение на несколько файлов (страниц) : hpages - это задание числа горизонтальных страниц, и vpages - это задание числа вертикальных страниц.. Здесь также можно использовать специфику skinparam настроек как цвета разделённых страниц, так и их границы (смотри пример). 🎉 Copied! | @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
|
It is also possible to use extends and implements keywords. 🎉 Copied! | @startuml
class ArrayList implements List
class ArrayList extends AbstractList
@enduml
|
Line style It's also possible to have explicitly bold, dashed, dotted, hidden or plain relation, links or arrows:
🎉 Copied! | @startuml
title Bracketed line style without label
class foo
class bar
bar1 : [bold]
bar2 : [dashed]
bar3 : [dotted]
bar4 : [hidden]
bar5 : [plain]
foo --> bar
foo -[bold]-> bar1
foo -[dashed]-> bar2
foo -[dotted]-> bar3
foo -[hidden]-> bar4
foo -[plain]-> bar5
@enduml
|
🎉 Copied! | @startuml
title Bracketed line style with label
class foo
class bar
bar1 : [bold]
bar2 : [dashed]
bar3 : [dotted]
bar4 : [hidden]
bar5 : [plain]
foo --> bar : ∅
foo -[bold]-> bar1 : [bold]
foo -[dashed]-> bar2 : [dashed]
foo -[dotted]-> bar3 : [dotted]
foo -[hidden]-> bar4 : [hidden]
foo -[plain]-> bar5 : [plain]
@enduml
|
[Adapted from QA-4181]Line color 🎉 Copied! | @startuml
title Bracketed line color
class foo
class bar
bar1 : [#red]
bar2 : [#green]
bar3 : [#blue]
foo --> bar
foo -[#red]-> bar1 : [#red]
foo -[#green]-> bar2 : [#green]
foo -[#blue]-> bar3 : [#blue]
'foo -[#blue;#yellow;#green]-> bar4
@enduml
|
Line thickness 🎉 Copied! | @startuml
title Bracketed line thickness
class foo
class bar
bar1 : [thickness=1]
bar2 : [thickness=2]
bar3 : [thickness=4]
bar4 : [thickness=8]
bar5 : [thickness=16]
foo --> bar : ∅
foo -[thickness=1]-> bar1 : [1]
foo -[thickness=2]-> bar2 : [2]
foo -[thickness=4]-> bar3 : [4]
foo -[thickness=8]-> bar4 : [8]
foo -[thickness=16]-> bar5 : [16]
@enduml
|
[Ref. QA-4949]Mix 🎉 Copied! | @startuml
title Bracketed line style mix
class foo
class bar
bar1 : [#red,thickness=1]
bar2 : [#red,dashed,thickness=2]
bar3 : [#green,dashed,thickness=4]
bar4 : [#blue,dotted,thickness=8]
bar5 : [#blue,plain,thickness=16]
foo --> bar : ∅
foo -[#red,thickness=1]-> bar1 : [#red,1]
foo -[#red,dashed,thickness=2]-> bar2 : [#red,dashed,2]
foo -[#green,dashed,thickness=4]-> bar3 : [#green,dashed,4]
foo -[#blue,dotted,thickness=8]-> bar4 : [blue,dotted,8]
foo -[#blue,plain,thickness=16]-> bar5 : [blue,plain,16]
@enduml
|
You can change the color or style of individual relation or arrows using the inline following notation: #color;line.[bold|dashed|dotted];text:color
🎉 Copied! | @startuml
class foo
foo --> bar : normal
foo --> bar1 #line:red;line.bold;text:red : red bold
foo --> bar2 #green;line.dashed;text:green : green dashed
foo --> bar3 #blue;line.dotted;text:blue : blue dotted
@enduml
|
[See similar feature on deployment] You can change the color or style of individual class using the two following notations: With background color first (#color), then line style and line color (##[style]color ) 🎉 Copied! | @startuml
abstract abstract
annotation annotation #pink ##[bold]red
class class #palegreen ##[dashed]green
interface interface #aliceblue ##[dotted]blue
@enduml
|
[Ref. QA-1487]#[color|back:color];header:color;line:color;line.[bold|dashed|dotted];text:color
🎉 Copied! | @startuml
abstract abstract
annotation annotation #pink;line:red;line.bold;text:red
class class #palegreen;line:green;line.dashed;text:green
interface interface #aliceblue;line:blue;line.dotted;text:blue
@enduml
|
First original example: 🎉 Copied! | @startuml
class bar #line:green;back:lightblue
class bar2 #lightblue;line:green
class Foo1 #back:red;line:00FFFF
class FooDashed #line.dashed:blue
class FooDotted #line.dotted:blue
class FooBold #line.bold
class Demo1 #back:lightgreen|yellow;header:blue/red
@enduml
|
[Ref. QA-3770] 🎉 Copied! | @startuml
class Foo {
+ field1
+ field2
}
class Bar {
+ field3
+ field4
}
Foo::field1 --> Bar::field3 : foo
Foo::field2 --> Bar::field4 : bar
@enduml
|
[Ref. QA-3636] 🎉 Copied! | @startuml
left to right direction
class User {
id : INTEGER
..
other_id : INTEGER
}
class Email {
id : INTEGER
..
user_id : INTEGER
address : INTEGER
}
User::id *-- Email::user_id
@enduml
|
[Ref. QA-5261] You can merge all arrow heads using the skinparam groupInheritance, with a threshold as parameter. GroupInheritance 1 (no grouping) 🎉 Copied! | @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 (grouping from 2) 🎉 Copied! | @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 (grouping only from 3) 🎉 Copied! | @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 (grouping only from 4) 🎉 Copied! | @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
|
[Ref. QA-3193, and Defect QA-13532] | |
Отношения между классами
Theme
Edit in Dokuwiki
Edit in Asciidoc
Edit in Markdown
