IntelliJ+plantUML을 사용하여 모델 다이어그램 관리

소개

당신이 평소에 팀에서 개발을 하고 있는 경우, 그 구현에 있어서는 반드시라고 말해도 좋을 만큼 유스 케이스 다이어그램이나 ER 다이어그램 등의 모델 다이어그램의 작성, 운용의 필요성이 생기는 것은 아닐까요.
이것들은 구현시에 매우 중요한 것임에도 불구하고, 그 운용에 관해서는 아무래도 없지만 오히려 되기 쉽습니다.
이 기사에서는 plantUML이라는 DSL (도메인 전문 언어)을 사용하여 이러한 모델 다이어그램을 만드는 이점과 방법을 요약합니다.

plantUML을 사용하는 이점

변경사항을 Git에서 관리할 수 있습니다.

도메인 다이어그램이나 유스 케이스 다이어그램 등은 구현을 진행하면서 변경되는 경우가 대부분입니다.
IntelliJ등의 에디터상에서 plantUML를 사용해 이것들을 작성, 운용하는 것으로, 변경이 보존되어 언제라도 변경 전의 상태를 확인할 수 있게 됩니다.

참조, 수정이 편해진다

개발 편집기에서 관리할 수 있으므로 개발 도중에도 즉시 참조, 수정이 가능합니다. 구현을 실시하는 장소와 물리적으로 가까운 장소에 있기 때문에 편하고, 관리가 없으려고 하는 일도 적어집니다.

무료로 여러 사람이 동시에 볼 수 있습니다.

LucidChart 등의 서비스 툴을 사용하면, 무료 프레임에서는 동시에 1개의 시트에 로그인할 수 있는 인원수에 제한이 있어, 팀 개발에 있어서는 매우 불편한 때가 있습니다. plantUML을 사용하면 언제든지 팀 구성원이 각자의 PC에서 언제든지 몇 명 동시에 참조할 수 있습니다.

준비

IntelliJ 측

IntelliJ IDEA -> preference -> plugins로 진행한다

Marketplace에서 plantUML을 검색하면 몇 가지가 나오므로 왼쪽 상단의 plantUML Integration 설치

IntelliJ 재부팅

Graphviz

시퀀스 다이어그램 이외를 만들려면 Graphviz가 필요합니다. Homebrew에서 설치가 가능합니다. 또한 각 OS의 설치 프로그램에서도 가능합니다.
$ brew install graphviz
[각 OS의 설치 프로그램] h tp // w w. g등 phゔぃ… php

기본 사용법

파일 작성

plantUML 파일을 선택하여 파일 만들기

유스 케이스 다이어그램

@startuml
:Main Admin: as Admin
(Use the application) as (Use)

User -> (Start)
User --> (Use)

Admin ---> (Use)

note right of Admin : This is an example.

note right of (Use)
A note can also
be on several lines
end note

note "This note is connected\nto several objects." as N2
(Start) .. N2
N2 .. (Use)
@enduml

@startuml과 @enduml에 코드를 씁니다.
막대기 인간의 그림은:Main Admin: as Admin 같이::로 둘러싸는 것으로 as 이하에서 사용할 수 있습니다.
유스 케이스는 ()로 묶습니다.
화살표는 ->로 가로, -->로 세로로 그려집니다. 점선은 ..에서 점선 화살표는 ..> 등을 사용하면 그릴 수 있습니다.
또한 note를 사용하면 연설 거품으로 주석을 작성할 수 있습니다. 또한 풍선의 위치도 right of XXX와 top of XXX를 사용하여 유연하게 지정이 가능합니다.

도메인 다이어그램

@startuml
skinparam nodesep 100 // 水平方向の矢印の長さを調整
object 本社
object 支社
object 社員
object 所属

本社 : 会社名: string
本社 : 本籍地: string
支社 : 支社名: string
支社 : 支社番号: Long
社員 : 名前: string
社員 : 社員番号: Long
社員 : 年齢: Long
所属 : 部署名: string

note top of 支社 : 支社番号は8桁。
note left of 社員 : 年齢は満年齢。
本社 "0..*"-> "1..1" 支社
支社 "0..*" --> "0..*" 社員
社員 "0..*"-> "1..1" 所属

@enduml

도메인은 object XXX로 선언합니다.
도메인 이름 : key: value로 도메인의 값을 나타냅니다.
또 화살표의 좌우의 ""에 자유롭게 기재가 가능해, 도메인끼리의 관계를 표현할 수 있습니다.

Tips

slinparam을 사용하여 디자인을 변경할 수 있습니다.
자세한 내용은 다음 링크를 참조하십시오.
htps : // p ぁつつ ml. 코 m / 자 / s 킨파라 m

결론

plantUML을 이용하면 Git에서 모델 다이어그램을 관리할 수 있고, 여러 사람이 동시에 참조할 수 있다고 편리한 일이 많이 있습니다. 위의 예 이외에도 많은 사용법이 있습니다. plantUML을 사용하여 여러분만의 모델 다이어그램을 만드세요.

참고

htps : // p ぁつつ ml. 코 m/그럼/
h tps:// 퀵했다. 작은 m/거짓말 가게/있어 MS/c1C4 그림 583f393b27 엣 b7 아