시퀀스 다이어그램

date

Nov 26, 2023

slug

sequence-diagram

status

Published

시작하며

프로젝트 진행 중에 프론트엔드 팀, 백엔드 팀, 그리고 기획 팀 간의 정보 동기화에 어려움을 겪었습니다. 이를 해결하고 개발 프로세스를 향상시키기 위해 한 가지 방안을 고안했습니다.

시퀀스 다이어그램

시퀀스 다이어그램은 시스템 내 각 구성 요소 간의 상호 작용을 시각적으로 표현함으로써, 복잡한 프로세스와 워크플로우를 명확하게 이해할 수 있게 도와줍니다.

유형	내용
동기 메시지 (Sync message)	요청을 보낸 후 반환이 올때까지 대기
비동기 메시지 (Async message)	요청을 보낸 다음 반환을 기다리지 않고 다른 작업을 수행
자체 메시지 (Self message)	자기 자신에게 요청을 보냄
반환 메시지 (Reply/Return message)	요청에 대해 메시지를 반환

1. 동기 메시지

동기 메시지는 실선과 꽉 찬 화살표로 표현을 합니다. 동기 메시지이므로 요청을 보낸 후, 결과가 올 때까지 기다립니다.

2. 비동기 메시지

비동기 메시지는 실선과 선으로 이뤄진 화살표로 표현을 합니다. 비동기 메시지이므로 요청을 보낸 후, 결과를 기다리지 않습니다.

3. 자체 메시지

자체적으로 작업을 처리할 때, 자체 메시지를 사용합니다. 자체 메시지는 본인의 Lifeline으로 회귀하는 화살표를 그립니다.

4. 반환 메시지

동기 메시지에서 표현했던 것과 같이 요청에 대한 결과를 반환할때, 반환 메시지를 사용합니다. 점선과 선으로 이뤄진 화살표로 표현합니다.

5. Loop, Alt, Parallel 등…

Loop는 특정 조건이 충족될 때까지 반복되는 시퀀스를 표현합니다.

Alt는 조건에 따라 다른 시퀀스를 실행하는 분기점을 표현합니다.

Parallel은 두 개 이상의 프로세스가 동시에 실행되는 병렬 시퀀스를 표현합니다.

Mermaid

Mermaid는 간단하고 이해하기 쉬운 텍스트 기반 구문을 사용하여 다양한 유형의 다이어그램을 생성할 수 있는 도구입니다. Notion에서 시퀀스 다이어그램을 쉽게 만들기 위해 Mermaid 코드를 사용할 수 있습니다.

마치며

시퀀스 다이어그램을 사용함으로써, 각 팀이 프로세스 흐름을 시각적으로 명확하게 이해할 수 있었습니다. 이를 통해 팀 간의 효율적인 커뮤니케이션을 촉진하는 데 큰 도움이 되었습니다. 이 글이 여러분의 프로젝트에서도 유용한 참고자료가 되길 바랍니다. 앞으로도 유용한 정보를 공유하기 위해 노력하겠습니다.

참고

[UML] 시퀀스 다이어그램 (Sequence Diagram)

시퀀스 다이어그램은 특정 행동이 어떠한 순서로 어떤 객체와 어떻게 상호작용을 하는지 표현하는 행위 다이어그램입니다. 현재 존재하는 시스템이 어떠한 시나리오로 움직이고 있는지를 나타내는데 장점을 가지고 있습니다. 시퀀스 다이어그램을 이용하면 API 등의 유즈 케이스를 디테일하게 알 수 있고 타 시스템의 API 호출 등의 로직을 모델링할 수 있어 시나리오를 파악하기 좋습니다.예를 들어, 고객이 29CM 사이트 주문을 했을 때 고객이 주문한 시점부터 29CM 사이트의 주문 처리 순서, 이후 반환 케이스를 연속적으로 표현할 수 있습니다.Lifeline모델링 되는 인스턴스를 나타냅니다. Lifeline은 네모와 점선으로 이루어져 있으며 네모가 객체의 관점으로 표현했다면 클래스이고 서비스 관점으로 표현했으면 컴포넌..

https://brownbears.tistory.com/511