読者です 読者をやめる 読者になる 読者になる

AkiIroブログ

初心者なりにUnityとVRまわりのことについて書いていきます。

初心者の(筆者が)始めるPlantUML

PlantUMLを使ってみる

※適宜読み飛ばしてください。

筆者のあれこれ

  • UMLこてこて初心者
  • PlantUMLを使ってUML自体も勉強したい
  • プロジェクト上での運用を目指す

その前にUMLとは

統一モデリング言語(とういつモデリングげんご、UML、英: Unified Modeling Language)は、主にオブジェクト指向分析や設計のための、記法の統一がはかられた(Unified)モデリング言語(Modeling Language)である。

wikipediaより引用

プログラミングの世界では歴史的に長いこと設計文書の書式の統一化が図られていませんでした。そこで偉い人たちが集まって決めた世界標準言語がUMLです。

詳しくはググってみるとたくさん出てきます。

例えば UML超入門様

PlantUMLの大体

ざくっといえばテキストベースでUMLを書けるツールです。詳しくはプログラマーズ雑記帳様などが詳しく解説をくださっています。

しかし(私にとって)特に重要なのは

  • 短時間で世界標準の図が書ける
  • テキストベースのお作法を守れば間違った図にはそうそうならない

以上です。

間違った図になりにくいことということは、勉強用にも適していることにもなります。

使うメリット

UMLひいてはPlantUMLを使うメリットは私ではあげきれないほどありますが、例えばクラス図であれば典型的には

  • 保守・拡張が容易になる。(そもそも規模が大きくなればドキュメントは必須)
  • チームでの作業の分担が容易になる。
  • 俯瞰的にアーキテクチャを見つめ直すことでリファクタリングの必要に気づける。

以上辺りでしょうか。

本記事を書くにあたって影響をうけたグローバルゲームジャムでクラス設計をやったらスムーズに開発が進んだ話様でも有用性が示されています。

いざ導入

今回はAtomとPlantUMLで爆速UMLモデリング様を参考にして進めました。

筆者の環境は

入ってなければインストールするものは

  1. Atom サイトはこちら
  2. Java サイトはこちら
  3. Graphviz サイトはこちら
  4. Atomの次のパッケージ二つ
    • PlantUML Viewer
    • PlantUML language

Atomのパッケージのインストールはコマンドライン

apm install plantuml-viewer

apm install language-plantuml

としてやると楽です。

書き方

簡単なものであればPlantUML Cheat Sheet様が参考になります。

公式の解説はこちら

例えばこんな風に循環参照してしまっている箇所がビジュアル的に見て取れたりします。素晴らしい! f:id:AkiIro:20160924025928p:plain

まとめ(意気込み)

UMLを使って綺麗なアーキテクチャをつくろう!