Mac에서 PlantUML을 사용해보자!

Mac에서 PlnatUML을 사용하여 시퀀스 다이어그램, 클래스 다이어그램 등을 만들어 보겠습니다.

개발자에 있어서는 단순 코딩뿐만이 아니라 자신의 프로그램이 어떤 구성을 가지고 있는지 설계하는 능력도 중요하다고 생각합니다.

PlantUML은 간단히 사용할 수 있고 각 종 다이어그램도 코딩하듯이 작성할 수 있어 편리한 툴입니다. 

작성법이나 소개에 관련된 글을 확인하시면 됩니다.

https://plantuml.com/ko/

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

---

1. 설치

설치에 있어서는 역시 패키지 관리 툴인 homebrew를 사용하는 편이 쉽습니다.

간단히 아래와 같은 커맨드를 입력하시면 설치는 끝이 납니다.

graphviz 는 그래프를 그리기 위한 도구 패키지라고 생각하시면 됩니다. 

때문에 plantuml로 코드를 작성하면 graphviz를 사용하여 그래프를 만들어 줍니다.

 $ brew install graphviz
 $ brew install plantuml

2. 테스트

설치는 간단히 끝났으니 어떻게 사용할지 간단히 알아보겠습니다.

PlnatUML 사이트를 보시면 간단한 예제들도 있기 때문에 배우는 것도 금방 따라 하실 수 있습니다. 

예를 들어 클래스 다이어그램을 한 번 만들어 보겠습니다.

text.uml이라는 파일을 생성하여 아래와 같은 글을 복사합니다.

@startuml
Class01 <|-- Class02
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 -- Class10
@enduml

작성한 해당 파일이 있는 디렉토리로 이동한 후에 아래와 같은 커맨들를 사용하여 그래프를 출력해냅니다.

$ plantuml test.uml

위의 커맨드를 실행하시면 해당 디렉터리에 그래프로 작성된 파일이 하나 생성됩니다.

완성!

위와 같은 방법으로 여러가지 다이어그램을 작성하실 수 있습니다.

3. 에디터

직접 작성을 해서 사용하는 방법도 있지만 더욱 편리하게 사용할 수 있게 여러 가지 에디터에서도 그 기능을 제공하고 있습니다.

대표적으로는 아래와 같이 있습니다.

(저는 VSCode로 밖에 사용해보질 못했습니다.)

• VSCode
• eclipse
• Brackets
• Notepad++
• Vim
• LaTex
• JetBrains InteliJ IDEA
• Atom
• 등등

간단히 VSCode로 사용하는 방법을 알아보자면 우선 VSCode를 설치 후, Extenstions기능에서 PlnatUML를 검색합니다.

맨 위에 있는 항목을 선택하신 후 자신의 사양에 맞게 설치해 주시면 됩니다.

5. 마무리

이번 글에서는 PlantUML에 대하여 알아보았습니다. 

처음에는 배워야 할 것도 있고 적응하는데 시간이 들지만 어느정도 적응을 하게 되면 편하게 작성할 수  있는 것 같습니다.

많은 도움이 되었으면 좋겠습니다.

감사합니다.

---

환경 

Mac 10.14.6 Mojave