PythonとVisual Studio Codeを使用してUMLを描く方法について説明します。この記事では、Windows環境にVisual Studio CodeとPlantUMLをセットアップする手順を説明します。
PlantUMLとは
PlantUMLは、以下のような図をテキストで素早く描くためのオープンソースプロジェクトです。
- シーケンス図 / Sequence diagram
- ユースケース図 / Usecase diagram
- クラス図 / Class diagram
- アクティビティ図 / Activity diagram
- コンポーネント図 / Component diagram
- 状態遷移図 / State diagram
- オブジェクト図 / Object diagram
環境
以下の環境で動作確認しました。
- Windows 10 Pro (64bit)
- Visual Studio Code 1.11
- Java SE Runtime Environment 8 Update 121
- Graphviz 2.38
- PlantUML 1.4.0 (plugin)
セットアップ
Visual Studio Codeのインストール
- Visual Studio Codeを開く
- [Download for Windows]を押してインストーラーをダウンロードする
- ダウンロードしたインストーラーを実行する
PlantUMLのセットアップ
- Javaのインストール: PlantUMLの実行には、Javaの実行環境が必要となります。
- Graphvizのインストール: PlantUMLがUMLを描画するために使用しているソフトウェアです。
- PlantUMLのインストール: Visual Studio MarketplaceでPlantUMLをインストールします。
動作確認
- プレビュー表示: Visual Studio Codeを起動し、拡張子.puで新規ファイルを作成します。
- 画像ファイルとして出力: “Ctrl + Shift + P”でコマンドパレットを開き、PlantUML: Export Current Diagramと入力します。
以上がPythonとVisual Studio Codeを使用してUMLを描く方法になります。この方法を使えば、テキストでUMLを描けるため、Gitで管理しやすくなります。また、図の細かいレイアウト調整などを気にしなくても良いので、非常に便利です。.