Overview

개인 개발 작업의 종속성을 시각화하기 위해 PlantUML을 도입합니다.

설치

brew 명령을 사용하여 필요한 패키지 배포

$ brew install graphviz
$ brew install adoptopenjdk --cask
$ brew install plantuml

brew 명령 자체가 없는 경우, 다음과 같이 설치한 후 다시 실행하십시오.

# コマンドがない！
$ brew install XXX
bash: brew: command not found

# インストール
$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

# インストール確認
$ brew -v
Homebrew 2.2.3
Homebrew/homebrew-core (git revision a0d66; last commit 2020-01-19)
Homebrew/homebrew-cask (git revision 4bb1; last commit 2020-01-19)

plantuml은 Java가 필요하며, 그렇지 않은 경우 다음 오류가 표시됩니다.

$ brew install plantuml
plantuml: Java is required to install this formula.
Install AdoptOpenJDK with Homebrew Cask:
  brew cask install adoptopenjdk
Error: An unsatisfied requirement failed this build.

VSCode에서 사용

PlantXML용 확장을 설치합니다.

설치가 완료되면 VSCode를 다시 시작합니다.
*.pu 형식의 파일을 작성해, 이하와 같이 기입해 본다.

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

그런 다음 ⌥(option) + D 입력하십시오. . .

↓

조금 시간이 걸린 후에 위의 그림이 묘사되었습니다!

일단 미리보기를 표시하면 나중에 실시간으로 업데이트가 반영되어 가므로 확인하면서 수정할 수 있습니다. 이것은 편리합니다.

이미지로 저장

⌘(command) + ⇧(shift)+ P 에서 명령 팔레트를 열고 Export Current File Diagrams를 선택합니다.

그 후 파일 형식을 듣기 때문에 좋아하는 형식을 선택.

조금 시간이 지나면 다음 알림이 나오면 작성 완료.


이번 경우 test.um 에서 /out/uml/test/test.png 를 생성했다.
생성 파일의 디렉토리가 독자적으로 만들어지기 때문에, 처음에는 조금 헤매는지도 모른다.

GitHub에서 관리 및 검색.

PlantUML 뷰어 을 사용하면 GitHub에서 텍스트 형식의 UML 다이어그램을 묘사하고 확인할 수 있습니다.
확인할 때는, 그 파일을 GitHub 상의 Raw 지정으로 표시할 필요가 있습니다.

상세한 쓰기

PlantUML Cheat Sheet 참조

Reference

PlantUML을 Mac OS X에서 사용

PlantUML 사용 (MacOS) ~ Visual Studio Code에서 더 사용하기 쉽습니다 ~