PlanetUML로 Go 포장의 클래스를 묘사합니다

이번에는 작은 단락을 좀 쓰자.
Go 제작된 포장을 UML 그림으로 표현할 수 있었으면 좋겠다는 생각은 해봤어요?많은 사람들이 그렇게 생각하는 듯 다양한 도구를 공개했다.그중 이번에 소개된 것은 jfeliu007/goplantuml다.
goplantuml는 Go 분석 패키지의 분석기와 이 분석 패키지를 사용하는 CLI(Command-Line Interface) 도구로 구성되어 있다.또한 이 패키지Dumels를 사용하는 웹 서비스도 있습니다.이번에는 CLI 도구를 시험해 봅니다.

CLI 도구 다운로드 및 구축

2진법을 준비하지 않았기 때문에 고딕 명령으로 순순히 다운로드하고 구축해야 한다.모듈 모드가 ON이면 다음과 같습니다.

$ go get github.com/jfeliu007/goplantuml/cmd/goplantuml@latest

$ goplantuml -h
Usage of goplantuml:
  -aggregate-private-members
    	Show aggregations for private members. Ignored if -show-aggregations is not used.
  -hide-connections
    	hides all connections in the diagram
  -hide-fields
    	hides fields
  -hide-methods
    	hides methods
  -ignore string
    	comma separated list of folders to ignore
  -notes string
    	Comma separated list of notes to be added to the diagram
  -output string
    	output file path. If omitted, then this will default to standard output
  -recursive
    	walk all directories recursively
  -show-aggregations
    	renders public aggregations even when -hide-connections is used (do not render by default)
  -show-aliases
    	Shows aliases even when -hide-connections is used
  -show-compositions
    	Shows compositions even when -hide-connections is used
  -show-connection-labels
    	Shows labels in the connections to identify the connections types (e.g. extends, implements, aggregates, alias of
  -show-implementations
    	Shows implementations even when -hide-connections is used
  -show-options-as-note
    	Show a note in the diagram with the none evident options ran with this CLI
  -title string
    	Title of the generated diagram

네네.

분석 매크로 패키지

해석을 위해 포장된 디렉터리를 매개 변수로 전달할 수 있다.

$ goplantuml ~/go/src/github.com/spiegel-im-spiegel/pa-api > pa-api.puml

분석 결과는 PlantUML의 설명 형식으로 표준 출력에 출력되었기 때문에 적절하게 방향을 바꾸었다.그런 다음 PlantUML를 사용하여 이미지 데이터로 변환하면 됩니다.

java -jar /path/to/plantuml.jar -charset UTF-8 pa-api.puml

결과는 이렇다.

포장 단위로 정리된 건 알겠죠.또한 -recursive 추가 옵션이 있으면 하위 디렉터리의 패키지도 귀속적으로 해석할 수 있습니다.원래 UML 그림을 그리려면 무게가 많이 들어가야 하는데 이번에는 코드로 그려서 중요하지 않아요.
문서에 있는 남자에게 주세요.

Windows의 dot 명령에 유의하십시오.

Windows 버전Graphviz 2.44에 포함된dot 명령을 사용할 때[1] 명령 알림에dot를 사용합니다.exe 명령이 있는 폴더 dot -c 로 내려가면 미리 명령할 필요가 있을 것 같습니다.

Important note about version

덤

졸작spiegel-im-spiegel/depm을 사용하면 모듈 단위의 의존 관계를 가시화할 수 있다.예를 들면 이런 느낌.

자세한 내용은 아래 소개 페이지를 참조하십시오.

Depm: Go 언어 모듈 의존 관계 시각화 도구

지금까지 광고였습니다(웃음)

참고 자료

bykof/go-plantuml: Generate plantuml diagrams from go source files or directories

Generate plantuml diagrams from go source files or directories

PlanetUML 제대로 설치(1): PlanetUML

진지한 PlanetUML(3):반도

각주
PlantUML 드로잉에서 Graphviz의dot 명령을 사용합니다.↩︎