PlantUML インストール方法

これまでUMLを記述するのには、仕事でも個人でもastah* communityを利用していました。astah* communityはバージョン7.0から商用利用不可となりましたが、私のUMLの用途はシステムの概要を説明するために簡単なクラス図とシーケンス図を使っていただけでしたので、有料版を購入するほどのものでもありません。そこでその代替となるツールを探してみることにしました。

Qiitaで人気そうなのはテキストでUMLを記述できるPlantUMLというツールでした。少し使ってみたところ、記法はシンプルで覚えやすく、テキストのために差分比較もでき、Atomのプラグインを利用することでリアルタイムプレビューもできるため、中々使いやすいと感じました。大規模の図では探したい場所をテキスト中から探すのにが大変になるかもしれませんが、私の用途では全く困らなそうです。

以下では、PlantUMLのインストール方法を簡単にご紹介しています。

PlantUML

• UMLをテキストで記述するための言語（DSL）
• 対応しているUMLのダイアグラム
  • シーケンス図
  • ユースケース図
  • クラス図
  • アクティビティ図
  • コンポーネント図
  • ステートマシン図
  • オブジェクト図
  • 配置図（ベータ版）
  • タイミング図（ベータ版）

Webサイトで簡単に試す

• 公式WebサイトでPNG, SVG, アスキーアートに変換できます。
• 変換したUMLにはURLが発行されWebサイトに埋め込むこともできます。
  • http://plantuml.com/plantuml/

Atomでの編集環境を構築する（Windows10）

1. Graphvizをインストールする

   • 下記のURLからインストーラ（.msi）をダウンロードします。
   • http://www.graphviz.org/Download_windows.php

2. Atomを起動してPlantUMLプラグインをインストールする

   • メニューから File -> Settings -> Install を選択します。
   • 「plantuml-viewer」を検索してインストールします。

3. PlantUMLプラグインの設定を更新する

   • メニューから File -> Settings -> Packages -> plantuml-viewer -> Settings を選択します。
     • Charset: UTF-8
     • Graphviz Dot Executable: C:\Program Files (x86)\Graphviz2.38\bin\dot.exe （Graphvizをデフォルト設定のままインストールした場合）