M1 맥북에서 plantuml 사용하는 방법

plantuml을 사용하는 방법은 3가지로 나누어 볼 수 있습니다.

1. 브라우저를 통해 공홈 편집기에 접속해서 plantuml 사용하기
2. local에서 편집기(vscode)나 ide(intellij 등의 Jetbrain제품: pycharm, webstorm, android studio...)를 사용해서 server rendering으로 plantuml 사용하기
3. local에서 편집기나 ide를 사용해서 local rendering으로 plantuml 사용하기

먼저 server rendering은 http://www.plantuml.com/plantuml 으로 plantuml code를 보내서 보이는 형태로 컴파일 후 돌려 받아서 로컬 장치에서 보는 것입니다. Plantuml 측이 봐도 되는 자료라면 이렇게 하셔도 됩니다.(세팅할게 없어서 이게 더 편합니다) 단, private project의 경우에는 노출되지 않는게 좋으므로 local rendering을 사용하는 것이 좋습니다. local rendering은 local machine에 java와 graphviz를 깔고 이걸로 plantuml code를 컴파일 하여 보여주는 것을 의미합니다. 따라서 정보가 외부에 노출될 일이 없습니다.

plantuml을 사용하려고 하다보면 sequence diagram을 제외한 다른 다이어그램의 경우에는 graphviz라는 프로그램 설치가 필수입니다. 그런데 m1맥북의 경우 brew 경로가 intel칩과는 달라져서 별도의 설정이 필요한 경우가 있어서 설명하기 위해 글을 씁니다.

일단, 처음부터 어떻게 해야하는지 공식 홈페이지의 설명을 풀어서 말씀 드리겠습니다.

1. Server rendering

1.1. VisualStudioCode

먼저 visual studio code에서 server rendering을 하는 방법을 알려드리겠습니다.

1. plantuml plugin 설치
2. plantuml plugin 세팅 화면에 들어가기
3. Plantuml: Render를 기본값 local에서 PlantUMLServer로 변경하기
4. Plantuml: Server에 https://www.plantuml.com/plantuml 를 넣기(만약 대신해줄 서버가 있다면 그 서버를 넣기

1.2. Jetbrain Tools

1. plantuml plugin 설치
2. plantuml plugin 세팅 화면(Preference)에 들어가기
3. PlantUML server path를 https://www.plantuml.com/plantuml 로 변경하기
4. Remote rendering 체크 하기

2. local 설치

먼저 위의 과정 중에 1.1. 1.2. 에서 plantuml 설치를 했다고 가정하고 하겠습니다.

2.1. 필수 라이브러리 설치(java, graphviz) 설치

brew install cask
brew install --cask adoptopenjdk8
brew install graphviz
echo "\nexport JAVA_HOME=/Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home\n" >> .zshrc

brew가 설치되어 있지 않다면 설치를 해주시고 위의 shell script를 사용하시면 java 설정이 완료됩니다. 마지막줄은 .zshrc라는 설정파일의 마지막 줄의 다음 줄에 JAVA_HOME을 설정하는 라인입니다. Vscode, Jetbrain tool 모두 설치해주어야 합니다.

2.2. Visual Studio Code

2.1. 만 하면 plantuml이 정상 동작합니다. 오늘자 버전상 더 이상 설정은 필요 없습니다. 바로 사용하시면 됩니다!

2.3. jetbrain tools

이 글을 쓰게 된게 jetbrain 사 제품 때문입니다.

아직 jetbrain 에서 수정을 하지 않아서 인지, jetbrain 사의 ide를 사용하면 이런 에러 화면이 나옵니다. dot라는 graphviz 실행 파일의 경로를 제대로 찾지 못하는 것인데 이걸 제대로 찾도록 변경해주어야 동작합니다.

현재 버전 기준으로는 plantuml plugin preference로 들어가서 graphviz dot executable을 /opt/homebrew/Cellar/graphviz/2.48.0/bin/dot 로 설정해주시면 됩니다. 저기가 아니더라도 graphviz까지는 경로가 일치할 것이고 거기서 맞춰서 찾아보시면 됩니다. 참고로 GRAPHVIZ_DOT 환경 변수를 설정하는 것은 동작하지 않았습니다. 그냥 경로를 설정하시면 되겠습니다.