Notice
Recent Posts
Recent Comments
Link
«   2024/05   »
1 2 3 4
5 6 7 8 9 10 11
12 13 14 15 16 17 18
19 20 21 22 23 24 25
26 27 28 29 30 31
Archives
Today
Total
관리 메뉴

여우의개발

[실전편] UML - PlantUML 본문

알쓸IT/Documentation

[실전편] UML - PlantUML

♬여우 2019. 12. 27. 17:11
혹시 [이론편] - UML이 필요하신 건 아니신가요?

PlantUML ■ __ ■

Why?

  1. MSA(MicroService Architecture)로 서비스를 구성하고 싶었다.
  2. 그 결과 컴포넌트들이 여러 개가 되어서, 컴포넌트들이 어떤 역할을 하고 있는지 유기적으로 보고 싶었다.
  3. 결국 문서화를 잘해야 했는데, 이왕이면 편하고 직관적으로 문서화하고 싶었다.
  4. 그래서 UML 도구를 찾게 되었다!
  5. 근데 기왕이면 만들어진 문서의 버전 관리가 수월하면 좋겠다.
  6. 심지어 쉽게 문서를 만들 수 있게 해주는 툴이라면 금상첨화겠다.
  7. 여기저기 연동이 가능해서 개발과정에 UML을 그리는 시간이 녹아들면 좋겠다.

 


so What?

  • UML 지원 tool
  • IntelliJ 연동 가능한 tool
  • Git 연동 가능한 tool
  • coding 하듯이 text로 UML을 작성할 수 있는 tool

 


What have tried...

PlantUML을 선택하기까지 삽질 과정이 궁금한 분들은 더보기를 클릭해보자.

더보기
  • 직접 그리기

    1. 낙서든 뭐든 어떤 방식으로라든 직접 그려봤을 것이다.

    2. 하지만 그려진 종이를 어떻게 버전 관리할 것인지 생각하는 순간 종이와 펜을 집어던지게 될 것이다.
      (나는 착한 개발자라 던지지는 않았다.)

  • PowerPoinT

    1. 간단한 도식이라면 뭐... 장인은 도구를 탓하진 않으니까...

    2. 하지만 장인의 도구들은 이미 전문성의 끝을 달리고 있기 때문에 탓하지 않는겁니다.

  • starUML

    1. 좋은데... 괜찮은데... 일단 유료.

    2. 선 맞추고 하다 보면 내가 개발자인지 디자이너인지 헷갈리는 순간이 온다.

    3. UML용 파일을 따로 관리해야 한다. 이게 생각보다 스트레스다.

    4. UML을 위해서 따로 툴을 켜서 작업해야 한다. 배꼽이 배만 해지는 격.

  • websequencediagram

    1. 좋다! 코딩하는 것 같다!

    2. 근데 sequencediagram 뿐이다!

    3. 일회성 간단한 시퀀스 작업물이 필요하다면 추천.

 


How!

아무튼간 그리하여 원하는 기능들이 있는 툴을 찾고 찾아 찾은 것이 바로 이것!

 

바로바로 PlantUML!

 

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

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

plantuml.com

 

 

왜 이게 쓰기 편하냐,

 

  1. 일단은 오픈 소스! (무료!)

  2. 코드를 짜듯이 텍스트로 작성이 가능 (상자 크기, 선 맞추고 할 필요가 없음)

  3. 많은.. 정말 많은 것들과 연동해서 사용이 가능하다.

 

모든 내용이 홈페이지에 잘 정리되어 나와있지만, 처음 보면 홈페이지 UI가 허접해서 조금 불신하게 된다.

하지만 믿으시라! 우리는 내면을 볼 수 있는 머찐 개발자니까.

 

홈페이지에서 '시작하기' 메뉴에 들어가면 PlantUML을 사용하기 위해서 준비가 필요한 것들을 안내해 준다.

설치 없이 맛보기만 해보실 분들은 대략적인 작성 샘플을 볼 수 있는 이 사이트를 참고하시라.

 

로컬에서 돌리기 위해서는 아래의 두 가지가 필요하다.

  • (필수) Java
  • (특정 diagram 사용 시 선택) Graphviz

IntelliJ와 연동해서 사용했을 때 가이드에 나오지 않은 다른 diagram 사용 시에도 Graphaviz가 필요했으니 맘 편히 둘 다 설치하도록 하자.

 


 

실전 가이드!

 


 

열심히 작성한 글 잘 봐주셔서 감사합니다.

 

더 질 좋은 포스팅을 위해

보시면서 좋았던 점, 궁금한 점, 과한 부분, 보강하면 좋을 부분 등

생각 나시는 대로

댓글로 적어주시면 더욱 더 감사하겠습니다! :-D

'알쓸IT > Documentation' 카테고리의 다른 글

[실전가이드] IntelliJ에서 PlantUML 사용하기  (1) 2019.12.27
Comments