PlantUML 사용하기 (설치는 MacOS 기준, Windows도 가능)

내가 다이어그램 그릴때 즐겨 사용하는 PlantUML 의 세팅 방법과 간단한 예제를 작성한다.
시간이 늦어서 졸려서 막 갈겨씀...

-----------------------------------

일단 환경 확인과 설치 URL...

실행 환경 : MacOS, Java 설치된 상태
다운로드 : http://plantuml.com

기본 다이어그램은 plantuml.jar 만 있어도 문제없이 그릴 수 있다.

예를 들면 아래 코드와 실행결과를 참고.
"plantuml.jar" 가 위치한 폴더에 "sequenceDiagram.txt" 라는 텍스트 파일을 만들어 아래 코드를 적는다.

@startuml

start

:인트로;
-> 아래로;
:여긴 어디?;
-> 가자;
:나는 누구?;
->
if (질문) then (yes)
  :예스에 해당하는것;
else (no)
  :노에 해당하는 것
  노오오오!!력?;
endif

stop

@enduml

터미널에 입력할 실행 명령어 :

java -jar plantuml.jar sequenceDiagram.txt

아래 명령을 쉘 스크립트로 만들어 두면 편하다.

#!/usr/bin/env bash

java -jar plantuml.jar sequenceDiagram.txt

<실행시켜 얻은 다이어그램 이미지>

--------------

이외에도 좀 더 여러가지를 그리려면 graphviz 를 설치해야 한다.
graphviz 사이트에서 맥용을 다운로드 받으려면 꽤 구버전(추억의 마운틴라이온..) 밖에 없다.
다운로드 URL : http://www.graphviz.org/Download_macos.php

하지만 문제 없다.
최신 버전인 macOS Sierra 에 설치하려면 HomeBrew 로 설치하면 된다.
HomeBrew가 이미 설치된 시스템이라면 아래의 명령어를 입력한다.

brew install graphviz

알아서 디펜던시가 걸린 패키지까지 싹 설치해준다.
시간이 좀 걸릴 수 있으니 차분히 대기한다.

그러고 나서 아래의 상태 다이어그램 코드를 실행해보자.

@startuml
scale 600 width

[*] -> State1
State1 --> State2 : Succeeded
State1 --> [*] : Aborted
State2 --> State3 : Succeeded
State2 --> [*] : Aborted
state State3 {
  state "Accumulate Enough Data\nLong State Name" as long1
  long1 : Just a test
  [*] --> long1
  long1 --> long1 : New Data
  long1 --> ProcessData : Enough Data
}
State3 --> State3 : Failed
State3 --> [*] : Succeeded / Save Result
State3 --> [*] : Aborted
 
@enduml

짠...!

이런 스크립트로 다이어그램을 생성하는게 익숙하지 않은 사람은 어렵게만 보일 수 있으나,
조금 익숙해지면 작업 효율을 많이 올릴 수 있다.


-----------------

PlantUML에 대해 더 자세히 알고 싶으면, 아래 링크 추천.
http://qiita.com/ogomr/items/0b5c4de7f38fd1482a48

ATOM과 PlantUML 을 이용하여 빠르게 모델링하기.
http://qiita.com/nakahashi/items/3d88655f055ca6a2617c
(리플 감사합니다. ^^!)

-----------------

번외로 Windows 에서 실행할 때의 팁
결론만 먼저 말하면 graphviz 를 동작 플랫폼에 맞춰서 설치하면 사용법은 동일하다.

실행환경 : 윈도우 10에서 동작 확인, Java 설치 된 시스템
PlantUML : http://plantuml.com/download 에서 plantuml.jar 다운로드
graphviz : Stable and development Windows Install packages

배치파일로 실행 명령을 만들어두면 사용하기 편하다.

# test.bat

java -jar plantuml.jar sequenceDiagram.txt