messyなkitchenなブログ

ただひたすらに散らかった台所や人生やその他を晒す。

MENU

脱W〇rd, 脱E×cel, 脱＠st＠h : #6

PlantUML

ifdef/endif で表示を制御してみる

次のような、記述が長いコンポーネントが存在したとします。

'!define SHOW_LONGTEXT
'!define SHOW_STORY

rectangle myaccident [
  私の身の周りのできごと
!ifdef SHOW_LONGTEXT
  話せば長くなりますが、
  この数年間のできごとを
  伝えなければなりません。
!endif
]

rectangle story [
  始まりは、あの年のことでした。
!ifdef SHOW_LONGTEXT && SHOW_STORY
  奴らの携帯電話のメールがおかしい。
  奴らのパソコンのメールがおかしい。
  奴らの休日の行動がどうもおかしい。
  はい、やつらの（自主規制）、確定。
!endif
]

myaccident --> story

そのままの描画だと、大きな rectangle になってしまいそうですが、 実際には次のようなコンパクトな図になります。

これは先頭2行の !define と、文中の !ifdef !endif により、有効な範囲が制御されているためです。

コメント ' をひとつ、外してみます。

!define SHOW_LONGTEXT
'!define SHOW_STORY
...

するとこんな感じ。

もうひとつ、コメント ' を外します。

!define SHOW_LONGTEXT
!define SHOW_STORY
...

全ての文章が現れました。

!ifdef には、複数の条件を組み合わせることができます。&& ||

また、!ifndef というキーワードもあるようです。

上手に組み合わせて、描画範囲を適切に制御したいな、と。

脱W〇rd, 脱E×cel, 脱＠st＠h : #5

PlantUML

コンポーネントに色を付ける

コンポーネントには色を付けることができます。
多用するとごちゃごちゃしてくるので、注目すべき部分に絞って適用したいところです。

これまでの説明でも何度も出てきていますが、色名称 や 色コード を指定することで、 コンポーネントへの色付けを実現します。

component    "<color:#white>compoA"    as obj1 #red
component   "<color:#white>コンポB"    as obj2 #blue
component   "<color:#white>こんぽC"    as obj3 #green
component   "<color:#white>konpoD"    as obj4 #10A0F0

（この例では、文字の見やすさのため、文字色を白色に設定するタグも書いています）

単色だけでなく、2色を指定し、グラデーションをかけることもできるようです。

component    "<color:#white>compoA"    as obj1 #red-blue
component   "<color:#white>コンポB"    as obj2 #red|blue
component   "<color:#white>こんぽC"    as obj3 #red/blue
component   "<color:#white>konpoD"    as obj4 #red\blue

（この例は、なんだかキタナイ色使いだな・・・）

細かな設定はできませんが、技術資料を作るにあたっては、それは不要でしょう。

脱W〇rd, 脱E×cel, 脱＠st＠h : #4

PlantUML

コンポーネント図でオブジェクトの配置を調整する (together 編)

グループ化するような方法でも、オブジェクトの配置をできます。
together キーワードを使います。

まずは、単純にコンポーネントを作ってみた場合です。

component    compoA  as obj1 #lightpink
component   コンポB  as obj2 #lightblue
component   こんぽC  as obj3 #lightgreen
component   konpoD  as obj4 #lightgray

ここで、B と C を近くに配置したい場合、それぞれを together キーワードで括ります。

component    compoA  as obj1 #lightpink
component   konpoD  as obj4 #lightgray

together {
component   コンポB  as obj2 #lightblue
component   こんぽC  as obj3 #lightgreen
}

前回使った、[hidden] も組み合わせて使用できます。

component    compoA  as obj1 #lightpink
component   konpoD  as obj4 #lightgray

together {
component   コンポB  as obj2 #lightblue
component   こんぽC  as obj3 #lightgreen
obj2 -[hidden]-> obj3
}

コンポーネント間の位置がちょっと気になる場合は、次のような操作を試し、工夫してみてください。

  • 記述順序を変えてみる
  • -[hidden]-> -[hidden]> をうまく使う

脱W〇rd, 脱E×cel, 脱＠st＠h : #3

PlantUML

コンポーネント図でオブジェクトの配置を調整する

PlantUML では、通常は特に指示しなくても、ツールが自動的にいい塩梅にオブジェクトを配置してくれます。

component    compoA  as obj1 #lightpink
component   コンポB  as obj2 #lightblue

オブジェクト同士を接続するときに、次のように hidden キーワードを付与すると 線が描画されずにコンポーネント間の位置関係を調整できます。

component    compoA  as obj1 #lightpink
component   コンポB  as obj2 #lightblue

obj1 -[hidden]-> obj2

component    compoA  as obj1 #lightpink
component   コンポB  as obj2 #lightblue

obj2 -[hidden]> obj1

Note: -[hidden]-> と -[hidden]> が異なることに注意。

次のようなマクロを設定しておくと、便利かもしれません。

/'レイアウト調整用マクロ'/
!define cd(o1, o2)  o1 -[hidden]-> o2    /'Connect to Down'/
!define cr(o1, o2)  o1 -[hidden]>  o2    /'Connect to Right'/

component   compoA  as obj1 #lightpink
component   コンポB  as obj2 #lightblue
component   こんぽC  as obj3 #lightgreen

cd(obj2, obj1)
cr(obj3, obj2)

脱W〇rd, 脱E×cel, 脱＠st＠h : #2

PlantUML

コンポーネント図で四角形を描画する

PlantUML のコンポーネント図において、次の方法で四角形の描画と文字を表示できます。

' 方法1
rectangle   "表示文字 1"    as alias_1
' 方法2
rectangle   alias_2 [
                表示文字 2
            ]

四角形に色を付けたい場合は、色コードを付与します。

' 方法3
rectangle   "表示文字 3"    as alias_3  #red
' 方法4
rectangle   alias_4 #0000FF [
                表示文字 4
            ]

エイリアス名で操作できます。

alias_1 -> alias_2  /' to right '/
alias_3 --> alias_4  /' to down'/

おまけ：オンライン版 PlantUML

脱W〇rd, 脱E×cel, 脱＠st＠h : #1

PlantUML

シーケンス図で "実行仕様" を付与

PlantUML を使って、シーケンス図を描いてみます。
注：UMLとしての記述の厳密さ && 例題は気にしないで。

actor        ann as a    #red
actor       bob as b    #blue

a -> b : attack
a <- b : counter-attack

hide footbox

この例では、2つのオブジェクト (annさんとbobさん) で、メッセージのやり取りをしています。
注：UMLとしての記述の厳密さは、ここでは気にしないでください。

ここで、annさんからbobさんがメッセージを受けてなにかを実行する場合、これを「四角いバー」で示すことができます。

PlantUML では、ライフライン(Lifeline) に 実行仕様 (Execution Specification) （または活性区間）を付与する方法は、いくつかあるようです。

必要な部分に明示する方法 (activate, deactivate)

実行仕様の記述が必要になった部分/不要になった部分に、明示的に記述します。

actor        ann as a    #red
actor       bob as b    #blue

a -> b : attack
activate b
a <- b : counter-attack
deactivate b

hide footbox

自動的に付与する方法 (autoactivate)

autoactivate on を書いておくと、自動的に実行仕様を付与することができます。

actor        ann as a    #red
actor       bob as b    #blue

autoactivate on

a -> b : attack
a <- b : counter-attack

hide footbox

必要な部分に明示する方法 2 (++, --)

実行仕様の記述が必要になった部分/不要になった部分に、明示的に記述します。
前述の方法とは異なり、メッセージ(Message) の記述と同時に、実行仕様を指定できます。

個人的に便利に感じる の使い方です。

actor        ann as a    #red
actor       bob as b    #blue

a -> b ++ : attack
a <- b -- : counter-attack

hide footbox

おまけ: 実行仕様に 色を付ける

メッセージの最後に色コードを付与すると、実行仕様に色が付きます。

actor        ann as a    #red
actor       bob as b    #blue

a -> b ++ #green: attack
a <- b -- : counter-attack

hide footbox

脱W〇rd, 脱E×cel, 脱＠st＠h : #0

PlantUML

なぜ PlantUML を使うことにしたのか

ブロック図を描いたり、シーケンス図を描いたり、けっこうありませんか？

例えば、ソフトウェアコンポーネントの構成図を、Excel でがんばって描いたりします。

資料を描き終わって、レビューが通過し、提出が済みました。
しかしここで間違いに気付いて、一部を修正したとします。

どこを直したか、わかりません。。。

修正履歴があればまだ変化点を追いやすいですが、 Excel のオートシェイプで書かれていたりしたら どうやって比較すればよいものか・・・
マクロで検出したり、目視で調べるというのもありますが・・・

でも、このような図がテキストで生成されているものだとしたらどうでしょう？

修正前のコンポーネント図は、次のようなテキストファイルで記述されています。

component    鬼
component   鬽
component   魂
component   魁
component   鬾
component   鬿
component   魅
component   魃
component   魄
component   䰠
component   魈
component   魍
component   魎
component   魏
component   魌
component   魋
component   魊
component   魔
component   魑
component   魕

修正後のコンポーネント図は、次のテキストファイルです。

component    魘
component   鬽
component   魂
component   魁
component   鬾
component   鬿
component   魅
component   魃
component   魄
component   䰠
component   魈
component   魍
component   魎
component   魗
component   魌
component   魖
component   魊
component   魔
component   魑
component   魕

差分は、diff を使えばすぐに知ることができます。

3箇所に差分がありました。
上記例では文字の変化だけだったので、一つ一つを比較すれば全てを見つけられますが、 シャッフルがあった場合は目視で探し出すのは大変です。
このようにテキストでの比較ができれば、どこが変化したかが検出しやすいですし、 ソースコードバージョン管理システムを使っての管理も容易になります。

PlantUML というツールで、テキストからの描画ができます。
ツールの名前の通り、UML に関連する図の描画が主体です。

必要な図はできる限り、このツールで作るような取り組みを始めています。
私は次のものを主に利用しています。

PlantUML を使っていく中で見つけた・調べた、便利な使い方などを備忘録を兼ねてメモしていこうと思います。

ワードさん、勝手にスタイル適用やめてくらさい。図を貼っていっても、体裁をドタバタしないでくらさい。
エクセルさん、広大なシート上にシェイプでお絵描きしていくと、何がどこに配置してあるかわからんとです。
アスターさん、最近無償版が商用利用できないっす。あと、図の再利用や体裁整えが難しいっす。