PlantUMLのセットアップ

はじめに

最近は時間のある時にUnityの勉強をしております。入門書を一冊購入したのですが、こちらがとても興味深く、良い出会いを得たと喜んでおります。本の紹介は別途させていただきますが、今回はそんな本の内容を整理するべく、UMLにしようと考えております。
UMLの作り方には色々とあるようですが、その中でもPlantUMLというものが検索にヒットしましたので、こちらを導入してまいります。
環境はMacでのインストールとなります。
VSCodeも必要となりますが、こちらは既にインストール済みでしたので、割愛させていただきます。
参考にしましたのは、以下のサイト様です。

目次

1. インストール手順
2. HomeBrewのインストール
3. Javaのインストール
4. Graphvizのインストール
5. PlantUMLのインストール

インストール手順

インストール手順は、以下の通りです。
PlantUMLはJavaで動くようですので、JavaをHomeBrewを使って導入するようです。

1. HomeBrewのインストール
2. Javaのインストール
3. Graphvizのインストール
4. PlantUMLのインストール

HomeBrewのインストール

HomeBrewは、Macのインストーラのようです。
こちらをインストールし、Javaを手に入れます。
HomeBrewは、以下のホームページで入手することが可能です。

macOSを利用している場合は、.pkgインストーラの利用を推奨されておりましたので、こちらを利用してまいります。
GitHubからpkgをダウンロードいたします。
ですが、ダウンロード後にpkgを実行しても、Command Line Toolsが無いですよとお叱りを受けてしまいます。
これはxcode経由で入手することができるようです。以下のサイト様を参考にさせていただきました。

以下のコマンドでインストールいたしました。

xcode-select --install

これでpkgを実行することで、HomeBrewのインストールができます。
ですが、このままではHomeBrewを実行することができません。どうやらMacのM1チップやM2チップを利用している場合、パスが通っていないようです。
気にせずにbrewコマンドをターミナルで実行しようとしても、command not foundエラーが出てしまいます。
パスを通すには、zshrcに定義いたしました。以下のサイト様を参考にさせていただきました。

echo $path | grep brew

このコマンドを実行した時に何も出力されない場合、brewのパスが通っていないことになります。
以下のコマンドでシェルの種類をご確認ください。

echo $SHELL

私の場合は、/bin/zshと表示されました。
そこでvimを使ってzshrcファイルを作成します。

vim ~/.zshrc

中には以下を記載します。

typeset -U path PATH
path=(
  /opt/homebrew/bin(N-/)
  /opt/homebrew/sbin(N-/)
  /usr/bin
  /usr/sbin
  /bin
  /sbin
  /usr/local/bin(N-/)
  /usr/local/sbin(N-/)
  /Library/Apple/usr/bin
)

これが終わりましたら、最後に反映します。

source ~/.zshrc

Javaのインストール

javaのインストールには、jdkを使います。先ほどインストールしたHomeBrewを使って、jdkをインストールしてまいります。こちらもM1チップやM2チップを使っている場合、以下のコマンドとなります。

brew install openjdk

こちらでインストールすると、出力結果に以下のコマンドを実行するように記載がありましたので、実行いたします。

sudo ln -sfn /usr/local/opt/openjdk/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk
echo 'export PATH="/opt/homebrew/opt/openjdk/bin:$PATH"' >> ~/.zshrc
export CPPFLAGS="-I/opt/homebrew/opt/openjdk/include"
source ~/.zshrc

この３つのコマンドにより、Javaのインストールが完了します。
試しに以下のコマンドを実行してみましたところ、Javaのバージョンを表示させることができましたので、問題無いことを確認できます。

java -version

Graphvizのインストール

続いてGraphvizをインストールいたします。
PlantUMLで図を描画するために必要な処理だそうです。
こちらはbrewでインストールすることで、すんなりとインストールすることができました。

brew install graphviz

PlantUMLのインストール

最後にPlantUMLをインストールしてまいります。
VSCodeからインストールすることになります。
VSCodeを開き、Command＋PでPlantUMLを検索します。
対象に対し、インストールボタンをクリックすれば完了となります。