[UML] 시퀀스 다이어그램 (with Mermaid)

왜 필요한가 

시퀀스 다이어그램을 통해 복잡한 시스템이 시간과 연계되어 상호작용되는 것을 이해할 수 있다. 

순서가 중요한 비즈니스 로직에서 예외 상황과 분기 로직 명확화, 동시성 및 병렬 처리 구간 식별을 위해 필요하다.

 

이 다이어그램이 다른 팀 간의 커뮤니케이션 도구로서 중요하다고 생각한다. 개발팀과 기획팀 사이에서는 비즈니스 로직이 어떻게 구현되는지에 대한 시각화를 할 수 있다. 개발팀과 운영팀 사이에서는 시스템 구조와 로그를 비교하며 빠르게 모니터링 포인트를 식별할 수 있다고 생각한다. 물론 개발팀 내부에서는 코드를 모두 읽고 디버깅을 통해 로직을 확인할 수 있고 해야만 하지만 추상화된 도식도를 통해 빠르게 접근할 수 있다는 점이 장점이라고 생각한다. 또한, 성능을 개선했을 때 로직을 전과 후를 한 눈에 비교함으로서 선례를 남길 수 있다고 생각한다. 

 안 그려놓으면 개발 중에 헷갈리거나 1년 후의 내가 헷갈려하던데;; 

 

시퀀스 다이어그램에서 사용하는 UML 표준 문법 정리 

- UML 표준 문법은 Object Management Group(OMG)에서 관리한다고 한다. 

링크 : https://www.omg.org/spec/UML (17.8 Sequence Diagrams)

About the Unified Modeling Language Specification Version 2.5.1

 

점선 / 실선 그리고 채워진 화살표 / 열린 화살표 차이점을 확인해보자

———▶ (실선 + 채워진 화살표)	동기 호출 메시지 (Sync Call)	호출자가 응답을 받을 때까지 대기	REST API 호출, DB쿼리, 일반적인 메서드 호출
———▷ (실선 + 열린 화살표)	비동기 호출 메시지 (Async Call)	호출자가 응답을 기다리지 않고 즉시 다음 작업 수행	이벤트 발행, 백그라운드 작업 시작, 알림 전송
◁ - - - (점선 + 열린 화살표)	응답 메시지 (Reply Message)	동기 호출에 대한 반환값이나 완료 신호	API응답 데이터, 메서드 리턴값, 처리 완료 확인
——lost—●	분실 메시지 (LostMessage)	목적지가 다이어그램 밖에 있는 메시지	외부 시스템으로 보내는 메세지, 네트워크 밖으로 나가는 메시지
●—found—▶	FoundMessage	발신자는 알 수 없지만 수신자는 알려진 메시지	외부에서 들어오는 이벤트, 사용자 입력, 외부 시스템 콜백

 

 

 

 

 

 

Frame

opt (조건이 참일 때만 실행되는 선택적 흐름) opt [사용자가 로그인됨]        사용자 -> 시스템 : 대시보드 표시  loop (특정 조건이 참인 동안 반복 실행되는 흐름) loop [아이템이 남아있는 동안]     시스템 → 결제 모듈 : 아이템 결제 처리 alt (조건 분기에 따라 여러 대안 흐름 중 하나를 선택하는 경우 사용) alt [로그인성공]     사용자 -> 시스템 : 대시보드 표시 ---- else [로그인 실패]      시스템 -> 사용자 : 에러 메시지 표시  par (여러 메시지 흐름이 동시에 실행되는 구간) par -------------------- [흐름 A] 객체1 -> 객체2 : 메시지 A -------------------- [흐름 B] 객체1 -> 객체3 : 메시지 B

 

 

추천 툴 

예전에는 draw.io 를 사용했었는데, 드래그앤 드랍으로 하나씩 위치에 놓아야 하는 문제점이 있었다. 

Mermaid는 코드로 UML을 작성할 수 있게 해줘서 좋다

 

https://mermaid.js.org/

Mermaid