PlantUML 소개

markdown 문서를 작성할 때 class 간 관계를 보여주기 위해 mermaid 의 UML class diagram 을 이용해 작성하곤 했다.

하지만 일일이 수작업으로 class diagram을 작성하는게 매우 번거롭다.

또한 class간 관계 설정을 제대로 했는지 계속 고민하게 된다.

UML 이 한 최근 유행하는 방법도 아니고 이미 나온 지 30년이 넘어가는 방식이기 때문에 이를 위한 다양한 도구들이 있고 때문에 수작업으로 작성하지 않아도 java source에서 바로 class diagram을 작성할 수 있다.

그 중 PlantUML 을 사용해 보았는데 소개해보려고 한다.

다양한 UML 도구 중 PlantUML을 선택한 이유는 2009년 공개된 이후 현재까지도 꾸준히 업데이트되고 있고 Eclipse (STS) plugin을 제공하고 있어 Eclipse에서 간단하게 사용이 가능하기 때문이다.

Eclipse plugin 설치

Eclipse Marketplace에서 PlantUML 을 검색하여 설치한다.

PlantUML은 diagram을 그리는 데 Graphviz 를 사용하기 때문에 설치가 필요하지만 별도로 설치하고 path를 설정하지 않아도 알아서 로컬에 다운로드하여 사용한다.

Windows -> Show View -> Other... 를 선택하고 PlantUml 폴더의 PlantUML을 선택하여 view를 추가한다.

view가 추가된다.

기본은 Link with editor 가 활성화 되어 있는 상태인데

이 상태에서 Package Explorer 에서 선택한 java source 또는 editor의 활성화된 탭의 java source가 PlantUML view에 class diagram으로 표시된다.

Package Explorer 에서 ctrl 을 누른 상태로 여러 java source를 선택하면

알아서 상위 관계까지 확인하여 class diagram을 만들어준다.

References in Workspace (Ctrl + Shift + G )로 참조를 검색하여 어떻게 참조되는지 찾게 되는데 이렇게 검색한 결과에서 여러 java source를 선택해도 동일하게 보여주기 때문에 전체적인 참조 구조를 파악하기 편하다.

다만 보여줄 수 있는 화면이 한계가 있어 너무 많은 java source를 선택하면 화면 밖으로 잘려나가기 때문에 적절하게 선택하여 확인해야 한다.