PlantUMLLanguage specificationUse Case Diagram
Donate236Patreon119


Диаграмма прецедентов

Рассмотрим несколько примеров:

Заметьте, что Вы можете отключить тени, используя команду skinparam shadowing false.

Прецеденты

Прецеденты заключаются в две скобки (потому что две скобки выглядят как овал).

Вы можете использовать usecase для создания прецедента. также вы можете создать псевдоним, используя as keyword. Этот пседоним будет использоваться позже во время определения связей 

@startuml

(First usecase)
(Another usecase) as (UC2)
usecase UC3
usecase (Last\nusecase) as UC4

@enduml

Актёры

Определить актёра можно заключив его значение между дветочиями.

Также Вы можете использовать ключевое слово actor для определения актёра. И вы можете создать псевдоним, используя ключевое слово as. Этот псевдоним будет использован позднее, при определении отношений.

Мы увидим, что определения актеров не обязательны. 

@startuml

:First Actor:
:Another\nactor: as Men2
actor Men3
actor :Last actor: as Men4

@enduml

Описание прецедентов

Если вы хотите описание на несколько строк, можете использовать кавычки.

Вы также можете использовать следующие разделители: --..==__. И вы можете вставлять заголовки внутри разделителей. 

@startuml

usecase UC1 as "You can use
several lines to define your usecase.
You can also use separators.
--
Several separators are possible.
==
And you can add titles:
..Conclusion..
This allows large description."

@enduml

Use package

You can use packages to group actors or use cases. 

@startuml
left to right direction
actor "Food Critic" as fc
package Restaurant {
  usecase "Eat Food" as UC1
  usecase "Pay for Food" as UC2
  usecase "Drink" as UC3
}
fc --> UC1
fc --> UC2
fc --> UC3
@enduml

You can use rectangle to change the display of the package. 

@startuml
left to right direction
actor "Food Critic" as fc
rectangle Restaurant {
  usecase "Eat Food" as UC1
  usecase "Pay for Food" as UC2
  usecase "Drink" as UC3
}
fc --> UC1
fc --> UC2
fc --> UC3
@enduml

Простой пример

Для соединения актеров и прецедентов, используется стрелка -->.

Чем больше тире - в стрелке, тем она длиннее. Вы можете добавить метку на стрелку, добавив символ : при определении стрелки.

В этом примере, вы можете видеть, что User не определён ранее и используется как актёр. 

@startuml

User -> (Start)
User --> (Use the application) : A small label

:Main Admin: ---> (Use the application) : This is\nyet another\nlabel

@enduml

Расширение

Если один актёр/прецедент расширяют другой, вы можете использовать символ <|--. 

@startuml
:Main Admin: as Admin
(Use the application) as (Use)

User <|-- Admin
(Start) <|-- (Use)

@enduml

Использование заметок

Вы можете использовать ключевые слова note left of , note right of , note top of , note bottom of чтобы создать заметку относящуюся к одному объекту.

Заметка так же может быть создана с помощью ключевого слова note , а затем прикреплена к другому объекту используя символ ... 

@startuml
:Main Admin: as Admin
(Use the application) as (Use)

User -> (Start)
User --> (Use)

Admin ---> (Use)

note right of Admin : This is an example.

note right of (Use)
  A note can also
  be on several lines
end note

note "This note is connected\nto several objects." as N2
(Start) .. N2
N2 .. (Use)
@enduml

Шаблоны

Вы можете добавить шаблоны когда определяете актёров и прецеденты, используя << и >>. 

@startuml
User << Human >>
:Main Database: as MySql << Application >>
(Start) << One Shot >>
(Use the application) as (Use) << Main >>

User -> (Start)
User --> (Use)

MySql --> (Use)

@enduml

Смена направления стрелок

По умолчанию, связи между классами имеют два тире -- и вертикально ориентированны. можно использовать горизонтальные связи, с помощью написание одного тире (или точки), вот так: 

@startuml
:user: --> (Use case 1)
:user: -> (Use case 2)
@enduml

Вы так же можете изменить направление с помощью переворачивания связи: 

@startuml
(Use case 1) <.. :user:
(Use case 2) <- :user:
@enduml

Так же возможно сменить направление добавляя ключевые слова left, right, up или down внутри стрелки: 

@startuml
:user: -left-> (dummyLeft)
:user: -right-> (dummyRight)
:user: -up-> (dummyUp)
:user: -down-> (dummyDown)
@enduml

Вы можете записать короче, используя только первый символ названия направления (например, -d- вместо -down-) или первые два символа (-do-).

Пожалуйста, помните, что Вы не должны использовать эту функциональность без реальной необходимости: GraphViz обычно даёт хороший результат без дополнительных настроек.

Разделение диаграмм

Ключевое слово newpage используется для разделения диаграмм на несколько страниц или изображений. 

@startuml
:actor1: --> (Usecase1)
newpage
:actor2: --> (Usecase2)
@enduml

Направление слева направо

Общее поведение по умолчанию - построение диаграмм сверху вниз. 

@startuml
'default
top to bottom direction
user1 --> (Usecase 1)
user2 --> (Usecase 2)

@enduml

Вы можете изменить направление на слева напрво используя команду left to right direction. Часто результат с таким направлением выглядит лучше. 

@startuml

left to right direction
user1 --> (Usecase 1)
user2 --> (Usecase 2)

@enduml

Skinparam

Вы можете использовать команду skinparam для изменения шрифтов и цветов диаграммы

Вы можете использовать данную команду :

Вы можете задать цвет или шрифт для актёров или прецедентов с шаблонами. 

@startuml
skinparam handwritten true

skinparam usecase {
BackgroundColor DarkSeaGreen
BorderColor DarkSlateGray

BackgroundColor<< Main >> YellowGreen
BorderColor<< Main >> YellowGreen

ArrowColor Olive
ActorBorderColor black
ActorFontName Courier

ActorBackgroundColor<< Human >> Gold
}

User << Human >>
:Main Database: as MySql << Application >>
(Start) << One Shot >>
(Use the application) as (Use) << Main >>

User -> (Start)
User --> (Use)

MySql --> (Use)

@enduml

Полноценный пример

@startuml
left to right direction
skinparam packageStyle rectangle
actor customer
actor clerk
rectangle checkout {
  customer -- (checkout)
  (checkout) .> (payment) : include
  (help) .> (checkout) : extends
  (checkout) -- clerk
}
@enduml