参考链接

活动图

行为

活动标签以: 开始，以; 结束。文本格式可以使用克里奥尔语的维基语法。它们的定义顺序是隐性链接的。

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

简单的行动

当然，还可以使用别的符号作为开头：

-

@startuml
- Action 1 
- Action 2 
- Action 3 
@enduml

使用-号

一级

@startuml
* Action 1
* Action 2
* Action 3
@enduml

使用*号作为单级

多级

@startuml
<style>
element {MinimumWidth 150}
</style>
* Action 1
** Sub-Action 1.1
** Sub-Action 1.2
*** Sub-Action 1.2.1
*** Sub-Action 1.2.2
* Action 2
@enduml

使用*号作为多级

开始/停止/结束

你可以使用start 和stop 关键字来表示一个图的开始和结束。

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

使用stop作为停止

你也可以使用end 关键字。

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

使用end作为结束

分支

if-else

你可以使用if,then, break和else 关键词来在你的图表中放入测试。标签可以用圆括号提供。

有3种语法可供选择。

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

@startuml

start

if (Graphviz installed?) then (yes)
  :process all\ndiagrams;
else (no)
  :process only
  __sequence__ and __activity__ diagrams;
endif

stop

@enduml

第一种选择语法

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

@startuml
if (color?) is (<color:red>red) then
:print red;
else 
:print not red;
@enduml

第二种选择语法

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

@startuml
if (counter?) equals (5) then
:print 5;
else 
:print not 5;
@enduml

第三种选择语法

分支可以使用不同的排布方式：

水平模式（默认水平模式）

@startuml
start
if (condition A) then (yes)
  :Text 1;
elseif (condition B) then (yes)
  :Text 2;
  stop
(no) elseif (condition C) then (yes)
  :Text 3;
(no) elseif (condition D) then (yes)
  :Text 4;
else (nothing)
  :Text else;
endif
stop
@enduml

水平模式

垂直模式：你可以使用!pragma useVerticalIf on 命令，让图处于垂直模式。

@startuml
start
if (condition A) then (yes)
  :Text 1;
elseif (condition B) then (yes)
  :Text 2;
  stop
(no) elseif (condition C) then (yes)
  :Text 3;
(no) elseif (condition D) then (yes)
  :Text 4;
else (nothing)
  :Text else;
endif
stop
@enduml

竖直模式

你可以使用-P command-line[命令行]选项来指定pragma。

1	java -jar plantuml.jar -PuseVerticalIf=on

switch

Switch判断可以使用你可以使用 switch, case 和 endswitch 关键词在图表中绘制Switch判断.使用括号表示标注.

@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

switch分支语句

终止

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

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

条件语句的终止

但如果你想在特定行为上停止，你可以使用kill 或 detach关键字:

kill

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

kill关键字

detach

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

detach关键字

GoTo

Goto和标签处理 [label, goto]

⚠ 目前只是实验性的 🚧

你可以使用label 和goto 关键词来表示Goto处理，其中：

label <label_name>
goto <label_name>

@startuml
title Point two queries to same activity\nwith `goto`
start
if (Test Question?) then (yes)
'space label only for alignment
label sp_lab0
label sp_lab1
'real label
label lab
:shared;
else (no)
if (Second Test Question?) then (yes)
label sp_lab2
goto sp_lab1
else
:nonShared;
endif
endif
:merge;
@enduml

GOTO关键字

循环

基础循环

重复循环：你可以使用关键字repeat和repeatwhile进行重复循环。

@startuml

start

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

stop

@enduml

repeat关键字

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

@startuml

start

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

stop

@enduml

backward关键字

跳出

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

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

跳出循环

while

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

@startuml

start

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

stop

@enduml

while关键字

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

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

while中使用is关键字

如果你使用 +detach+ 来形成一个无限循环, 那么你可能需要使用 +-[hidden]->+ 来隐藏一些不完整的箭头。

@startuml
:Step 1;
if (condition1) then
  while (loop forever)
   :Step 2;
  endwhile
  -[hidden]->
  detach
else
  :end normally;
  stop
endif
@enduml

无限循环中隐藏不完整箭头

并行

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

fork

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

fork关键字

fork合并

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

fork的合并

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

多fork合并

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

多分支结束

end fork标注

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

结束fork的或操作

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

结束fork的与操作

@startuml

start

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

@enduml

frok和串行合并

分割

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

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

split关键字

输入分割

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

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

输入分割隐藏输入箭头

输出分割

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

输出分割

注释

文本格式可以使用克里奥尔维基语法。可以使用floating 关键字浮动注释。

@startuml

start
:foo1;
floating note left: This is a note
:foo2;
note right
  This note is on several
  //lines// and can
  contain <b>HTML</b>
  ====
  * Calling the method ""foo()"" is prohibited
end note
stop

@enduml

浮动注释

您可以为后向活动添加注释：

@startuml
start
repeat :Enter data;
:Submit;
backward :Warning;
note right: Note
repeat while (Valid?) is (No) not (Yes)
stop
@enduml

普通注释

可以添加分区活动注释：

@startuml
start
partition "**process** HelloWorld" {
    note
        This is my note
        ----
        //Creole test//
    end note
    :Ready;
    :HelloWorld(i)>
    :Hello-Sent;
}
@enduml

分区注释

箭头

无箭头连接线

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


	`@startuml skinparam ArrowHeadColor none start :Hello world; :This is on defined on several lines; stop @enduml`


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

箭头

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

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


	`@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`

Multiple colored arrow

You can use multiple colored arrow.

@startuml skinparam colorArrowSeparationSpace 1 start -[#red;#green;#orange;#blue]-> if(a?)then(yes) -[#red]-> :activity; -[#red]-> if(c?)then(yes) -[#maroon,dashed]-> else(no) -[#red]-> if(b?)then(yes) -[#maroon,dashed]-> else(no) -[#blue,dashed;dotted]-> :do a; -[#red]-> :do b; -[#red]-> endif -[#red;#maroon,dashed]-> endif -[#red;#maroon,dashed]-> elseif(e?)then(yes) -[#green]-> if(c?)then(yes) -[#maroon,dashed]-> else(no) -[#green]-> if(d?)then(yes) -[#maroon,dashed]-> else(no) -[#green]-> :do something; <<continuous>> -[#green]-> endif -[#green;#maroon,dashed]-> partition dummy { :some function; } -[#green;#maroon,dashed]-> endif -[#green;#maroon,dashed]-> elseif(f?)then(yes) -[#orange]-> :activity; <<continuous>> -[#orange]-> else(no) -[#blue,dashed;dotted]-> endif stop @enduml


	@startuml skinparam colorArrowSeparationSpace 1 start -[#red;#green;#orange;#blue]-> if(a?)then(yes) -[#red]-> :activity; -[#red]-> if(c?)then(yes) -[#maroon,dashed]-> else(no) -[#red]-> if(b?)then(yes) -[#maroon,dashed]-> else(no) -[#blue,dashed;dotted]-> :do a; -[#red]-> :do b; -[#red]-> endif -[#red;#maroon,dashed]-> endif -[#red;#maroon,dashed]-> elseif(e?)then(yes) -[#green]-> if(c?)then(yes) -[#maroon,dashed]-> else(no) -[#green]-> if(d?)then(yes) -[#maroon,dashed]-> else(no) -[#green]-> :do something; <<continuous>> -[#green]-> endif -[#green;#maroon,dashed]-> partition dummy { :some function; } -[#green;#maroon,dashed]-> endif -[#green;#maroon,dashed]-> elseif(f?)then(yes) -[#orange]-> :activity; <<continuous>> -[#orange]-> else(no) -[#blue,dashed;dotted]-> endif stop @enduml

[Ref. QA-4411]

连接器(Connector)

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


	`@startuml start :Some activity; (A) detach (A) :Other activity; @enduml`

WARNING

This translation need to be updated.

WARNING

连接器颜色

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


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

[参考. QA-10077]

[Ref. QA-19975]

WARNING

This translation need to be updated.

WARNING

组合(grouping)

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


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

分区

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


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

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


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

[参考: QA-2793]

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


	`@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.


	`@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)

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

还可以改变泳道的颜色。


	`@startuml \|Swimlane1\| start :foo1; \|#AntiqueWhite\|Swimlane2\| :foo2; :foo3; \|Swimlane1\| :foo4; \|Swimlane2\| :foo5; stop @enduml`

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


	`@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>


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

[参考: QA-2681]

分离(detach)

可以使用关键字detach 或 kill移除箭头。

detach


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

kill


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

SDL（规范和描述语言）

SDL 形状名称表


名称	旧语法	定型语法
输入	`<`	`<<input>>`
输出	`>`	`<<output>>`
程序	`\|`	`<<procedure>>`
加载	`\`	`<<load>>`
保存	`/`	`<<save>>`
连续	`}`	`<<continuous>>`
任务	`]`	`<<task>>`

[Ref.QA-11518,GH-1270]

SDL using final separator (Deprecated form)

通过更改最终; separator，可以为活动设置不同的渲染：

|
<
>
/
\\
]
}


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

使用正态分隔符和立体原型的 SDL（当前正式形式）


	`@startuml start :SDL Shape; :input; <<input>> :output; <<output>> :procedure; <<procedure>> :load; <<load>> :save; <<save>> :continuous; <<continuous>> :task; <<task>> end @enduml`


	`@startuml :Ready; :next(o); <<procedure>> :Receiving; split :nak(i); <<input>> :ack(o); <<output>> split again :ack(i); <<input>> :next(o) on several lines; <<procedure>> :i := i + 1; <<task>> :ack(o); <<output>> split again :err(i); <<input>> :nak(o); <<output>> split again :foo; <<save>> split again :bar; <<load>> split again :i > 5; <<continuous>> stop end split :finish; @enduml`

WARNING

This translation need to be updated.

WARNING

UML (Unified Modeling Language) Shape

Table of UML Shape Name


Name	Stereotype syntax
ObjectNode	`<<object>>`
ObjectNode typed by signal	`<<objectSignal>>` or `<<object-signal>>`
AcceptEventAction without TimeEvent trigger	`<<acceptEvent>>` or `<<accept-event>>`
AcceptEventAction with TimeEvent trigger	`<<timeEvent>>` or `<<time-event>>`
SendSignalAction SendObjectAction with signal type	`<<sendSignal>>` or `<<send-signal>>`
Trigger	`<<trigger>>`

[Ref. GH-2185]

UML Shape Example using Stereotype


	`@startuml :action; :object; <<object>> :ObjectNode typed by signal; <<objectSignal>> :AcceptEventAction without TimeEvent trigger; <<acceptEvent>> :SendSignalAction; <<sendSignal>> :SendObjectAction with signal type; <<sendSignal>> :Trigger; <<trigger>> :\t\t\t\t\t\tAcceptEventAction \t\t\t\t\t\twith TimeEvent trigger; <<timeEvent>> :an action; @enduml`

[Ref. GH-2185, QA-16558, GH-1659]

一个完整的例子

@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 样式 (默认)


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


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

Diamond 样式


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

InsideDiamond (或 Foo1) 样式


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


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

[参考: QA-1290 and #400]

判断的结束样式

Diamond 样式 (默认)

With one branch


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

两个分支 (B1, B2)


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

水平线 (hline) 样式

一个分


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

两个分支 (B1, B2)


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

[Ref. QA-4015]

使用 sytle 定义 (全局) 样式

无样式 (默认)


	`@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 节点去定义样式然后改变渲染。

@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

Emoji as action

You can use emoji as action, with the stereotype <<icon>>:


	`@startuml while (<:cloud_with_rain:>) :<:umbrella:>; <<icon>> endwhile -<<icon>><:closed_umbrella:> @enduml`

参考链接

活动图

行为

开始/停止/结束

分支

if-else

switch

终止

GoTo

循环

基础循环

跳出

while

并行

fork

fork合并

end fork标注

分割

输入分割

输出分割

注释

箭头

分区

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

SDL 形状名称表

SDL using final separator (Deprecated form)

使用正态分隔符和立体原型的 SDL（当前正式形式）

Table of UML Shape Name

UML Shape Example using Stereotype

inside 样式 (默认)

Diamond 样式

InsideDiamond (或 Foo1) 样式

Diamond 样式 (默认)

水平线 (hline) 样式

无样式 (默认)

有样式

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