PlantUMLは、UML図作成ソフトウェアである。テキストでUML図を作れるので便利。オンラインコンバータもあるが、今回はMacでPlantUMLを使えるようにする。PlantUMLの実行に必要なJavaとGraphvizのインストール方法も説明する。
環境
Requirements
Javaのインストール(今回はOpenJDKのJava 11)
- ここから openjdk-11*_bin.tar.gz をダウンロード
- openjdk-11*_bin.tar.gz をダウンロードしたディレクトリに移動
$ tar -xzf openjdk-11*_bin.tar.gz
# mv jdk-11*.jdk /Library/Java/JavaVirtualMachines
$ java -version
を実行し、期待するバージョンが表示されるかを確認。異なるバージョンが表示される場合は次に進む$ /usr/libexec/java_home -V
を実行し、バージョンを確認
Matching Java Virtual Machines (1): 11.0.2, x86_64: "OpenJDK 11.0.2" /Library/Java/JavaVirtualMachines/jdk-11.0.2.jdk/Contents/Home /Library/Java/JavaVirtualMachines/jdk-11.0.2.jdk/Contents/Home
- ~/.bashrc 等に
export JAVA_HOME=`/usr/libexec/java_home -v [期待するバージョン]`
を追記。この場合は 11.0.2 $ exec $SHELL -l
$ java -version
を実行し、期待するバージョンが表示されたら成功
Graphvizのインストール
$ brew doctor && brew update
$ brew install graphviz
$ brew list | grep graphviz
を実行し、インストールされていることを確認
前提(または準備)
- ホームディレクトリ直下に bin, src, jar/plantuml の3つのディレクトリがある。無ければ作る
- ~/bin にPATHが通っている。通っていない場合は、~/.bashrc 等に
export PATH="$HOME/bin:$PATH"
を追記し、$ exec $SHELL -l
を実行
PlantUMLのインストール
- ここから plantuml.jar をダウンロード
- plantuml.jar を ~/jar/plantuml に移動
- ~/src/plantuml.sh を作成
#!/bin/bash java -jar $HOME/jar/plantuml/plantuml.jar "$@"
$ chmod +x ~/src/plantuml.sh
$ ln -s ~/src/plantuml.sh ~/bin/plantuml
$plantuml -v
を実行し、バージョンが表示されたら成功
Usage
$ plantuml [input]
e.g., $ plantuml test.pu
を実行すると、test.png が生成される
詳しい使い方は、 $ plantuml -h
等で確認してください。
LaTeX数式記法への対応
UML図に数式を入れる場合、LaTeX記法を使えるようにする。
- ここから plantuml-jlatexmath.zip をダウンロード
- plantuml-jlatexmath.zip をダウンロードしたディレクトリに移動
$ unzip plantuml-jlatexmath.zip
$ mv plantuml-jlatexmath/*.jar ~/jar/plantuml
- textest.pu を作成
@startlatex \sum_{i=0}^{n-1} (a_i + b_i^2) @endlatex
$ plantuml textest.pu
を実行し、以下のような textest.png が生成されたら成功
スタイル
PlantUMLはデフォルトのデザインがダサく、解像度も低いので、Skinparamをいじってあげると良い。フォント等も変えられる。
例えば、以下のような style.pu を作成し、別のpuファイルで !include style.pu
と書くことで、style.pu の内容を適用できる。
skinparam { defaultFontName Avenir Next dpi 300 monochrome true shadowing false }
プレビュー
Visual Studio CodeにPlantUMLのプラグインをインストールすると,puファイルのテキストを編集しながら,UML図のプレビューを確認できる.
PlantUML - Visual Studio Marketplace
参考:Visual Studio Code で UML を描こう! - Qiita