Java設計

コマンドプロンプトからPlantUMLを利用してUMLを図示してみた

ソフトウェアの仕様を分かりやすく表現する手法に、UMLという表記法があり、そのUMLを図示するツールの1つに、PlantUMLがある。

UMLについては、以下のサイトを参照のこと。
http://e-words.jp/w/UML.html

今回は、PlantUMLをコマンドプロンプトから利用し、下記記事の先頭のシーケンス図を図示してみたので、その手順を共有する。
https://qiita.com/ffggss/items/5200f6262cb68396dc15

前提条件

以下のように、Windows端末上にJDK13がインストールされていて、javaコマンドが利用できること。
前提条件_1

前提条件_2

やってみたこと

  1. plantuml.jarのダウンロード
  2. PlantUMLのコード作成と実行

plantuml.jarのダウンロード

plantuml,jarのダウンロードは、以下のサイトにアクセスし、「plantuml,jar」リンクを押下することで行える。
https://plantuml.com/ko/download

PlantUMLのダウンロード

PlantUMLのコード作成と実行

PlantUMLのコードの作成と実行手順は、以下の通り。

1) plantuml.jarを配置したディレクトリと同じ場所に、任意の名前のテキストファイルを作成し、描きたいシーケンス図のPlantUMLのコードを記述
PlantUMLの実行_1_1

PlantUMLの実行_1_2

2) コマンドプロンプトを起動し、cdコマンドで、plantuml.jarを配置したディレクトリに移動
PlantUMLの実行_2

3) 「java -jar plantuml.jar (PlantUMLのコードを書いたテキストファイル)」というコマンドを実行
PlantUMLの実行_3

4) 上記コマンドを実行すると、以下のように、画像のpngファイルが作成されていることが確認できる
PlantUMLの実行_4

作成された画像のpngファイルを表示すると、以下のように、シーケンス図(UML)が作成されていることが確認できる
UML

要点まとめ

  • ソフトウェアの仕様を分かりやすく表現する手法に、UMLという表記法があり、そのUMLを図示するツールの1つに、PlantUMLがある。
  • 「java -jar plantuml.jar (PlantUMLのコードを書いたテキストファイル)」というコマンドを実行することで、(PlantUMLのコードを書いたテキストファイル)に書いたコードのUMLが図示できる。