Practical usage of PlantUML – §1. とりあえず使ってみる

UMLを記述するツールとしては、Enterprise Architectastah*が有名ですが、テキストベースで管理できないため、Gitの構成管理や変更レビューと相性が悪くて扱いにくいときがあります。

ツール自体をディスってるわけじゃありませんで、悪しからず。Enterprise Architectastah*はこれまでの開発でも利用してきたので、優秀なツールであることは間違いと思っています

テキストベースでUMLを記述できたらと思っていましたが、この望みを叶えてくれるのがPlantUMLです。これまで、普段の開発でもPlantUMLを使用してきましたが、ちょうど慣れてきた時期なので、今回は簡単に導入方法や使い方について紹介しようと思います。

ちなみに、PlantUMLがサポートしているUML図は以下の通りです。

  • シーケンス図
  • ユースケース図
  • クラス図
  • アクティビティ図
  • コンポーネント図
  • 状態遷移図(ステートマシン図)
  • オブジェクト図
  • 配置図
  • タイミング図

上記以外にも、salt(GUIを記述するもの)や、ditaa(線画を記述)、ガントチャートなどもサポートしています。

まずは環境整備

ここで紹介する手順は、Ubuntu 18.04 LTSで確認済のものです。インストール手順は使用するOSに依存しますが、必要になるツールはWindowsでも一緒です。

まず、PlantUMLはJava上で動作するツールです。なので、シェル上から以下のコマンドを入力してJavaをインストールしましょう。

 

本記事の執筆時点で、Javaの最新版はJava11のようです。 Java11(Java10でも同様)をインストールした環境で、atomエディタのPlantUMLプラグインを使用している場合、 プレビューがうまく表示されないことがあります。なので、ここでは一番安定していそうな、Java8のインストール手順を紹介しています。

PlantUMLを使うには、Javaの他にGraphvizと呼ばれるグラフ描画ツールも必要になります。これも、Ubuntu 18.04 の場合、以下のようにコマンドラインからインストールできます。

最後に、PlantUMLの本体は、公式ページからダウンロードします。

Figure 1

ダウンロードしてお分かりだと思いますが、PlantUML自体はjarファイルなので、 java -jar plantuml.jar のようにコマンドラインで使用します。

試してみる

まずは、PlantUMLを記述するために適当なテキストファイルを作成してください。以下では、first_uml.pu(拡張子は *.pu とすることが多いようです。)という名前でファイルを作成した前提で説明します。

とりあえず、何も考えずに以下の内容をテキストファイルへ記述します(なお、テキストのエンコードはUTF-8としておいて下さい)。

では、上記を書き終えたらコマンドラインから以下のように入力してください。

すると、以下のようなpngファイルが生成できると思います。

Figure 2

見事にクラス図を生成できました。

では、簡単に上記で試したコマンド引数を解説します。 java -jar plantuml.jar のようにコマンドラインで使用することは先にも触れた通りです。このコマンドに最初に続くオプション -charset ですが、これは想像できると思いますがファイルのエンコードを指定するためのものです。基本的には、UTF-8がここ最近の標準になっていると思いますので、 -charset UTF-8 は常に使用するオプションだと思ってかまいません。そのあとに、 -t オプションで生成画像の種別を指定します。 -tpng でpng画像、 -tsvg でsvg画像を生成できます。最後に、対象のファイル名を指定します。

より詳しいオプションについては、公式ページ-help で確認してください。 -help オプションでだいたいの使い方は分かるかと思います。ちなみに、以下の内容が -help で表示されるものになっています。

 

以上、導入方法と簡単な使い方でした。なお、PlantUMLの文法はマニュアルがあるので、そちらを参照して下さい。少し古いですが、日本語のマニュアルもあるようです。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください