plantUML の備忘録: 趣味の徒然

2018年08月21日

plantUML の備忘録

UMLによるモデリング方法の備忘録

plantUMLのインストールから使い方までの備忘録

始めに

システム構築を行う際に、UML（モデリング手法）を利用することで、効率的に検討/設計を行うことができる。
今回は、plantUMLの使い方を記載する。

インストール

plantUMLを利用できるソフトはいくつかあるが、今回は無償で利用できるvisual studio codeの利用を念頭に置く。
今回は、windowsで説明するが、以下の 3つをインストールする。

【インストールする必要があるソフトウェア（windows）】
1). Visual Studio Code
2). Java
3). Graphviz

【インストール後にやるべきこと】
1). Visual Studio Code を立ち上げ、「拡張機能」で「PlantUML」をインストール
2). 「コントロールパネル」→「システムとセキュリティ」→「システム」→「システムの詳細設定」→「環境設定」の「環境変数」を開く
2-1). 「ユーザーの環境変数」に新規で「変数：JAVA_HOME、値：C:\ProgramFile (x86)\Java\jdkx.x.x_xxx」を追加
2-2). 「ユーザーの環境変数」に新規で「変数：GRAPHVIZ_DOT、値：C:\ProgramFile (x86)\Graphvixx.xx\bin\dot.exe」を追加
2-3). 「システム環境変数」の変数：Pathに「値：C:\Program File (x86)\Common Files\Oracle\Java\javapath」の追記

以上でplantUMLを利用できる環境は整う。

plantUMLの使い方

plantUML用の拡張子は、.puとなる。
試しに、test.puなど適当なファイルを作成して、VScodeで開く。
ここに、以下のように記載する。


    @startuml test squence
    A -> B
    @enduml

VScodeで編集している.puファイルで「Alt + D」を押すと、新しいタブが開かれて、plantUMLが画像形式で表示されるようになっているはずである。
うまくいかない場合は、表示されたエラーを確認してほしい。（環境変数などの設定がおかしい場合が多いと思う）
また、plantUMLの出力を.pngなどの形式でも保存することができる。「Ctrl + Shift + P」を押すと出力形式を選択することができると思う。
そこで、「PlantUML：ファイル内のダイアグラムのエクスポート」を選択し、出力する拡張子を選択すれば、.puファイルの階層に新たにファイルが作成され、その中にエクスポートしたファイルが存在することだろう。

最後に、UMLの使い方などは、このような本を読んでいただくと理解しやすいと思う。