본문 바로가기

Backend/OOP

[UML] PlantUML로 UML Diagram 쉽게 활용하기 with IntelliJ

개인 프로젝트를 시작하며, 요구사항을 정리하기 위해 UML 다이어그램을 활용하기로 했다.

여러 사이트를 돌아다녔지만, 특별히 마음에 드는 곳은 없었고

PlantUML을 이용해 플레인 텍스트로 UML Diagram을 사용하는 방법을 택했다.

 

여러 사이트의 온라인 에디터로 PlantUML을 사용해보고 문법을 찾아보며 얻은 실행 환경을 공유한다.

 

1. 온라인 에디터

Kroki

 

Kroki!

Kroki provides a unified API with support for BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag), BPMN, Bytefield, C4 (with PlantUML), Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, Pikchr, PlantUML, SvgBob, UMLet, Vega, Vega-Lite,

kroki.io

PlantUML 데모 서버

 

PlantUML Web Server

The PlantUML Web Server allows you to create and edit online UML diagrams using the PlantUML Language.

www.plantuml.com

 

크로키라는 여러 언어를 호환해주는 온라인 에디터 사이트와 PlantUML 오픈소스에서 직접 제공하는 온라인 데모 서버가 있다.

처음에는 이 곳을 활용해보다가

프로젝트에 파일을 남겨놓고 재사용하고 싶고, 온라인 에디터는 코드를 중간중간 관리하기 불편할 뿐더러

프로젝트와 따로 실행환경이 분리되어 있어 내가 프로젝트를 구현할 인텔리제이 환경 하에 PlantUML 환경을 구축하기로 결정했다.

 

2. IntelliJ 플러그인과 graphviz

PlantUML integration

Preferences (command + ,)를 실행해 Plugins로 이동해 plantUML을 검색하면 최상단에 위치해있다.

해당 플러그인을 설치하고, 인텔리제이를 재시동한다.

 

확장자명 .puml 을 사용해 파일을 만들어 PlantUML 텍스트를 사용하면 자동완성과 에러 체크 기능을 제공해준다.

컴퓨터에 graphviz가 설치되어있지 않다면, 해당 텍스트를 통해 만들어진 다이어그램을 확인할 수 없다.

 

brew install graphviz

해당 키워드를 통해 graphviz를 설치해준다.

홈브루가 설치되어있지 않다면, 홈브루부터 설치해주자.

 

이 후,

인텔리제이 내에서 다이어그램과 플레인 텍스트를 함께 확인할 수 있게 된다.



다이어그램을 우클릭해 다양한 기능 또한 사용할 수 있다.

 

3. 문법

PlantUML을 제대로 사용하기 위해서는 PlantUML을 익혀야 할 것이다.

https://www.planttext.com/

 

PlantText UML Editor

PNG |  SVG |  TXT |  Edit Scratch area...

www.planttext.com

쉽고 빠르게 원하는 문법만 사용하기 제일 알맞은 사이트다.

UML 다이어그램을 그리고자 불필요한 모든 문법을 알 필요는 없을 것이다.

 

플레인텍스트 사이트의 예시보다 더 많은 것을 알고 싶으면 공식사이트를 활용하자

https://plantuml.com/ko/

 

간단한 텍스트를 이용하여 멋진 UML 다이어그램을 만들 수 있는 오픈소스 도구입니다.

간단한 텍스트를 이용하여 쉽게 멋진 UML 다이어그램을 만들 수 있으며, 다양한 종류의 다이어그램을 제공하고 있습니다. 또한, 생성된 다이어그램을 PNG, LaTeX, EPS, SVG 와 같은 이미지로 변환할 수

plantuml.com