1.1 简单示例

符号	说明
->	表示参与者之间传递的消息，而不必显示地声明参与者
<-	同->，可提高阅读性
–>	绘制虚线箭头
<–	同<–，可提高阅读性

@startuml
用户 -> 认证中心: 登录操作
认证中心 -> 缓存: 存放(key=token+ip,value=token)token
用户 <- 认证中心 : 认证成功返回token
用户 -> 认证中心: 下次访问头部携带token认证
认证中心 <- 缓存: key=token+ip获取token
其他服务 <- 认证中心: 存在且校验成功则跳转到用户请求的其他服务
其他服务 -> 用户: 信息
@enduml

1.2 声明参与者

• 使用participant关键字来声明一个参与者，可以使你对参与者做出更多控制。
• 关键字participant用于改变参与者的先后顺序。
• 也可以使用下面的关键字来声明参与者，这会改变参与者的外观：

参与者	说明
participant	参与者
actor	角色
boundary	边界
control	控制
entity	实体
database	数据库
collections	集合
queue	队列

@startuml
participant particaipant    as  Foo
actor       actor           as  Foo1
boundary    boundary        as  Foo2
control     control         as  Foo3
entity      entity          as  Foo4
database    database        as  Foo5
collections collections     as  Foo6
queue       queue           as  Foo7Foo -> Foo1 : To actor
Foo -> Foo2 : To boundary
Foo -> Foo3 : To control
Foo -> Foo4 : To entity
Foo -> Foo5 : To database
Foo -> Foo6 : To collections
Foo -> Foo7 : To queueß
@enduml

• 关键字as可以用于重命名参与者
• 也可以使用RGB值或颜色名称修改actor或者参与者的背影颜色

@startuml
'actor 和 participant 只在外观上有区别'
actor       Bob #red
participant Alice
participant "很长很长很长\n的名字" as L #99FF99
/' 也可以这样声明：participant L as "很长很长很长\n的名字" #99FF99
'/Alice  -> Bob : 认证请求
Bob -> Alice : 认证响应
Bob -> L : 记录事务日志
@enduml

• 使用关键字order自定义顺序来打印参与者

@startuml
participant 最后 order 30
participant 中间 order 20
participant 首个 order 10
@enduml

1.3 在参与者中使用非字母符号

• 使用引号定义参与者，也可以使用as给参与者定义别名

@startuml
Alice -> "Bob()" : Hello
"Bob()" -> "This is very\nlong" as Long
' You can also declare:
' "Bob()" -> Long as "This is very\nlong"
Long --> "Bob()" : ok
@enduml

1.4 参与者给自己发信息

• 参与者可以给自己发送信息，消息文字可以换行显示

@startuml
Alice -> Alice : This is a signal to self. \nIt also demonstrates\nmultiline \ntext
@enduml

1.5 文本对齐

• 让文本显示在箭头下面

@startuml
skinparam responseMessageBelowArrow true '文本显示在箭头下面
Bob -> Alice : hello
Alice -> Bob : ok
@enduml

1.6 修改箭头的样式

• 表示一条丢失的消息：末尾加 x
• 让箭头只有上半部分或者只有下半部分：将 < 和 > 换成 \ 和 / ——
• 细箭头：将箭头标记写两次（如>>或//）
• 虚线箭头：用 – 替代 -
• 箭头末尾加圆圈：->o
• 双向箭头：<->

@startuml
Bob ->x Alice
Bob -> Alice
Bob ->> Alice
Bob -\ Alice 
Bob -/ Alice
Bob -\\ Alice
Bob -// Alice
Bob ->o Alice
Bob o\\- Alice
Bob <-> Alice
Bob <->o Alice
@enduml

1.7 修改箭头颜色

• 可以用以下符号修改箭头颜色

@startuml
Bob -[#red]> Alice: Hello
Alice -[#0000FF]-> Bob : ok
@enduml

1.8 对消息序列编号

• 关键字 autonumber 用于自动对消息编号

@startuml
autonumber
Bob -> Alice : Authentication Request
Alice -> Bob : Authentication Response
@enduml

• autonumber //start// 可用于指定编号的初始值
• autonumber //start// //increment// 可以同时指定编号的初始值和每次增加的值

@startuml
autonumber
Bob -> Alice : Authentication Request
Bob <- Alice : Authentication Responseautonumber 15
Bob -> Alice : Another authentication Request
Bob <- Alice : Another authentication Responseautonumber 40 10
Bob -> Alice : Yet another authentication Request
Bob <- Alice : Yet another authentication Response
@enduml

• 可以在双引号内指定编号的格式：（0 表示数字； ## 也表示数字，但默认值为0）。
• 也可以使用HTML标签来制定格式

@startuml
autonumber "<b>[000]"
Bob -> Alice : Authentication Request
Bob <- Alice : Authentication Responseautonumber 15 "<b>(<u>##</u>)"
Bob -> Alice : Another authentication Request
Bob <- Alice : Another authentication Responseautonumber 40 10 "<font color=red><b>Message 0 "
Bob -> Alice : Yet another authentication Request
Bob <- Alice : Yet another authentication Response
@enduml

• 使用autonumber stop和`autonumber resume //increment// //format//来表示暂停或继续使用自动编号

@startuml
autonumber 10 10 "<b>[000]"
Bob -> Alice : Authentication Request
Bob <- Alice : Authentication Responseautonumber stop
Bob -> Alice : dummyautonumber resume "<font color=red><b>Message 0 "
Bob -> Alice : Yet another authentication Request
Bob <- Alice : Yet another authentication Responseautonumber stop
Bob -> Alice : dummyautonumber resume 1 "<font color=blue><b>Message 0 "
Bob -> Alice : Yet another authentication Request
Bob <- Alice : Yet another authentication Response
@enduml

1.9 页面标题、页眉、页脚

• 使用title关键字添加标题
• 使用header关键字添加页眉
• 使用footer关键字添加页脚

@startuml
header Page Header
footer Page %page% of %lasepage%title Example TitleAlice -> Bob : Message 1
Alice -> Bob : Message 2
@enduml

1.10 分割示意图

• 关键字newpage用于把一张图分割成多张
• 在newpage之后加文字，作为新的示意图和标题
• 这样就能很方便地在Word中将长图分多页打印

@startuml
Alice -> Bob : message 1
Alice -> Bob : message 2newpageAlice -> Bob : message 3
Alice -> Bob : message 4newpage A title for the\nlast page
Alice -> Bob : message 5
Alice -> Bob : message 6@enduml

1.11 组合消息

• 可以通过以下关键词组合消息：

关键字	说明
alt/else	成功情况/失败情况/另一种失败的情况
opt
loop	循环
par
break
critical
group

@startuml
Alice -> Bob: 认证请求
alt 成功情况Bob -> Alice: 认证接受
else 失败原因一Bob -> Alice: 认证失败group 我自己的标签Alice -> Log : 开始记录攻击日志loop 1000次Alice -> Bob: DNS 攻击endAlice -> Log : 结束记录攻击日志end
else 失败原因二Bob -> Alice: 请重复
end
@enduml

1.12 次级分组标签

• 对于group而言，在标头片的[和]之间可以显示次级文本或标签

@startuml
Alice -> Bob : 认证请求
Bob -> Alice : 认证失败
group 我自己的标签 [我自己的标签2]Alice -> Log : 开始记录攻击日志loop 1000次Alice -> Bob : DNS攻击endAlice -> Log : 停止记录攻击日志
end
@enduml

1.13 给消息添加注释

• 在消息后面添加note left或者note right添加注释
• 也可以通过end node添加多行注释

@startuml
Alice -> Bob : hello
note left : this is a first nodeBob -> Alice : ok
note right : this is another nodeBob -> Bob : I am thinking
note left
a note
can also be defined
on several lines
end note  
@enduml