tweeeetyのぶろぐ的めも

アウトプットが少なかったダメな自分をアウトプット<br>＼(＾o＾)／

【PlantUML】Mac OS XでPlantUMLを入れて使ってみる（試しにクラス図だけ書いてみました編)

mac PlantUML

はじめに

atlassianのconfluenceのプラグインだかマクロだかでUMLと連携できるやつがあります。
plantUMLです。このplantUMLの導入メモ

連携といってもplantUMLはテキストベースでUMLが書けるので
自前で書いたplantUMLテキストをconfluenceに読み込ませて、UMLの図として表示してくれるという感じですね。

ながれ

  1. plantumlについて
  2. 環境の確認
  3. plantumlいれる
  4. graphvizいれる
  5. 図を書いてみる

1. plantumlについて

こちらはまんま引用させていただきますが、planumlについてと特徴だけ抜粋して載せておきます

plantUmlとは

PlantUMLはテキストからUMLのダイアログを作成するフリーのツールです。
これを使えばUMLをテキストでサクサク書けるようになります。
テキスト派としてはうれしいツールです。

plantUmlのメリット
  • ツールとの連携が可能
    →自分はこれをやりたくて入れました。atlassianのconfluenceと連携させます
  • マージが可能
    →テキストベースなのでgitでのバージョン管理や差分確認ができます
  • 素早く書ける
  • ソースのコメントに書ける
    →Doxygenと組み合わせるとドキュメントが生成可能みたいです

2. 環境の確認

この記事ではjavaとhomebrewが入っている必要があるので確認します。
ターミナルで確認です。

※ 一応macのバージョン確認
# sw_vers
ProductName:  Mac OS X
ProductVersion: 10.9.4
BuildVersion: 13E28

# java -version
java version "1.8.0_20"
Java(TM) SE Runtime Environment (build 1.8.0_20-b26)
Java HotSpot(TM) 64-Bit Server VM (build 25.20-b23, mixed mode)

# brew -v
Homebrew 0.9.5

ない場合は適宜入れてみてください。こちらとか参考に

3. plantumlいれる

インストールというよりは、下記URLにアクセスするとjarをダウンロードしてくるだけなので適当なディレクトリにおきます。
http://sourceforge.net/projects/plantuml/files/plantuml.jar/download

今回はhomeディレクトリの下にplantUmlディレクトリを作ってそこにおきました。

※ ダウンロードされてるか確認
# ls ~/Downloads/palnt*
/Users/hoge/Downloads/plantuml.jar

# mkdir ~/plantUml

# mv ~/Downloads/plantuml.jar ~/plantUml

もちろんGUIからでも大丈夫です

4. graphvizいれる

graphvizとは

Graphviz は、人や物のネットワーク、フローチャート、系統樹などに適したグラフ描画ツールです。
Windows、Mac、Linux など多くの OS で利用できます。

参考にさせて頂いたサイトのまんまパクリですがこいつがなんなのか気になってしまうので
同じような方のために載せておきます。
参考→データのビジュアル化を最少の労力で

brewでインストール
※ まずは探してみる
# brew search /graph/
geographiclib    graphicsmagick     graphviz     libgaiagraphics    open-scene-graph
homebrew/science/graph-tool        homebrew/php/php53-graphdat        homebrew/php/php56-graphdat
homebrew/science/igraph          homebrew/php/php54-graphdat
homebrew/science/lightstringgraph      homebrew/php/php55-graphdat

※ インストール
# brew install graphviz

5. 図を書いてみる

公式サイトのこちらにサンプルがあるのでそのままはっつけて確認してみます。
→PlantUML公式：Class Diagram

# pwd
/Users/hoge/plantUml

※ umlを書いてみる(クラス図)
# vi test.uml
---- vi追記 ----
@startuml
scale 800 width
Class01 <|-- Class02
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 -- Class10
Class11 <|.. Class12
Class13 --> Class14
Class15 ..> Class16
Class17 ..|> Class18
Class19 <--* Class20
@enduml
---------------

※ 図に変換
# java -jar plantuml.jar sample.uml

※ できたのを確認
# ls
plantuml.jar  sample.png  sample.uml

※ 図を確認（デフォルトはプレビューウインドウで画像が開かれます
# open sample.png

まとめ

UMLはいままでastah使ってましたがこっちも使ってみますか！