同時変更が生じたTemplate Method パターンの適用事例の調査 ○齋藤晃，吉田則裕，松下誠, 井上克郎大阪大学情報科学研究科井上研究室 2009/2/23 1 目次  背景  問題点  調査内容  調査方法 提案メトリクスの説明  調査結果  評価とまとめ 2 背景:デザインパターンの重要性デザインパターンとは  オブジェクト指向設計に関する典型的な問題の解決策  クラスの保守性・再利用性が向上   熟練者が過去に蓄積したノウハウ Gammaらの提案した23個のパターンが有名[1] Template Methodパターン  デザインパターンの１例  多くの既存コードで使用されており，ソースコードから検出も比較的容易  他のパターンの一部としてよく使われている [1] E .Gamma, R. Helm, R. Johnson, and J. M. Vlissides. Design Patterns: Elements of Reusable Object-Oriented Software. Addison Wesley, 1995. 3 Template Methodパターン親クラスのあるメソッド内で抽象メソッドを呼ぶ Figure PrimitiveOperation abstract draw(Graphics g) drawFigure() ・・・・・・・・・・・ TemplateMethod 抽象メソッド void drawFigure(){ g.cleargraphics(); draw(g); ・・・ } １つ以上のクラスが継承 Circle Rectangle Triangle draw(Graphics g) draw(Graphics g) draw(Graphics g) 抽象メソッドをオーバーライドクラス追加 Figure Figure Figure Figure f1 f1 f2 f2 == == new new new new Circle(); Circle(); Rectangle(); Rectangle(); Figure f3 = new Triangle(); f1.drawFigure(); f2.drawFigure(); f1.drawFigure(); f2.drawFigure(); 異なる処理を f3.drawFigure(); 共通のインターフェースで動作変更範囲を限定することで保守性が向上 4 問題点(1/2)  Template Methodパターンの適用事例の中には，安定性が低いものが存在  安定性が低い…ソフトウェア保守において多くのクラスに変更が生じる・・・・・ Version1.0 Version1.1 Version1.2 1つだけ変更 Version1.3 ・・・・・ Version1.0  Version1.1 Version1.2 複数のクラスが変更 Version1.3 多くのクラスに同時に変更が生じるのは望ましくない 5 問題点(2/2) –同時変更の例 関連するクラス全てを同時に変更する必要がある Figure abstract draw(Graphics g) drawFigure() abstract draw() drawFigure() Circle Rectangle Triangle draw(Graphics g) draw(Graphics g) draw(Graphics g) 変更変更変更  Figure 変更 Circle Rectangle Triangle draw() draw() draw() パターンの適用により同時変更が生じる 6 研究内容デザインパターンの安定性を低下させる要因を調査安定性が低い‥同時変更が生じやすい安定性を低下させる要因は何か？仮説：子クラスの処理内容の差異が大きいほど同時変更が生じやすい仮説を設定した理由  差異が大きいと子クラスごとに処理を切り替えることが難しくなり，親クラスに変更が波及する  同時変更が生じやすくなる 7 仮説の検証方法仮説子クラスの処理内容の差異が大きいほど同時変更が生じやすい検証方法手順１：同時変更の検出  同時変更が生じたクラスとそうでないクラスに分類手順２：クラスの処理内容の差異を表すメトリクスを定義手順３：それぞれのメトリクス値を比較・評価  マン・ホイットニーのU検定を使用 8 調査する同時変更    抽象メソッドのメソッド定義の変更抽象メソッドの数の変更 Template Methodの消滅これらの変更の有無を調査 SuperClass SuperClass templateMethod() primitiveOperation() templateMethod() anotherMethod() primitiveOperation() primitiveOperation(int) primitiveOperation2() SubClass1 SubClass2 primitiveOperation() primitiveOperation() 変更前 SubClass2 SubClass1 primitiveOperation() primitiveOperation() primitiveOperation(int) Operation1() primitiveOperation(int) Operation() primitiveOperation2() primitiveOperation2() 変更後 9 手順１．同時変更の検出抽象メソッドが変更の前後で以下の条件を満たせば，同時変更は生じていないと判定条件a: 同一のクラス名を持つクラスで定義されている YES NO クラス消滅条件b: 同一のメソッド名を持つTemplate Methodから呼び出されている YES NO Template Methodが同一のクラス名を持つクラスで定義されている NO YES 抽象メソッドの数の変更 Template Method消滅条件c: 同一のメソッド定義を持つ YES 同時変更なし NO Primitive Operationの定義が変更 10 手順２．処理内容の差異を表すメトリクスを計測クラスの処理内容の差異を表すメトリクスを定義  型名類似度SimT  メソッド内で利用された型名に着目  識別子名類似度SimⅠ  メソッド内で利用された型名を除く識別子名に着目 11 型名類似度SimT 1/2 メソッド内の一時変数・参照変数の型名と呼び出されるメソッドの引数・戻り値の型名の一致割合 Scanner1クラスのnewScannerメソッド protected Scanner newScanner() { ZipScanner zs = new ZipScanner(); zs.setEncoding(encoding); defaultEncoding = false; String return zs; boolean } AbstractScanner templateMethod abstract newScanner() Scanner1 Scanner2 newScanner() newScanner() Scanner2クラスのnewScannerメソッド protected Scanner newScanner() { TarScanner zs = new TarScanner(); defaultEncoding = false; return zs; boolean } 抽象メソッドをオーバーライドメトリクス計測対象となるメソッド 12 型名類似度SimT 2/2 メソッド内の一時変数・参照変数の型名と呼び出されるメソッドの引数・戻り値の型名の一致割合 Scanner1クラスのnewScannerメソッド protected Scanner newScanner() { ZipScanner zs = new ZipScanner(); zs.setEncoding(encoding); defaultEncoding = false; String return zs; boolean } Scanner2クラスのnewScannerメソッド protected Scanner newScanner() { TarScanner zs = new TarScanner(); defaultEncoding = false; return zs; boolean } T1 = {boolean, String, ZipScanner} T2 = {boolean, TarScanner} メトリクス値 n T i SimT = i 1 n = 0.25 T i i 1 13 識別子名類似度SimⅠ 1/2 メソッド内の一時変数・参照変数の識別子名と呼び出されているメソッド名の一致割合(ただし型名は除く) Scanner1クラスのnewScannerメソッド protected Scanner newScanner() { ZipScanner zs = new ZipScanner(); zs.setEncoding(encoding); defaultEncoding = false; return zs; } AbstractScanner templateMethod abstract newScanner() Scanner1 Scanner2 newScanner() newScanner() Scanner2クラスのnewScannerメソッド protected Scanner newScanner() { TarScanner zs = new TarScanner(); defaultEncoding = false; return zs; } 抽象メソッドをオーバーライドメトリクス計測対象となるメソッド 14 識別子名類似度SimⅠ 2/2 メソッド内の一時変数・参照変数の識別子名と呼び出されているメソッド名の一致割合(ただし型名は除く) Scanner1クラスのnewScannerメソッド protected Scanner newScanner() { ZipScanner zs = new ZipScanner(); zs.setEncoding(encoding); defaultEncoding = false; return zs; } Scanner2クラスのnewScannerメソッド protected Scanner newScanner() { TarScanner zs = new TarScanner(); defaultEncoding = false; return zs; } Ⅰ1 = {defaultEncoding, zs， encoding, setEncoding} Ⅰ2 = {defaultEncoding, zs} メトリクス値 n I SimⅠ = i i 1 n I = 0.5 i i 1 15 変更の検出およびメトリクス計測の流れソースコードソースコードソースコードバージョン1.0 バージョン1.1 バージョン1.2 バイトコードバージョン1.0 バイトコードバイトコードバージョン1.1 バージョン1.2 入力：Javaソースコード：Javaバイトコード 1.Template Methodパターン検出デザインパターン検出ツール[2] メソッド名，クラス位置などの情報を取得調査ツールメトリクス計測ツール分類処理部 2.変更の有無による分類分類データ変更有パターン変更無パターン 3.メトリクス計測 4.変更の有無とメトリクス値の関係を評価出力：メトリクス値 [2]Nikolaos Tsantalis,Design pattern detection using similarity scoring. IEEE Transactions on Software Engineering, 2006 16 メトリクス計測結果  調査対象：オープンソースソフトウェア3種  ArgoUML, JFreeChart, JHotDraw  変更なし：120個，変更あり：44個第３四分位型名類似度類似度識別子名類似度類似度中央値第１四分位変更なし変更あり変更なし変更あり同時変更が生じたパターンの適用事例ほうが類似度が低い傾向  マン・ホイットニーのU検定で有意差  型名類似度：P=0.0014, 識別子名類似度：P=0.0053  17 結果の分析  提案した類似度が低く，変更が生じた例 FigCallAction::layoutActivations SimⅠ = 0.0, SimT = 0.0 protected void layoutActivations() { if (!getSrcFigObject().hasActivations()) { getSrcFigObject().makeActivation( getSrcFigObject().getObjectNode(), (Node) getSrcLinkPort()); ・・・ } else { ・・・処理を記述 } } FigCallAction::layoutActions FigLink layoutEdge abstract layoutActivations FigCallAction FigReturnAction layoutActivations layoutActivations protected void layoutActivations(){ //TODO: Auto-generated method stub } 処理を記述していない  次のバージョンでTemplate Methodが消滅特別研究発表会処理内容の差異が原因で，Template Methodが消滅 2009/2/23 18 本調査の妥当性本調査の妥当性に影響を及ぼす要因  適用事例検出ツールの誤検出  しかし，使用したツールは適合率が高く，対象とした Template Methodパターンは検出が比較的容易であるため，影響は小さいと考えられる  クラス名のみが変更されたときの誤検出  クラス内部が変更されずに，クラス名のみが変更された場合，クラスが消滅したと扱われるまとめと今後の課題まとめ    Template Methodパターンの適用事例の安定性を低下させる要因を調査識別子名類似度・型名類似度の安定性との関係マン・ホイットニーのU検定で有意差今後の課題    他のパターンへの適用同時変更が生じやすい適用事例を自動的に特定安定性の低い適用事例が実装されたら警告する機能を統合開発環境に実現 20 ご静聴ありがとうございました 2009/2/23 21 質疑応答 22 関連研究 Biemanらは，デザインパターンの適用事例を用いたプログラムの評価を行うために，以下の仮説を調査仮説1. 規模の大きなクラスは変更されやすい．仮説2. デザインパターンが適用されているクラスはそうでないクラスより変更されにくい．仮説3. 継承によって再利用されているクラスはそうでないクラスより変更されにくい．  仮説1に従う傾向が得られたが，仮説2,3に反する結果となった本調査ではデザインパターンの適用事例の評価基準として変更頻度が高くなる要因に着目した [2] J.Bieman, D.Jain, and H.Yang. OO design patterns, design structure, and program changes: an industrial case study. ICMS ’01 , pp. 580–589, 2001. [3] J.Bieman, G.Straw, H.Wang, P.Munger, and R.Alexander. Design patterns and change proneness: An examination of five evolving systems. METRICS ’03 , pp. 40–49, 2003. 検定について  得られたデータは正規分布とは言えなかった  両側に値が寄っているため  コルモゴロフ-スミルノフ検定(KS検定)で確認  マン・ホイットニーのU検定  ノンパラメトリック検定の１つ  順位和による差異を検定帰無仮説：2群の代表値に差がない(代表値R1= R2:) 対立仮説：2群の代表値に差がある(代表値R1< R2:片側検定) 特別研究発表会 2009/2/23 24 仮説２について仮説２：子クラスの処理内容の規模が大きいほど変更されやすい LOC平均  LOC平均を計測   U検定で有意差なし (P= 0.139)  処理内容の規模と同時変更の差異に相関は見られなかった平均 LOC 変更なし特別研究発表会変更あり 2009/2/23 25 LOC分散について  子クラスの抽象メソッドの差異を計測対数(標準偏差)で表示類似度変更なし  変更あり U検定でP値0.0467 特別研究発表会 2009/2/23 26 計測したメトリクス値(1/2) LOC平均 LOC分散特別研究発表会 2009/2/23 27 計測したメトリクス値(2/2) 識別子類似度型名類似度特別研究発表会 2009/2/23 28 変更結果の例  子クラスの処理差異が変更の要因となっているか？ SubClass1 SimⅠ = 0.0, SimT = 0.0 protected boolean isValidElement(MBase o){ return o instanceof MAssociationRole … } SubClass2 protected boolean isValidElement(MBase elem){ return elem instanceof MAssociation … } 引数がObjectに変化処理差異が変更の要因になっている特別研究発表会 2009/2/23 29 計測したメトリクスについて  型名類似度と識別子名類似度の相関  相関係数0.567  変更なし：0.511  変更あり：0.803 LOC分散  U検定でP値0.0467  危険率５％で有意差変更なし変更あり 250 60 200 50 40 150 30 100 20 50 10 0 0 0 5 10 15 20 25 30 35 40 45 50 55 特別研究発表会 0 5 10 15 20 25 30 35 40 45 50 55 60 2009/2/23 31 LOC平均  U検定でP値0.1392 変更あり変更なし 50 45 40 35 30 25 20 15 10 5 0 250 200 150 100 50 0 0 10 20 30 40 50 60 70 80 90 100 110 特別研究発表会 0 10 20 30 40 50 60 70 80 90 2009/2/23 32 識別子名類似度  U検定で有意差(P=0.0053) 変更が生じなかったパターン数変更が生じたパターン数 120 120 100 100 80 パターン 60 数 40 パターン数 80 60 40 20 20 0 0 0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1 識別子類似度 0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1 識別子類似度型名類似度  U検定で有意差(P=0.0014) 変更が生じなかったパターン数 80 70 60 50 パターン 40 数 30 20 10 0 変更が生じたパターン数 80 70 60 50 パターン 40 数 30 20 10 0 0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1 型名類似度 0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1 型名類似度計測するメトリクス(1/2) 子クラスのLOC平均LOCa  子クラスのLOC分散LOCv  識別子類似度SimⅠ   メソッド内で定義される一時変数・参照変数の識別子名と呼び出されている関数名の一致割合  型名類似度SimT  メソッド内で定義される一時変数・参照変数の型名と呼び出される関数の引数・戻り値の型の一致割合特別研究発表会 2009/2/23 35 同時変更の判定アルゴリズム 1/2 変更の前後で以下の条件を満たせば，同時変更は生じていないと判定条件１．同一のクラス名を持つクラスで定義されている条件２．同一のメソッド名を持つTemplate Methodから呼び出されている条件３．同一のメソッド定義を持つ 36