KAROUSHI -Japanese Engineer Blog-

コボルドからドラゴンへ -Kobold to Dragon-

システムエンジニアのブログです。サイト名は「雑魚キャラからボスキャラへレベルアップしたい!」という思いを込めて命名しました。自分はやっとリザードマンになったくらいです。

IntelliJ IDEAでPlantUMLプラグインをインストールしてリアルタイムにUMLをプレビュー表示する

UMLツールの代表だったastahが有料になってしまったため代替を探していたら、PlantUMLという無料UMLツールを見つけたので紹介します。
PlantUMLを使うことによって以下のようなメリットがあります。
メリット:

  1. テキストで保存できるためGitやSVNリポジトリ管理できるので差分確認が可能
  2. 図の見栄えの統一
  3. シーケンス図やクラス図への追加削除が容易
  4. 無償

目次

PlantUMLプラグインのインストール

IntelliJ IDEAを起動してメニュより「File」→「Settings」→「Plugins」の画面の下部にある「Browse repositories...」を押下します。そこで開いた画面上部の検索ボックスに"PlantUML"と入力すると、"PlantUML integration"というプラグインが出てくるので「install」を押してインストールしましょう。
インストールが完了したら、IntelliJ IDEAを再起動して有効化します。
f:id:jainders:20180216153840p:plain
f:id:jainders:20180216153846p:plain

Graphvizをダウンロード

図の表示にはGraphvizを使用します。以下からサイトにアクセスしてstable版(msiまたはzip)をダウンロードしてきます。
http://www.graphviz.org/download/
ダウンロードしたら解凍して"C:\Program Files (x86)\graphviz-2.38\"のように配置します。
f:id:jainders:20180216154117p:plain

IntelliJ IDEAでGraphvizの設定

メニュより「File」→「Settings」→「Other Settings」を選択すると画面に"PlantUML"のリンクがあるのでクリックします。
Graphviz dot executable」の入力欄に先ほど配置したgraphviz配下にあるdot.exeのパスを入力します。
例:C:\Program Files (x86)\graphviz-2.38\release\bin\dot.exe
f:id:jainders:20180216154452p:plain

UMLの作成

適当なプロジェクト上で右クリックして「UML xxxx」を選択して作成します。今回はUML Classでファイル名はSampleClassで決定にします。
f:id:jainders:20180216154504p:plain
するとSample.pumlというファイルが作成され、デフォルトで以下が記述されており、右側に図が表示されます。

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml

f:id:jainders:20180216154627j:plain