活动图(新语法)

当前活动图(activity diagram)的语法有诸多限制和缺点,比如代码难以维护。

所以从V7947开始提出一种全新的、更好的语法格式和软件实现供用户使用(beta版)。

就像序列图一样,新的软件实现的另一个优点是它不再依赖于Graphviz。

新的语法将会替换旧的语法。然而考虑到兼容性,旧的语法仍被能够使用以确保向前兼容

但是我们鼓励用户使用新的语法格式。

简单活动图

活动标签(activity label)以冒号开始,以分号结束。

文本格式支持creole wiki语法。

活动默认安装它们定义的顺序就行连接。

🎉 Copied!
@startuml
:Hello world;
:This is on defined on
several **lines**;
@enduml

开始/结束

你可以使用关键字startstop表示图示的开始和结束。

🎉 Copied!
@startuml
start
:Hello world;
:This is on defined on
several **lines**;
stop
@enduml

也可以使用 end 关键字。

🎉 Copied!
@startuml
start
:Hello world;
:This is on defined on
several **lines**;
end
@enduml

条件判断

在图示中可以使用关键字ifthenelse设置分支测试。标注文字则放在括号中。

这儿有三种语法:

  • if (...) then (...)

🎉 Copied!
@startuml

start

if (Graphviz 已安装?) then (yes)
  :处理所有\n绘制任务;
else (no)
  :仅处理
  __时序图__ 和 __活动__ 图;
endif

stop

@enduml

  • if (...) is (...) then

🎉 Copied!
@startuml
if (颜色是?) is (<color:red>红色) then
:打印红色;
else 
:打印非红色;
@enduml

  • if (...) equals (...) then

🎉 Copied!
@startuml
if (计数器?) equals (5) then
:打印 5;
else 
:打印非 5;
@enduml

[参考: QA-301]

多项判断(水平布局)

你可以使用 elseif 关键词进行多项判断 (默认情况下, 布局为水平):

🎉 Copied!
@startuml
start
if (条件 A) then (yes)
  :文本 1;
elseif (条件 B) then (yes)
  :文本 2;
  stop
elseif (条件 C) then (yes)
  :文本 3;
elseif (条件 D) then (yes)
  :文本 4;
else (nothing)
  :文本 else;
endif
stop
@enduml

多项判断(垂直布局)

你可以使用命令 !pragma useVerticalIf on 开启多项判断的垂直布局:

🎉 Copied!
@startuml
!pragma useVerticalIf on
start
if (条件 A) then (yes)
  :文本 1;
elseif (条件 B) then (yes)
  :文本 2;
  stop
elseif (条件 C) then (yes)
  :文本 3;
elseif (条件 D) then (yes)
  :文本 4;
else (nothing)
  :文本 else;
endif
stop
@enduml

你可以使用 -P命令行 选项去告诉plantuml程序:

java -jar plantuml.jar -PuseVerticalIf=on

[参考: QA-3931, issue-582]

Switch判断 [switch, case, endswitch]

你可以使用 switch, caseendswitch 关键词在图表中绘制Switch判断.

使用括号表示标注.

🎉 Copied!
@startuml
start
switch (测试?)
case ( 条件 A )
  :Text 1;
case ( 条件 B ) 
  :Text 2;
case ( 条件 C )
  :Text 3;
case ( 条件 D )
  :Text 4;
case ( 条件 E )
  :Text 5;
endswitch
stop
@enduml

条件判断和终止 [kill, detach]

你可以在if判断中终止一个行为.

🎉 Copied!
@startuml
if (条件?) then
  :错误;
  stop
endif
#palegreen:行为;
@enduml

但如果你想在特定行为上停止,你可以使用killdetach关键字:

  • kill

🎉 Copied!
@startuml
if (条件?) then
  #pink:错误;
  kill
endif
#palegreen:行为;
@enduml

[参考. QA-265]

  • detach

🎉 Copied!
@startuml
if (条件?) then
  #pink:错误;
  detach
endif
#palegreen:行为;
@enduml

重复循环

你可以使用关键字repeatrepeatwhile进行重复循环。

🎉 Copied!
@startuml

start

repeat
  :读取数据;
  :生成图片;
repeat while (更多数据?)

stop

@enduml

你同样可以使用一个全局行为作为repeat目标, 在返回循环开始时使用backward关键字插入一个全局行为。

🎉 Copied!
@startuml

start

repeat :foo作为开始标注;
  :读取数据;
  :生成图片;
backward:这是一个后撤行为;
repeat while (更多数据?)

stop

@enduml

打断循环 [break]

你可以使用 break 关键字跟在循环中的某个行为后面打断循环.

🎉 Copied!
@startuml
start
repeat
  :测试某事;
    if (发生错误?) then (没有)
      #palegreen:好的;
      break
    endif
    ->not ok;
    :弹窗 "文本过长错误";
repeat while (某事发生文本过长错误?) is (是的) not (不是)
->//合并步骤//;
:弹窗 "成功!";
stop
@enduml

[参考: QA-6105]

while循环

可以使用关键字whileend while进行while循环。

🎉 Copied!
@startuml

start

while (data available?)
  :read data;
  :generate diagrams;
endwhile

stop

@enduml

还可以在关键字endwhile后添加标注,还有一种方式是使用关键字is

🎉 Copied!
@startuml
while (check filesize ?) is (not empty)
  :read file;
endwhile (empty)
:close file;
@enduml

并行处理 [fork, fork again, end fork, end merge]

你可以使用forkfork againend fork 或者 end merge 等关键字表示并行处理。

fork 示例

🎉 Copied!
@startuml
start
fork
  :行为 1;
fork again
  :行为 2;
end fork
stop
@enduml

fork 和合并示例

🎉 Copied!
@startuml
start
fork
  :行为 1;
fork again
  :行为 2;
end merge
stop
@enduml

[参考: QA-5320]

🎉 Copied!
@startuml
start
fork
  :行为 1;
fork again
  :行为 2;
fork again
  :行为 3;
fork again
  :行为 4;
end merge
stop
@enduml

🎉 Copied!
@startuml
start
fork
  :行为 1;
fork again
  :行为 2;
  end
end merge
stop
@enduml

[参考: QA-13731]

end fork 标注 (或 UML 连接规范):

🎉 Copied!
@startuml
start
fork
  :行为 A;
fork again
  :行为 B;
end fork {或}
stop
@enduml

🎉 Copied!
@startuml
start
fork
  :行为 A;
fork again
  :行为 B;
end fork {和}
stop
@enduml

[参考: QA-5346]

其他示例

🎉 Copied!
@startuml

start

if (多进程处理?) then (是)
  fork
    :进程 1;
  fork again
    :进程 2;
  end fork
else (否)
  :逻辑 1;
  :逻辑 2;
endif

@enduml

分割处理

分割

你可以使用 split, split againend split 关键字去表达分割处理

🎉 Copied!
@startuml
start
split
   :A;
split again
   :B;
split again
   :C;
split again
   :a;
   :b;
end split
:D;
end
@enduml

输入分割 (多个入口)

你可以使用包含 hidden 指令的箭头去制造一个输入分割 (多入口):

🎉 Copied!
@startuml
split
   -[hidden]->
   :A;
split again
   -[hidden]->
   :B;
split again
   -[hidden]->
   :C;
end split
:D;
@enduml

🎉 Copied!
@startuml
split
   -[hidden]->
   :A;
split again
   -[hidden]->
   :a;
   :b;
split again
   -[hidden]->
   (Z)
end split
:D;
@enduml

[参考: QA-8662]

输出分割 (多个结束点)

你可以使用 killdetach 去制造一个输出分割 (多个结束点):

🎉 Copied!
@startuml
start
split
   :A;
   kill
split again
   :B;
   detach
split again
   :C;
   kill
end split
@enduml

🎉 Copied!
@startuml
start
split
   :A;
   kill
split again
   :b;
   :c;
   detach
split again
   (Z)
   detach
split again
   end
split again
   stop
end split
@enduml

注释

文本格式支持creole wiki语法。

一个注释可以是浮动的,使用 floating 关键词。

🎉 Copied!
@startuml

start
:foo1;
floating note left: 这是一个注释
:foo2;
note right
  这个注释是
  //多行的//, 同样可以
  包含 <b>HTML</b> 文本.
  ====
  * 调用函数 ""foo()"" 是被禁止的。
end note
stop

@enduml

您可以添加返回行为的注释:

🎉 Copied!
@startuml
start
repeat :输入数据;
:提交;
backward :警告;
note right: 备注
repeat while (校验通过?) is (否) not (是)
stop
@enduml

[参考: QA-11788]

您可以添加分区活动的注释:

🎉 Copied!
@startuml
start
partition "**处理** HelloWorld" {
    note
        这是我的注释
        ----
        //Creole 测试//
    end note
    :Ready;
    :HelloWorld(i)>
    :Hello-Sent;
}
@enduml

[参考: QA-2398]

改变颜色

你可以为一些活动指定颜色

🎉 Copied!
@startuml

start
:开始处理;
#HotPink:读取配置文件
这些文件应该在此处编辑;
#AAAAAA:结束处理;

@enduml

你通用可以使用 渐变色.

🎉 Copied!
@startuml
start
partition #red/white test分片 {
        #blue\green:test活动;
}
@enduml

[参考: QA-4906]

无箭头连接线

您可以使用 skinparam ArrowHeadColor none 参数来表示仅使用线条连接活动,而不带箭头。

🎉 Copied!
@startuml
skinparam ArrowHeadColor none
start
:Hello world;
:This is on defined on
several **lines**;
stop
@enduml

🎉 Copied!
@startuml
skinparam ArrowHeadColor none
start
repeat :Enter data;
:Submit;
backward :Warning;
repeat while (Valid?) is (No) not (Yes)
stop
@enduml

箭头

使用->标记,你可以给箭头添加文字或者修改箭头颜色

同时,你也可以选择点状 (dotted),条状(dashed),加粗或者是隐式箭头

🎉 Copied!
@startuml
:foo1;
-> You can put text on arrows;
if (test) then
  -[#blue]->
  :foo2;
  -[#green,dashed]-> The text can
  also be on several lines
  and **very** long...;
  :foo3;
else
  -[#black,dotted]->
  :foo4;
endif
-[#gray,bold]->
:foo5;
@enduml

连接器(Connector)

你可以使用括号定义连接器。

🎉 Copied!
@startuml
start
:Some activity;
(A)
detach
(A)
:Other activity;
@enduml

连接器颜色

你可以在连接器上增加 颜色

🎉 Copied!
@startuml
start
:下面的连接器
应该是蓝色;
#blue:(B)
:下一个连接器应该
看起来应该是
深绿色;
#green:(G)
stop
@enduml

[参考. QA-10077]

组合(grouping)

通过定义分组(group),你可以把多个活动分组。

🎉 Copied!
@startuml
start
group 初始化分组 
    :read config file;
    :init internal variable;
end group
group 运行分组
    :wait for user interaction;
    :print information;
end group

stop
@enduml

分区

通过定义分区(partition),你可以把多个活动组合(group)在一起:

🎉 Copied!
@startuml
start
partition 初始化分区 {
    :read config file;
    :init internal variable;
}
partition 运行分区 {
    :wait for user interaction;
    :print information;
}

stop
@enduml

这里同样可以改变分区颜色 color:

🎉 Copied!
@startuml
start
partition #lightGreen "Input Interface" {
    :read config file;
    :init internal variable;
}
partition Running {
    :wait for user interaction;
    :print information;
}
stop
@enduml

[参考: QA-2793]

同样可以添加一个 链接 到分区:

🎉 Copied!
@startuml
start
partition "[[http://plantuml.com partition_name]]" {
    :read doc. on [[http://plantuml.com plantuml_website]];
    :test diagram;
}
end
@enduml

[参考: QA-542]

分组, 分区, 包, 矩形 或 卡片式

你可以分组活动通过定义:
  • group;
  • partition;
  • package;
  • rectangle;
  • card.

🎉 Copied!
@startuml
start
group 分组
  :Activity;
end group
floating note: 分组备注

partition 分区 {
  :Activity;
}
floating note: 分区备注

package 包 {
  :Activity;
}
floating note: 包备注

rectangle 矩形 {
  :Activity;
}
floating note: 矩形备注

card 卡片式 {
  :Activity;
}
floating note: 卡片式备注
end
@enduml

泳道(Swimlanes)

你可以使用管道符|来定义泳道。

还可以改变泳道的颜色

🎉 Copied!
@startuml
|Swimlane1|
start
:foo1;
|#AntiqueWhite|Swimlane2|
:foo2;
:foo3;
|Swimlane1|
:foo4;
|Swimlane2|
:foo5;
stop
@enduml

你可以在泳道中增加 if 判断或 repeatwhile 循环.

🎉 Copied!
@startuml
|#pink|Actor_For_red|
start
if (color?) is (red) then
#pink:**action red**;
:foo1;
else (not red)
|#lightgray|Actor_For_no_red|
#lightgray:**action not red**;
:foo2;
endif
|Next_Actor|
#lightblue:foo3;
:foo4;
|Final_Actor|
#palegreen:foo5;
stop
@enduml

你同样可以在泳道中增加别名,使用 alias 语法:

  • |[#<color>|]<swimlane_alias>| <swimlane_title>

🎉 Copied!
@startuml
|#palegreen|f| fisherman
|c| cook
|#gold|e| eater
|f|
start
:go fish;
|c|
:fry fish;
|e|
:eat fish;
stop
@enduml

[参考: QA-2681]

分离(detach)

可以使用关键字detachkill移除箭头。

  • detach

🎉 Copied!
@startuml
 :start;
 fork
   :foo1;
   :foo2;
 fork again
   :foo3;
   detach
 endfork
 if (foo4) then
   :foo5;
   detach
 endif
 :foo6;
 detach
 :foo7;
 stop
@enduml

  • kill

🎉 Copied!
@startuml
 :start;
 fork
   :foo1;
   :foo2;
 fork again
   :foo3;
   kill
 endfork
 if (foo4) then
   :foo5;
   kill
 endif
 :foo6;
 kill
 :foo7;
 stop
@enduml

特殊领域语言(SDL)

通过修改活动标签最后的分号分隔符(;),可以为活动设置不同的形状。
  • |
  • <
  • >
  • /
  • ]
  • }

🎉 Copied!
@startuml
:Ready;
:next(o)|
:Receiving;
split
 :nak(i)<
 :ack(o)>
split again
 :ack(i)<
 :next(o)
 on several line|
 :i := i + 1]
 :ack(o)>
split again
 :err(i)<
 :nak(o)>
split again
 :foo/
split again
 :i > 5}
stop
end split
:finish;
@enduml

一个完整的例子

🎉 Copied!
@startuml

start
:ClickServlet.handleRequest();
:new page;
if (Page.onSecurityCheck) then (true)
  :Page.onInit();
  if (isForward?) then (no)
    :Process controls;
    if (continue processing?) then (no)
      stop
    endif

    if (isPost?) then (yes)
      :Page.onPost();
    else (no)
      :Page.onGet();
    endif
    :Page.onRender();
  endif
else (false)
endif

if (do redirect?) then (yes)
  :redirect process;
else
  if (do forward?) then (yes)
    :Forward request;
  else (no)
    :Render page template;
  endif
endif

stop

@enduml

判断的样式

inside 样式 (默认)

🎉 Copied!
@startuml
skinparam conditionStyle inside
start
repeat
  :act1;
  :act2;
repeatwhile (<b>end)
:act3;
@enduml

🎉 Copied!
@startuml
start
repeat
  :act1;
  :act2;
repeatwhile (<b>end)
:act3;
@enduml

Diamond 样式

🎉 Copied!
@startuml
skinparam conditionStyle diamond
start
repeat
  :act1;
  :act2;
repeatwhile (<b>end)
:act3;
@enduml

InsideDiamond (或 Foo1) 样式

🎉 Copied!
@startuml
skinparam conditionStyle InsideDiamond
start
repeat
  :act1;
  :act2;
repeatwhile (<b>end)
:act3;
@enduml

🎉 Copied!
@startuml
skinparam conditionStyle foo1
start
repeat
  :act1;
  :act2;
repeatwhile (<b>end)
:act3;
@enduml

[参考: QA-1290 and #400]

判断的结束样式

Diamond 样式 (默认)

  • With one branch

🎉 Copied!
@startuml
skinparam ConditionEndStyle diamond
:A;
if (decision) then (yes)
    :B1;
else (no)
endif
:C;
@enduml

  • 两个分支 (B1, B2)

🎉 Copied!
@startuml
skinparam ConditionEndStyle diamond
:A;
if (decision) then (yes)
    :B1;
else (no)
    :B2;
endif
:C;
@enduml
@enduml

水平线 (hline) 样式

  • 一个分

🎉 Copied!
@startuml
skinparam ConditionEndStyle hline
:A;
if (decision) then (yes)
    :B1;
else (no)
endif
:C;
@enduml

  • 两个分支 (B1, B2)

🎉 Copied!
@startuml
skinparam ConditionEndStyle hline
:A;
if (decision) then (yes)
    :B1;
else (no)
    :B2;
endif
:C;
@enduml
@enduml

[Ref. QA-4015]

使用 sytle 定义 (全局) 样式

无样式 (默认)

🎉 Copied!
@startuml
start
:init;
-> test of color;
if (color?) is (<color:red>red) then
:print red;
else 
:print not red;
note right: no color
endif
partition End {
:end;
}
-> this is the end;
end
@enduml

有样式

你可以使用 style 节点去定义样式然后改变渲染。

🎉 Copied!
@startuml
<style>
activityDiagram {
  BackgroundColor #33668E
  BorderColor #33668E
  FontColor #888
  FontName arial

  diamond {
    BackgroundColor #ccf
    LineColor #00FF00
    FontColor green
    FontName arial
    FontSize 15
  }
  arrow {
    FontColor gold
    FontName arial
    FontSize 15
  }
  partition {
    LineColor red
    FontColor green
    RoundCorner 10
    BackgroundColor PeachPuff
  }
  note {
    FontColor Blue
    LineColor Navy
    BackgroundColor #ccf
  }
}
document {
   BackgroundColor transparent
}
</style>
start
:init;
-> test of color;
if (color?) is (<color:red>red) then
:print red;
else 
:print not red;
note right: no color
endif
partition End {
:end;
}
-> this is the end;
end
@enduml