クラス図とシーケンス図の整合性確保マニュアル

Size: px

Start display at page:

Download "クラス図とシーケンス図の整合性確保マニュアル"

ひでかみしま
5 years ago
Views:

1 Consistency between Class and Sequence by SparxSystems Japan Enterprise Architect 日本語版クラス図とシーケンス図の整合性確保マニュアル (2011/12/6 最終更新 ) 1

2 1. はじめに UML を利用したモデリングにおいてクラス図は最も利用される図の 1 つですクラス図は対象のシステムなどの構造をモデリングするために利用されます一方で振る舞いについてはクラス図では表現できないため振る舞い図を利用してモデリングする必要があります振る舞い図の中ではシーケンス図が最も多く利用される図ですクラス図とシーケンス図の組み合わせで設計する場合にはクラス図とシーケンス図の間の整合性を確保することが重要になりますこのドキュメントでは無料で配布しているシーケンス図チェックアドインを利用しこの整合性を効率的に確保する方法について説明しますなおこのドキュメントでは Enterprise Architect9.2 ビルド 920 を利用しています異なるバージョンビルドでは表示内容などが異なる場合があります 2. クラス図のモデリング多くの場合にはシーケンス図等の振る舞い図より先にクラス図で全体の構造をモデルとして表現しますこのドキュメントでも先にクラス図を作成するという仮定で話を進めますクラス図でのモデリングではそれぞれのクラスに対して属性や操作を定義しますこの属性や操作を過不足なく定義することが重要です一方でクラス図のみに着目していても属性や操作の過不足がないかどうかを判断することは非常に困難ですこのドキュメントでは一例として簡単なメール送受信ソフト ( メーラー ) を題材にします多くの方がメーラーを日常的に利用していますのでメーラーのクラス図を書きなさいというとある程度はクラス図を書くことができるのではないかと思います一例としてここでは以下のようなクラス図を考えました 2

3 フォルダ 1 メーラーメール新規作成 () 1 1 名前フォルダ作成 () フォルダ削除 () フォルダ名前変更 () * 1 * タイトル本文メール 1 1..* 宛先メールアドレス送信 () なお上記の例のように可視性や型などの情報は非表示にすることで注目すべき点に着目できます 3. シーケンス図のモデリング一方でクラス図で定義した内容が適切かどうかクラス図だけで検証することは困難ですレビューを経ることで不足している内容が見つかることは少なくありませんが必要かどうかを判断することは容易ではありませんこのような場合にはシーケンス図等の振る舞い図を利用して振る舞いをモデリングすることにより状況を洗い出すことが有効ですここではクラス図の検証のためにシーケンス図を利用します具体的にはユースケースのそれぞれに対して正常系と異常系のシーケンス図を作成することになります正常系は通常 1 つのユースケースに対して 1 つですが異常系はその内容に応じて複数存在することが多いです 1 つのシーケンス図に複数の異常系を表現したり正常系と異常系を複合フラグメントを利用して 1 つのシーケンス図に同居させることも可能ですしそれぞれの状況毎にシーケンス図を作成することもできます Enterprise Architect ではクラス図で作成したクラス要素をプロジェクトブラウザか 3

4 らシーケンス図にドロップすることでシーケンス図で利用することができますシーケンス図でメッセージを作成するとクラス図で定義した操作 ( メソッド ) を選択して利用することができます以下の画像はバージョン 9.2 以降でメッセージの作成時に表示されるシンプルプロパティ画面のコンボボックスでクラス図で定義した操作を選択している状況の例ですこのようにしてシーケンス図を作成することでそれぞれのクラスの操作が不足なく定義されているかどうかを確認することができますではコンボボックスの選択肢に必要な操作 ( メソッド ) が存在しない場合つまり不足を見つけた場合にはどのようにすればよいのでしょうかこのような状況の対応方法 1 つはクラス図に戻り該当のクラス要素に操作を追加してから再度シーケンス図でメッセージの操作を選択する方法がありますしかしこの方法は非効率です ( 理由は後述します ) このような状況ではメッセージのコンボボックスから選択するのではなく必要な操作の内容を直接入力します以下の例で利用者からメーラーへのメッセージの送信ボタン押下は先ほどのクラス図には定義されていなかった操作ですメッセージのプロパティ画面で名前に直接送信ボタン押下と入力しました 4

5 メーラーメール利用者送信ボタン押下 () 送信 () 一方でここで入力した送信ボタン押下はこの時点ではクラス図のメーラークラスには追加されていませんメッセージを作成する都度クラス要素の操作として追加するという方法もありますがこの方法には以下の問題がありますこの時点ではこのシーケンス図の内容は作成中でありこの図の内容の作成が進むにつれて作成済みの内容を変更する可能性もあるそのたびにクラス要素クラス図の内容が変わるのは混乱を招く ( クラス図やクラス要素は他の設計者も共有し参照しているという前提 ) 今後設計が進むにつれてメッセージが変更削除される場合もあるので作成した直後にクラス要素にも修正を加えるのが良い方法とは限らない作成したメッセージを削除した場合クラス要素に操作として残すのかそれとも削除するのかツールとしては判断することが難しい ( つまり追加は自動的に行われ削除は手動になるという非対称の動作になる ) そのためシーケンス図の作成中 ( 設計中 ) にリアルタイムに操作として追加する ( あるいはツール側で自動的に追加される ) のは適切とは言い切れません一方でこのようにしてシーケンス図側で名前入力した場合に以下の問題がありますクラスの操作から選択して設定したメッセージと直接入力して名前を設定したメッセージの区別が付かない 5

最終的にはクラス要素の操作として反映する必要があるがいつどのような方法で反映させるのかこの問題は無料のシーケンス図チェックアドインを利用することで解決できますアドインが有効になっていればメインメニューからアドイン拡張アドインサブウィンドウを実行すると表示することができます ( このアドインについては 6.

6 最終的にはクラス要素の操作として反映する必要があるがいつどのような方法で反映させるのかこの問題は無料のシーケンス図チェックアドインを利用することで解決できますアドインが有効になっていればメインメニューからアドイン拡張アドインサブウィンドウを実行すると表示することができます ( このアドインについては 6. シーケンス図チェックアドインについてもご覧ください ) 作成済みの全てのシーケンス図の内容を完成させた段階でこのアドインを利用してクラス図とシーケンス図の間の整合性を確保しますシーケンス図の内容のレビューを行う場合にはレビュー中にこのアドインも起動し内容のレビューと整合性確認を同時に進めると効果的です ( まずシーケンス図のそれぞれのメッセージが妥当かどうかをレビューによって確認し妥当な場合でクラス図に操作が存在しない場合にはこのアドインを利用して操作を追加する ) 先ほどのシーケンス図を例にしますとこのアドインが表示されている状況でシーケンス図内の要素をクリックしますすると下の図のようにメッセージの内容を検証することができます 6

この例では対応の欄がつまりクラス図に操作として存在しないことを示していますこの場合に該当の行をダブルクリックすることでクラスの操作として追加することができますまた既存の操作に差し替えることができます以下の例をご覧くださいこの例ではシーケンス図の作成中にはフォルダ追加と直接入力しましたが実はフォルダ作成という名前の同機能の操作が既に存在しましたつまり

7 この例では対応の欄がつまりクラス図に操作として存在しないことを示していますこの場合に該当の行をダブルクリックすることでクラスの操作として追加することができますまた既存の操作に差し替えることができます以下の例をご覧くださいこの例ではシーケンス図の作成中にはフォルダ追加と直接入力しましたが実はフォルダ作成という名前の同機能の操作が既に存在しましたつまりフォルダ追加という操作を新規に追加することは適切ではなく既存のフォルダ作成を利用するようにしなければなりません右クリックすることで既存の操作をコンテキストメニューの項目として表示します希望する操作を選択することで差し替えることができますなおこのシーケンス図チェックアドインでは以下の内容の確認も可能ですこれらの機能を利用することでクラス図とシーケンス図の間の整合性を確認することができます 7

この整合性に問題がある状況を作りましたクラスタブではクラス要素間の関係と整合しているかどうかを確認することができます ) なお

8 private な操作を外部から呼び出していないかどうかクラス要素間で関係がないにもかかわらずシーケンス図でメッセージを送信していないかどうか ( 以下の例ではクラス図で関係のない宛先クラスを配置してこの整合性に問題がある状況を作りましたクラスタブではクラス要素間の関係と整合しているかどうかを確認することができます ) なおメッセージの戻りを属性に格納する場合にプロパティ画面の割当に入力することでクラス要素の属性とシーケンス図の整合性も確認できます下の図では属性タブに表示される内容で属性についての整合性を確認しています 8

9 4. 整合性の最終確認ここまで説明した方法で以下の内容ができました 1. まずクラス図で全体の構成クラスを定義する 2. それぞれのクラスの属性や操作を定義する 3. さまざまな状況でのシーケンス図を作成することで不足している操作や属性を発見する 4. レビュー後最終的にクラスに追加すべき項目をクラス要素に追加する一方でここまでの手順の中では上記の 2 番で定義した操作や属性のうちどこのシーケンス図でも利用されていないものつまり過不足の過を見つけることができていませんこの過を見つけるためにクラス図を開きますシーケンス図チェックアドインが表示されている状態でクラス図やプロジェクトブラウザ内で操作や属性を選択しますするとその操作が利用されているシーケンス図の情報が表示されます下の例の場合にはフォルダ作成の操作はフォルダ追加シーケンス図の 2 番目のメッセージに利用されていることが分かります ( 一覧内の行をクリックすると該当のシーケンス図が開きます ) 9

10 一方でフォルダ削除の操作を選択した場合にはこの一覧に何も表示されませんこれは次のいずれかの状況であることを示していますこの操作はどこのシーケンス図でも利用されていないので不要であるこの操作が含まれるシーケンス図の作成作業が漏れている不要な場合には操作を削除しこの操作が必要な場合には対応するシーケンス図を作 10

11 成して設計内容を検討検証しますこのようにすることでクラス図とシーケンス図の間の過不足をなくし整合性を確保することができます 5. まとめクラス図とシーケンス図の整合性確保は無料のシーケンス図チェックアドインを利用することで実現できますこの段階で考慮漏れや無駄のないクラス図を定義することによりこの後の工程の無駄を省くこともできますぜひご活用ください! 6. シーケンス図チェックアドインについてこのドキュメントで利用しているシーケンス図チェックアドインは Enterprise Architect で無料で利用できるアドインです利用するためにはインストール時に表示される機能選択の画面で以下のようにシーケンス図チェックアドインをインストール対象に追加してください 11

12 このアドインについての詳細はヘルプファイルのシーケンス図チェックアドインのページをご覧ください 12

モデリング操作ガイドアクティビティ図編

モデリング操作ガイドアクティビティ図編 Modeling Operation Guide by SparxSystems Japan Enterprise Architect 日本語版モデリング操作ガイド ( アクティビティ図編 ) (2018/09/25 最終更新 ) 目次 1. はじめに... 3 2. アクティビティ図固有の要素操作... 4 2.1. レーン... 4 2.1.1. パーティション要素を利用する... 4 2.1.2.

クラス図とシーケンス図の整合性確保 マニュアル

クラス図とシーケンス図の整合性確保マニュアル