Sequence diagram

Peponi │ 1/8/2025 │ 21m

PlantUML

SyntaxUMLSequence diagram

Sequence diagram

1/8/2025

21m

Peponi

PlantUML

SyntaxUMLSequence diagram

1. Introduction

위 그림과 같이, 정해진 흐름을 따라 그려진 다이어그램을 시퀀스 다이어그램이라 한다. 시퀀스 다이어그램의 구성요소는 아래와 같다.

객체
상호작용 (시퀀스)

시퀀스 다이어그램을 통해 아래 항목 등을 파악할 수 있다.

작업 항목
객체간 관계
각 객체의 작업 순서 및 라이프타임
$\vdots$

2. 기본 사용법

객체를 선언한 후, ->, --> 등의 시퀀스를 이용해 다이어그램을 그린다.

@startuml
 
participant A
participant B
 
A->B: Hello world!
A<--B: Hello!
 
@enduml

3. 세부 사용법

3.1. 객체 사용법

3.1.1. 객체 선언

@startuml
 
participant P
actor A
boundary B
control C 
entity E
database D
collections CO
queue Q
 
@enduml

3.1.2. 객체 활용

3.1.2.1. 객체 이름에 특수문자 삽입

쌍따옴표 " " 사용하여 지정

@startuml
 
participant "P()" as p
 
@enduml

3.1.2.2. 객체 별칭 지정

as 사용하여 지정

@startuml
 
participant Participant as p
actor Actor as a
 
p -> a : hello
 
@enduml

3.1.2.3. 객체 순서 지정

order n 사용하여 지정

@startuml
 
participant P order 3
actor A order 1
boundary B order 2
 
@enduml

3.1.2.4. 객체 색상

#colorname or #colorcode 사용하여 지정

@startuml
 
participant P #mediumseagreen
actor A #magenta
boundary B #13ab32
 
@enduml

3.1.2.5. 객체 세부 선언

대괄호 [ ] 사용하여 지정

@startuml
 
actor A [
    =Upper
    ----
    ""Lower""
]
 
@enduml

3.2. 시퀀스 사용법

3.2.1. 시퀀스 선언

@startuml
 
a -> b : message
a --> b
a <-> b
a ->x b
a ->o b
a -\ b
a -/ b
a ->> b
a -\\ b
a -// b
a -> a
a ->(20) b : Slanted
 
?-> b : Short incoming
[-> b : Long incoming
a ->? : Short outgoing
a ->] : Long outgoing
 
a-[hidden]>b:Make it very long long long long 
@enduml

3.2.2. 시퀀스 활용

3.2.2.1. 시퀀스 색상

#colorname or #colorcode 사용하여 지정

@startuml
 
a -[#cyan]> b : Change by name
a -[#1204fb]> b : Change by code
 
@enduml

3.2.2.2. 여러 줄 메시징

\n 사용하여 여러 줄 메시지 삽입

@startuml
 
a -> b : This is\nvery long and\nmultiline\nmessage
 
@enduml

3.2.2.3. 메시지 번호

autonumber 키워드로 번호 삽입
필드 구분을 위해 . , , , ; , : 네 가지 Delimiter가 지원된다.

@startuml
 
autonumber
a -> b : 1st
a -> b : 2nd
 
autonumber 10
a -> b : 10th
 
autonumber 20 10
a -> b : 20th
a -> b : 30th
 
autonumber stop
a -> b : Temp stop
autonumber resume 1
a -> b : Resume
a -> b : Next
 
autonumber 1.1.1
a -> b : Change format
a -> b : Next
autonumber inc A
a -> b : Increase first
autonumber inc B
a -> b : Increase second
 
a -> b : Number of this time is %autonumber%
 
@enduml

3.3. 생명선 사용법

3.3.1. 생명선 선언

activate 또는 ++로 활성화
deactivate 또는 --, return으로 종료
- return은 마지막 생명선 활성화 지점의 출발점을 리턴
destroy 또는 !!는 X 표시와 함께 완전히 끝났음을 표현
각 키워드는 바로 이전의 시퀀스에 적용

@startuml
 
a -> b : Activate
activate b
a -> b : Deactivate
deactivate b
 
b -> c ++ : Activate
c -> b -- : Deactivate
 
a -> b ++ : Activate
a -> b ++ : Additional active
return Return
 
b -> c --++ : Deactivate and activate
 
b -> c : Destroy
destroy c
a -> b !! : Destroy
 
@enduml

3.3.2. 생명선 활용

3.3.2.1. 생명선 색상

#colorname or #colorcode 사용하여 지정

@startuml
 
a -> b ++ #crimson : Activate
b -> c ++ #34ab22 : Activate
return end
return end
 
@enduml

3.4. Note 사용법

3.4.1. Note 선언

note 키워드를 사용하여 선언
여러 줄의 노트를 추가하는 경우에는 반드시 end note 사용

@startuml
 
a -> b : Message
note left : first note
note right : second note
a ->b : Message
note left
Multi
line
note
end note
 
note over a : Note over a
note left of b : Note left of b
note right of a : Note right of a
note right of a : Note aligned
/ note right of b : Note aligned 
 
note over a,b
Note over
selected
objects
end note
note across : Note over all objects
 
@enduml

3.4.2. Note 활용

3.4.2.1. Note 모양

hnote : 육각형
rnote : 사각형

@startuml
 
hnote over a : hnote
rnote over a : rnote
 
@enduml

3.4.2.2. Note 색상

#colorname or #colorcode 사용하여 지정

@startuml
 
note over a #skyblue : Skyblue
note over a #faacfb : Color code
 
@enduml

3.5. Layout

3.5.1. Mainframe

mainframe을 사용하여 다이어그램 frame 추가

@startuml
 
mainframe main
 
a -> b : Hello world!
 
@enduml

3.5.2. Page

newpage를 사용하여 다이어그램 페이지 추가
newpage 뒤에 새 페이지의 Title 입력 가능

@startuml
 
a -> b : Hello world!
 
newpage
 
a -> b : Next page!
 
newpage Last page
 
a -> b : Last page!
 
@enduml

CAUTION

Markdown 사용 시 에디터에 따라 첫 페이지를 제외한 나머지는 출력 불가할 수 있음
따로 이미지로 붙여주지 않는 한 uml 분리 권장

3.5.3. Title

title 키워드를 이용하여 다이어그램 타이틀 생성
\n 이용하여 멀티라인 타이틀 생성 가능
title, end title 이용하여 멀티라인 타이틀 생성 가능

@startuml
 
title MyTitle
 
a -> b : Hello world!
 
@enduml

@startuml
 
title My\nmulti line\ntitle
 
a -> b : Hello world!
 
@enduml

@startuml
 
title
My
multi line
title
end title
 
a -> b : Hello world!
 
@enduml

3.5.4. Header, footer

header, footer를 이용하여 머리말, 꼬리말 표시
%page%, %lastpage%를 이용하여 현재 페이지 및 전체 페이지 수 표시 가능

@startuml
 
header Header
footer Footer
 
title MyTitle
 
a -> b : Hello world!
 
@enduml

@startuml
 
header Header
footer Page %page% of %lastpage%
 
a -> b : Hello world!
 
newpage
 
a -> b : Next page!
 
newpage Last page
 
a -> b : Last page!
 
@enduml

CAUTION

Markdown 사용 시 에디터에 따라 첫 페이지를 제외한 나머지는 출력 불가할 수 있음
따로 이미지로 붙여주지 않는 한 uml 분리 권장

3.5.5. 객체 생성

시퀀스로 인해 객체가 생성되는 것을 표시하기 위해 사용
시퀀스 바로 전에 create 를 사용하여 생성
시퀀스에 ** 를 이용하여 생성

@startuml
 
participant a
 
create b
a -> b : Hello world!
a -> c ** : Hello world!
 
@enduml

3.5.6. 객체 그룹

box 및 end box 를 이용하여 객체 그룹 형성
그룹 타이틀 및 색상 지정 가능

@startuml
 
box
participant a
end box
 
box "Others" #mediumseagreen
participant b
participant c
end box
 
a -> b : Hello world!
a -> c : Hello world!
 
@enduml

3.5.7. Stereotype 추가

<< >> 를 이용하여 객체에 Stereotype 추가
(Symbol, #color) 를 이용하여 Spot 추가

@startuml
 
participant a << StereoType >>
participant b << (S,#12fcba) >>
participant c << (S,#12fcba) StereoType >>
 
a -> b : Hello world!
 
@enduml

3.5.8. Footbox 제거

hide footbox 를 이용하여 객체의 footbox 제거

@startuml
 
hide footbox
 
a -> b : Hello world!
 
@enduml

3.5.9. 미사용 객체 제거

hide unlinked 를 이용하여 미사용 객체 제거

@startuml
 
hide unlinked
 
participant a
participant b
participant c
 
a -> b : Hello world!
 
@enduml

3.5.10. 공백, Delay, 구분선

||| 및 ||size|| 를 이용하여 공백 추가
... 및 ... 메시지 ... 를 이용하여 Delay 추가
==== 및 == 메시지 == 를 이용하여 구분선 추가

@startuml
 
a -> b : Hello world!
 
|||
||20||
 
...
... Some times later ...
 
====
== Clear ==
 
@enduml

3.5.11. 시퀀스 그룹

다음 키워드를 사용하여 시퀀스 그룹 생성
- alt, else : if / else 와 같음
- opt
- loop
- par
- break
- critical
- group : [ ] 를 이용하여 추가 문자 출력 가능
end 를 사용하여 그룹을 닫음
#colorname or #colorcode 사용하여 색상 지정

@startuml
 
a -> b : Hello world!
 
alt case 1
    b -> a : Hello world!
 
else case 2
    opt send message
        a -> b : Hello?
    end
 
else case 3
    loop retry
        a -> b : Hello?
    end
 
else case 4
    group Find new friends [Who will be?]
        a -> c : Hello world!
    end
end
 
alt#skyblue #31a2f3 Add color
    a -> b : Hello world!
else #af3a7b Color case
    a -> c : Hello world!
end
 
@enduml

4. 기타

4.1. 테마 적용

!theme 키워드를 통해 다이어그램에 테마 적용 가능
help themes 로 적용 가능 테마 리스트 확인 가능
테마 별 상세 정보는 PlantUML themes Gallery 에서 확인

@startuml
 
!theme mars
 
a -> b : Hello world!
 
@enduml

@startuml
help themes
@enduml

4.2. Skinparam

다이어그램 내 요소에 대한 스타일 지정
skinparameters로 사용 가능한 파라미터 목록 확인 가능
skinparam paramname value로 파라미터 set
자세한 정보는 Skinparam command을 참조

@startuml
skinparameters
@enduml

@startuml
 
skinparam sequenceMessageAlign center
 
a -> b : Hello world!
b -> a : Hello world, too!
 
@enduml

@startuml
 
skinparam ParticipantPadding 30
skinparam BoxPadding 20
 
box
participant a
end box
 
box "Others" #mediumseagreen
participant b
participant c
end box
 
a -> b : Hello world!
a -> c : Hello world!
 
@enduml

4.3. teoz rendering engine

PlantUML의 몇몇 기능은 teoz rendering engine을 통해 확장이 가능하다.
teoz rendering engine을 사용하기 위해서는 !pragma teoz true 를 입력해주면 된다.

4.3.1. Nested object group

@startuml
 
!pragma teoz true
 
box
participant a
 
box "Others" #mediumseagreen
participant b
participant c
 
end box
end box
 
a -> b : Hello world!
a -> c : Hello world!
 
@enduml

4.3.2. 동시성 확장

& 기호를 사용하여 동시에 일어나는 요소를 표현할 수 있다.

@startuml
 
!pragma teoz true
 
a -> b : Hello world!
& b -> c : Hello world!
 
note left of a : I'm a
& note right of b : I'm b
 
@enduml

4.3.3. Anchor

{start}, {end} 지정을 통해 Time gap 표시를 할 수 있다.

@startuml
 
!pragma teoz true
skinparam responseMessageBelowArrow true
 
{start} a -> b : Hello world!
||40||
{end} b -> a : Hi!
 
{start} <-> {end} : Duration (40)
 
@enduml

5. 참조 자료

PlantUML - Sequence

Contents

1. Introduction
2. 기본 사용법
3. 세부 사용법
3.1. 객체 사용법
3.2. 시퀀스 사용법
3.3. 생명선 사용법
3.4. Note 사용법
3.5. Layout
4. 기타
4.1. 테마 적용
4.2. Skinparam
4.3. teoz rendering engine
5. 참조 자료