PlantUML：用例图语法规则总结

引言

用例图（Use Case Diagram）是软件工程中用于描述系统参与者（actors）与系统自身之间交互的视觉表示。这些图不仅有助于明确系统的功能需求，还能帮助理解用户如何与系统交互。PlantUML提供了一种独特的方法来通过其基于文本的语言创建用例图。

定义用例（Usecases）

在PlantUML中，用例用括号包围，因为两个括号看起来像一个椭圆。你也可以使用usecase关键字来定义一个用例。

@startuml
(First usecase)
(Another usecase) as (UC2)
usecase UC3
@enduml

定义参与者（Actors）

参与者的名称用冒号包围。你也可以使用actor关键字来定义一个参与者。

@startuml
:First Actor:
:Another actor: as Man2
actor Woman3
@enduml

改变参与者样式

你可以使用skinparam actorStyle命令来改变参与者的样式。

@startuml
skinparam actorStyle awesome
:User: --> (Use)
@enduml

用例描述

如果你想要一个跨越多行的描述，你可以使用引号。

@startuml
usecase UC1 as "You can use
several lines to define your usecase."
@enduml

使用包（Packages）

你可以使用package关键字来组织参与者或用例。

@startuml
package "Some Package" {
  (UseCase1)
  (UseCase2)
}
@enduml

连接参与者和用例

要连接参与者和用例，使用箭头-->。

@startuml
User -> (Start)
User --> (Use the application)
@enduml

扩展和包含

如果一个参与者/用例扩展另一个，你可以使用符号<|--。

@startuml
User <|-- Admin
(Start) <|-- (Use)
@enduml

添加注释

你可以使用note left of，note right of等关键字来定义与单个对象相关的注释。

@startuml
note right of (UseCase1) : this is a note
@enduml

使用Stereotypes

你可以在定义参与者和用例时使用<< >>添加stereotypes。

@startuml
User << Human >>
(UseCase1) << Main >>
@enduml

改变箭头方向和样式

你可以使用内联样式来改变单个箭头的颜色或样式。

@startuml
actor foo
foo --> (bar) : normal
foo --> (bar1) #red : red
@enduml

总结

PlantUML提供了一种简单而高效的方式来创建用例图，通过这些语法规则，我们可以更容易地描述系统的功能需求和参与者交互。