PlantUML은 텍스트 기반으로 UML 다이어그램을 작성하고 자동으로 시각화해주는 도구입니다.
PlantUML은 개발자와 설계자들이 UML 다이어그램을 효율적으로 생성하고 관리할 수 있도록 도와주며, 시스템의 구조와 동작을 명확히 이해하는 데 유용합니다.
PlantUML 소개
PlantUML은 다음과 같은 주요 특징을 가지고 있습니다:
- 텍스트 기반: 다이어그램을 텍스트 형식으로 정의하고, 이를 시각적인 다이어그램으로 변환합니다.
- 다양한 다이어그램 지원: 시퀀스 다이어그램, 클래스 다이어그램, 유스케이스 다이어그램 등 다양한 UML 다이어그램 및 비-UML 다이어 그램을 지원합니다.
- 자동화된 시각화: 텍스트로 작성된 UML 코드를 자동으로 시각화하여, 쉽게 다이어그램을 생성할 수 있습니다.
- 간편한 통합: 다양한 개발 환경과 도구와 통합할 수 있어, 개발 워크플로우에 자연스럽게 녹아듭니다.
PlantUML 설치 및 사용방법
PlantUML을 사용하기는 방법은 매우 여러가지가 있습니다.
PlantUML Online Server를 이용하는 방법도있지만 작성된 내용도 보관하기 쉽고 추후에도 수정을 쉽게 하기위해 저는 VSCode의 Extension을 이용해서 설치하고 사용하는 방법을 추천합니다.
1. VSCode의 마켓플레이스에서 plantuml을 검색하고 설치합니다.
2. *.puml 확장자로 파일을 생성한 후, @startuml 과 @enduml 사이에 내용을 작성해준다.
3. Alt + D (MacOS는 option + D)를 눌러서 미리보기 화면(Preview)을 볼 수 있으며 클립보드로 저장이 되니 이미지로 저장도 가능하다.
요구 사항
마켓플레이스 설명을 보면, 확장만 설치하면 끝나는게 아니라 요구사항을 안내하고 있습니다.
다음 항목이 설치되어 있지 않을경우 프리뷰를 보여주지 못하는 상황이 발생하니 내용을 확인후 Java와 Graphviz를 설치해 줍니다.
Quick Install for Mac
brew install --cask temurin
brew install graphviz사용 예시
다음은 카카오 REST API를 사용한 카카오 로그인 과정을 나타낸 시퀀스 다이어그램(Sequence diagram)을 PlnatUML로 작성해본 예입니다.
참고
PlantUML 공식 사이트: https://plantuml.com/ko/