UML書いてますか。
UMLを書くツールはいろいろあれど、PlantUMLはWindows系開発者にもUNIX系開発者にも等しくおすすめです。
PlantUML
PlantUMLは、UMLの各種構造を書き下ろしたテキストファイルをコンパイルして画像に変換してくれるソフトウェアです。何が素晴らしいって、各オブジェクトの配置を自動で調整してくれるところが最高。
図形ソフトとかAstahとかでクラス図を描き始めて、途中からクラス構造よりも図形の配置にばっかり悩んでいたなんて経験はありませんか。これがすべてコンピュータに任せられるのです(チューニングの手間はちょっとありますがね)。
配置に悩むのはコンピュータの仕事、我々が悩むのは論理構造、最高の分業じゃないですか。ですからPlantUML使いましょう。
PlantUMLのインストール
PlantUML自体は単独のjarファイルです。なので好きな場所においてコマンド呼び出しするだけ。あ、Javaランタイムが必要。
バックグラウンドでGraphVizという画像生成ソフトを呼び出すのでインストールしておく必要があるのですが、インストーラ任せで入れておけばPlantUMLが自力で探し出して使ってくれます。
あとは
java -jar 【フルパスで】\plantuml.jar 【ソースファイル】
でPNG画像が、
java -jar 【フルパスで】\plantuml.jar 【ソースファイル】 -svg
でSVGアートワークが吐き出されます。
日本語を使う場合のポイントですが、WindowsならシフトJISで書くのがいまのところ一番面倒もトラブルも少ないですね。
Windowsフォト ビューアー
Windowsに標準で付いている画像ビューア、これにはPlantUML開発作業に必要なたった一つの大事な機能を持っています。それは、 ファイルが更新されたらリロード してくれること。最高です。コンパイル結果は実行と同時に確認できるのです。素晴らしい。
ソースファイル保存と同時にコンパイル
そして最後のピースが、ファイル監視コンパイルです。これで、エディタでctrl + sを押すと同時にプレビューが更新されるという最高の編集環境が完成します。
使うのはOMake。makeを拡張したソフトウェアでありmakefileとほぼ同じルールでコンパイル手順が書けるのですが、目玉機能が変更監視です。使い方は簡単。
- UMLソースを置くディレクトリで
omake -install
- 生成された omakefile を次のように書き換えます。 ただし、ソースファイルの拡張子を.pumlとした場合です。決まった拡張子があるわけではないのでお好みで。
%.png: %.puml java -jar 【フルパスで】\plantuml.jar $<%.svg: %.puml java -jar 【フルパスで】\plantuml.jar $< -svgpumlfiles=$(glob *.puml)pngfiles=$(pumlfiles:.puml=.png)svgfiles=$(pumlfiles:.puml=.svg).PHONY: allall: $(pngfiles) $(svgfiles).DEFAULT: all
omake -P
これでOMakeが監視状態に入り、その時点で存在したソースファイルについて監視し続けてくれます。新しいファイルを追加した場合には一旦ctrl + cで終了させて再度起動してください。