New! Render PlantUML diagrams directly inside GitHub
with our official browser extension —
No server. No tokens. No tracking. Zero permissions but clipboard. —
Try it out and let us know what you think!
用例图
用例图展示外部参与者如何与系统交互:谁做什么,以及系统提供哪些功能。它从高层次呈现功能需求,在设计初期对齐各方认识时尤为有用。 在 PlantUML 中,您用文本描述参与者、用例以及它们之间的关系,图形会自动生成。- 文本输入,图形输出。 用几行代码定义参与者、用例和关系。
- 易于重构。 重命名一个参与者或移动一个用例,只需修改一行文本。
- 融入您的代码仓库。 图与所记录的代码并排存放,纳入版本管理。
用例
用例是用小括号括起来的(因为两个
小括号看起来像一个椭圆)。
你也可以用usecase 关键字来定义一个
用例。
你可以用as 关键字来定义一个别名。
这个别名将在以后定义关系时使用。
角色
定义一个角色的名字被括在冒号之间。
你也可以使用actor 关键字来定义一个行为体。
一个别名可以使用as 关键字来指定,并且可以在以后代替行为体的名称,例如在定义关系时使用。
你可以从下面的例子中看到,角色的定义是可选的。
改变角色的样式
可以将角色的样式从默认的火柴人改成:
- 用户头像样式:
skinparam actorStyle awesome - 透明人样式:
skinparam actorStyle hollow
火柴人 默认
用户头像
透明人
用例描述
如果想定义跨越多行的用例描述,可以用双引号将其裹起来。
还可以使用这些分隔符:
--(横线)..(虚线)==(双横线)__(下划线)
WARNING
This translation need to be updated. WARNING
使用包
您可以一使用包来对角色或用例进行分组。
rectangle来改变包的外观。
基础示例
用箭头-->连接角色和用例。
横杠-越多,箭头越长。
通过在箭头定义的后面加一个冒号及文字的方式来添加标签。
在这个例子中,User并没有定义,而是直接拿来当做一个角色使用。
继承
如果一个角色或者用例继承于另一个,那么可以用<|--符号表示。
使用注释
可以用note left of , note right of ,
note top of , note bottom of等关键字给一个对象添加注释。
注释还可以通过note关键字来定义,然后用..连接其他对象。
构造类型
用 <<
和 >> 来定义角色或者用例的构造类型。
改变箭头方向
默认情况下,类之间的链接有两个破折号-- ,并且是垂直方向的。
可以通过像这样放一个破折号(或点)来使用水平链接。
left,right,up
或down 关键字来改变箭头方向。
-d- ,而不是
-down- )
或两个第一个字符(-do-)。
请注意,你不应该滥用这个功能:Graphviz通常在没有
调整的情况下给出良好的结果。
并使用 left to right direction参数。
分割图示
用newpage关键字将图示分解为多个页面。
从左向右方向
默认从上往下构建图示。
left to right direction命令改变图示方向。
显示参数
用skinparam改变字体和颜色。
可以在如下场景中使用:
你也可以给构造的角色和用例指定特殊颜色和字体。
WARNING
This translation need to be updated. WARNING
完整样例
业务用例
你可以添加/ 来制作业务用例。
业务用例
商业行为者
改变箭头的颜色和样式(内联样式)
你可以使用以下的内联式符号改变单个箭头的颜色或样式。
#color;line.[bold|dashed|dotted];text:color
改变元素的颜色和样式(内联样式)
你可以用以下符号改变单个元素的颜色或样式。
#[color|back:color];line:color;line.[bold|dashed|dotted];text:color
显示 JSON 数据