PlantUML이란?
PlantUML은 UML(Unified Modeling Language) 다이어그램을 코드로 작성할 수 있게 해주는 도구입니다. 텍스트로 다이어그램을 정의하고 이를 다양한 형식의 이미지로 변환할 수 있습니다, 개발자들이 미적 감각에 대해 신경 쓸 필요없이 복잡한 다이어그램을 쉽게 그릴 수 있도록 돕습니다. UML 다이어그램뿐만 아니라 순서 다이어그램, 활동 다이어그램, 상태 다이어그램, 유스케이스 다이어그램 등 다양한 유형의 다이어그램을 지원합니다.
왜 PlantUML을 사용할까요?
- 단순함: 텍스트 기반으로 다이어그램을 정의할 수 있어 간단하고 직관적입니다.
- 버전 관리: 텍스트 파일로 저장되므로 Git과 같은 버전 관리 시스템에서 쉽게 추적할 수 있습니다.
- 자동화: 코드로 작성되기 때문에 스크립트나 자동화 도구와 통합하여 다이어그램을 자동 생성할 수 있습니다.
- 다양한 출력 형식: PNG, SVG, PDF 등 여러 가지 형식으로 다이어그램을 출력할 수 있습니다.
Visual Studio Code에서 PlantUML 사용하기
Visual Studio Code(VS Code)에서 PlantUML을 사용하면 매우 편리하게 다이어그램을 작성하고 미리 볼 수 있습니다. 아래는 VS Code에서 PlantUML을 설정하고 사용하는 방법입니다.
1. Java 설치
PlantUML은 Java로 작성되어 있으므로 Java가 필요합니다. Java가 설치되어 있지 않다면 Oracle의 Java 다운로드 페이지에서 JDK를 다운로드하여 설치합니다.
2. Graphviz 설치
PlantUML은 Graphviz를 사용하여 다이어그램을 렌더링합니다. Graphviz를 설치하려면 Graphviz 다운로드 페이지에서 운영 체제에 맞는 버전을 다운로드하여 설치합니다.
3. VsCode에서 PlantUML Extention 설치
4. 예제 파일 생성
.puml 혹은 .plantuml 과 같은 확장자를 갖는 파일을 생성합니다.
@startuml example
Alice -> Bob: Hello
Bob -> Alice: Hi
@enduml이후 Alt + D (맥의 경우 Option + D) 를 누르면 다이어그램을 미리볼 수 있습니다.
5. 다이어그램 출력
앞서 PlantUML의 장점으로 다양한 출력 형식을 지원한다고 했었습니다.
VsCode에서 커맨드 검색을 위해 Ctrl + Shift + P (맥의 경우 Command + Shift + P)을 입력한 뒤 PlantUML을 검색하면 Export Current Diagram 명령어를 실행할 수 있습니다.
결론
PlantUML은 텍스트 기반으로 다이어그램을 작성할 수 있는 강력한 도구입니다. Visual Studio Code와 함께 사용하면 더욱 편리하게 다이어그램을 작성하고 관리할 수 있습니다. https://plantuml.com/ko/ 에서 학습할 수 있습니다.