Strategyパターンの解説と例題

# はじめに この記事では、デザインパターンの振舞パターンのひとつである、[Strategyパターン]について解説と例題を使って学びたいと思います。 [Strategyパターン]: https://ja.wikipedia.org/wiki/Strategy_%E3%83%91%E3%82%BF%E3%83%BC%E3%83%B3 ## Strategyパターンとは Strategyパターンは、アルゴリズムをカプセル化し、それらを交換可能な形でクライアント(Context)に提供するためのパターンです。つまり、異なるアルゴリズムを柔軟に選択して利用することができます。このパターンでは、アルゴリズムを実装した一連のクラスを定義し、それらを利用するコンテキストクラスと組み合わせて使用します。コンテキストクラスは、必要に応じて異なるアルゴリズムを呼び出すことができます。  <div class="separator" style="clear: both;"><a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEh93QQVvLpNmDhixzRcU09ENx4WD5UyhbkmNsjyxYIipBG3M8-hxhusFjSoqOlg_n8ybW9l8AEMUTJK6b6je89_35HPoDu1-oy2pXUNdiwJso9ym4D20kndxmvPU54XiqJM3sVD5xfMkeWkOKLM2JdE0kl1wvIeFuts3rROgsgPtCf8i0Nya8nE51tLO2A/s386/baseclass.png" style="display: block; padding: 1em 0; text-align: center; "><img alt="" border="0" height="320" data-original-height="386" data-original-width="352" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEh93QQVvLpNmDhixzRcU09ENx4WD5UyhbkmNsjyxYIipBG3M8-hxhusFjSoqOlg_n8ybW9l8AEMUTJK6b6je89_35HPoDu1-oy2pXUNdiwJso9ym4D20kndxmvPU54XiqJM3sVD5xfMkeWkOKLM2JdE0kl1wvIeFuts3rROgsgPtCf8i0Nya8nE51tLO2A/s320/baseclass.png"/></a></div> ## Strategyパターンのメリットとデメリット ### メリット - 柔軟性: アルゴリズムを切り替える必要がある場合でも、Strategyパターンを使用することで簡単に対応できます。新しいアルゴリズムを追加する場合も、既存のコードに影響を与えることなく実装できます。 - 再利用性: Strategyパターンでは、アルゴリズムを独立したクラスとして実装するため、他のコンテキストでも再利用することが容易です。 - テスト容易性: アルゴリズムを独立してテストすることができるため、テストコードの作成やメンテナンスが容易です。 ### デメリット - クラス数の増加: Strategyパターンでは、アルゴリズムごとに独立したクラスを作成する必要があります。そのため、クラスの数が増える可能性があります。 - コンテキストと戦略の結合: Strategyパターンでは、コンテキストクラスと戦略クラスが密接に結合します。そのため、クライアントがコンテキストクラスと戦略クラスを正しく組み合わせる必要があります。 ## Strategyパターンの適用条件と適用例 Strategyパターンは以下のような場合に適しています。 - アルゴリズムを切り替える必要がある場合 - コンテキストとアルゴリズムを疎結合にしたい場合 - 類似したアルゴリズムを複数保持している場合 例えば、ソートアルゴリズムを適用する場合、バブルソートやクイックソートなどの異なるアルゴリズムを使い分ける必要があります。このような場合にStrategyパターンを活用することができます。 ## Strategyパターンを設計する具体的な流れ Strategyパターンを設計する具体的な流れは以下の通りです。 1. アルゴリズムを実装するためのインターフェースを定義する。 1. インターフェースを実装した具体的なアルゴリズムクラスを作成する。 1. コンテキストクラスを作成し、アルゴリズムを保持するメンバ変数を追加する。 1. コンテキストクラスにアルゴリズムを切り替えるためのメソッドを実装する。 1. クライアントからコンテキストクラスを利用してアルゴリズムを実行する。 # Strategyパターンを使う例題 Strategyパターンを学ぶために段階的に要件を満たすクラスを実装してみましょう。例題は、プログラムのテストケース生成とテストの実行を目的として、3ステップで、要件を満たすようにコードやクラス図を書いてみましょう。 ## STEP1: テストケース生成戦略の設計 ### 要件: - ソフトウェアテストのためのテストケース生成クラスを設計する。 - テストケース生成クラスは抽象クラスとして定義する。 - テストケース生成クラスはテストケースを生成するgenerateTestCases()メソッドを持つ。 - 10文字の文字列を操作する機能をテスト対象とする。 - テストケース生成方法として、英字のみランダム、数字のみランダム、英数字ランダムの３種類を用意する。 - テストケースは10個生成する。 ### タスク: 1. テストケース生成クラスの抽象クラスを作成する。 2. generateTestCases()メソッドを抽象メソッドとして定義する。 3. 各戦略クラスに対してgenerateTestCases()メソッドを実装する。 4. テストケース生成戦略の切り替えを可能にするコンテキストクラスを作成する。 ### 出力例 ``` ['XuGESWzUiq', 'QAfKctRVYj', 'CUstyrWgMf', 'IhrBbIyLSk', 'vRONEJwCdo', 'UUhhXCcqyS', 'QcwfksgHMC', 'nNJoZFNjUB', 'VFBTNJcFKM', 'QnDtafdvRL'] ['5378417669', '5063988651', '1149703010', '9035036694', '1160405172', '9866772051', '0001495572', '6467413206', '5874893717', '7090061361'] ['WAk2pLYiIW', 'yv6HtT0py0', 'opx4o1r6Fd', 'mjZH8bvNsH', '0aDbTF2euc', 'RdSXk1jqwZ', '1dl4mh1tnJ', 'qolEfOCqNR', 'NOqsV29bOR', 'TZea3JxrFM'] ``` <div onclick="obj=document.getElementById('oritatami_part').style; obj.display=(obj.display=='none')?'block':'none';"> <a style="cursor:pointer;">▶回答例</a> </div> <div id="oritatami_part" style="display:none;clear:both;"> クラス図  <div class="separator" style="clear: both;"><a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEhxwiSIpvyyDMFfsKW7ijCepWUpc39O4Ze7Dau9Y0kgUEtHswoSOyjNbgPK9K6kg2vXQGAOnt8H0Ot3aHrh-af-ZmTelPprYBidrdzsAEk0lTeFcxxtXa6bO5CyYDs9Dhy7Hrs6X1hjJebSx0UIqhLOWkfl5hQfCRVBc7HpLGyPTxZiu64mDZPX15vkTak/s531/ex1.png" style="display: block; padding: 1em 0; text-align: center; "><img alt="" border="0" width="320" data-original-height="365" data-original-width="531" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEhxwiSIpvyyDMFfsKW7ijCepWUpc39O4Ze7Dau9Y0kgUEtHswoSOyjNbgPK9K6kg2vXQGAOnt8H0Ot3aHrh-af-ZmTelPprYBidrdzsAEk0lTeFcxxtXa6bO5CyYDs9Dhy7Hrs6X1hjJebSx0UIqhLOWkfl5hQfCRVBc7HpLGyPTxZiu64mDZPX15vkTak/s320/ex1.png"/></a></div> pythonで作成したコード ```python # テストケース生成クラスの抽象クラス from abc import ABC, abstractmethod import random import string class TestCaseGenerator(ABC): # テストケースを生成する抽象メソッド @abstractmethod def generateTestCases(self): pass # 英字のみランダムテストの戦略クラス class AlphaRandomTest(TestCaseGenerator): def generateTestCases(self): # 10文字の英字のみランダムな文字列を10個生成する cases = [] for _ in range(10): s = "".join(random.choices(string.ascii_letters, k=10)) cases.append(s) return cases # 数字のみランダムテストの戦略クラス class DigitRandomTest(TestCaseGenerator): def generateTestCases(self): # 10文字の数字のみランダムな文字列を10個生成する cases = [] for _ in range(10): s = "".join(random.choices(string.digits, k=10)) cases.append(s) return cases # 英数字ランダムテストの戦略クラス class AlnumRandomTest(TestCaseGenerator): def generateTestCases(self): # 10文字の英数字ランダムな文字列を10個生成する cases = [] for _ in range(10): s = "".join(random.choices(string.ascii_letters + string.digits, k=10)) cases.append(s) return cases # テストケース生成のコンテキストクラス class TestCaseContext: def __init__(self, generator): self.generator = generator def set_generator(self, generator): self.generator = generator def generateTestCases(self): return self.generator.generateTestCases() # 実行するmain関数 def main(): # テストケース生成のコンテキストクラスをインスタンス化する context = TestCaseContext(AlphaRandomTest()) # 英字のみランダムテストを選択 # テストケースを生成する print(context.generateTestCases()) context.set_generator(DigitRandomTest()) print(context.generateTestCases()) context.set_generator(AlnumRandomTest()) print(context.generateTestCases()) if __name__ == "__main__": main() ``` </div> ## STEP2: テスト方法戦略の実装 ### 要件: - テストケースの実行方法を戦略として切り替え可能にする。 - テスト方法の戦略は抽象クラスとして定義する。 - テスト方法の戦略はテストケースを実行するexecuteTestCases()メソッドを持つ。 - テスト方法は正解データと全体一致を確認する試験と、末端と中央値のみ確認する試験とする。 ### タスク: 1. テスト方法の戦略の抽象クラスを作成する。 2. executeTestCases()メソッドを抽象メソッドとして定義する。 3. テスト方法の戦略を具体的に実装する戦略クラスを作成する。 <div onclick="obj=document.getElementById('oritatami_part2').style; obj.display=(obj.display=='none')?'block':'none';"> <a style="cursor:pointer;">▶回答例</a> </div> <div id="oritatami_part2" style="display:none;clear:both;"> クラス図  <div class="separator" style="clear: both;"><a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEjhh_sFfLEHzsXPVbqjOt99Edqwj-acWqE_-4Wjw_8H3yHFT3H_9e7uLLwiM9he5sYNSULt9_-Z235-qyInLaLdasIzXjJymtlwqhg5G2tdNeV9f0hYCKsp-tU4HjH9DpooI9C7QFITCa_tJ_lgh801ruob-qEsf5pAQgWHKbZ3mEVuAkYi7B-158KfRlM/s832/ex2.png" style="display: block; padding: 1em 0; text-align: center; "><img alt="" border="0" width="320" data-original-height="365" data-original-width="832" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEjhh_sFfLEHzsXPVbqjOt99Edqwj-acWqE_-4Wjw_8H3yHFT3H_9e7uLLwiM9he5sYNSULt9_-Z235-qyInLaLdasIzXjJymtlwqhg5G2tdNeV9f0hYCKsp-tU4HjH9DpooI9C7QFITCa_tJ_lgh801ruob-qEsf5pAQgWHKbZ3mEVuAkYi7B-158KfRlM/s320/ex2.png"/></a></div> pythonで作成したコード ```python # テストケース生成クラスの抽象クラス from abc import ABC, abstractmethod import random import string class TestCaseGenerator(ABC): # テストケースを生成する抽象メソッド @abstractmethod def generateTestCases(self): pass # 英字のみランダムテストの戦略クラス class AlphaRandomTest(TestCaseGenerator): def generateTestCases(self): # 10文字の英字のみランダムな文字列を10個生成する cases = [] for _ in range(10): s = "".join(random.choices(string.ascii_letters, k=10)) cases.append(s) return cases # 数字のみランダムテストの戦略クラス class DigitRandomTest(TestCaseGenerator): def generateTestCases(self): # 10文字の数字のみランダムな文字列を10個生成する cases = [] for _ in range(10): s = "".join(random.choices(string.digits, k=10)) cases.append(s) return cases # 英数字ランダムテストの戦略クラス class AlnumRandomTest(TestCaseGenerator): def generateTestCases(self): # 10文字の英数字ランダムな文字列を10個生成する cases = [] for _ in range(10): s = "".join(random.choices(string.ascii_letters + string.digits, k=10)) cases.append(s) return cases # テストケース生成のコンテキストクラス class TestCaseContext: def __init__(self, generator): self.generator = generator def set_generator(self, generator): self.generator = generator def generateTestCases(self): return self.generator.generateTestCases() # テスト方法戦略の抽象クラス class TestMethod(ABC): # テストケースを実行する抽象メソッド @abstractmethod def executeTestCases(self, cases, target_function, expected_output): pass # 全体一致テストの戦略クラス class FullMatchTest(TestMethod): def executeTestCases(self, cases, target_function, expected_output): # テストケースを実行し、正解データと全体一致するか確認する for case in cases: assert target_function(case) == expected_output(case) # 末端と中央値テストの戦略クラス class EndAndMiddleTest(TestMethod): def executeTestCases(self, cases, target_function, expected_output): # テストケースを実行し、正解データと末端と中央値が一致するか確認する for case in cases: output = target_function(case) expected = expected_output(case) assert output[0] == expected[0] # 先頭が一致するか assert output[-1] == expected[-1] # 末尾が一致するか assert output[len(output)//2] == expected[len(expected)//2] # 中央値が一致するか # テストシステムのコンテキストクラス class TestSystemContext: def __init__(self, generator, method): self.generator = generator self.method = method def run_test(self, target_function, expected_output): # テストケースを生成する cases = self.generator.generateTestCases() # テストケースを実行する self.method.executeTestCases(cases, target_function, expected_output) # テスト対象のプログラム def reverse(s): return s[::-1] # 実行するmain関数 def main(): # テストシステムのコンテキストクラスをインスタンス化する context = TestSystemContext(AlphaRandomTest(), FullMatchTest()) # 英字のみランダムテストと全体一致テストを選択 # テストを実行する context.run_test(reverse, reverse) # reverse関数が正しいことを確認 if __name__ == "__main__": main() ``` </div> ## STEP3: テストケース生成とテスト方法の統合 ### 要件: - テストケース生成とテスト方法のクラスを統合し、柔軟に切り替え可能なテストシステムを構築する。 - コンテキストクラスを介してテストケース生成戦略とテスト方法の戦略を連携させる。 ### タスク: 1. テストシステムのコンテキストクラスを作成する。 2. コンテキストクラスにテストケース生成戦略とテスト方法の戦略を統合する機能を実装する。 <div onclick="obj=document.getElementById('oritatami_part3').style; obj.display=(obj.display=='none')?'block':'none';"> <a style="cursor:pointer;">▶回答例</a> </div> <div id="oritatami_part3" style="display:none;clear:both;"> クラス図  <div class="separator" style="clear: both;"><a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEhEp-ztlbqbW7Uz2nKKWFKWPY-01_wnzyRjKow6pdrDi-jX0HvP2TGKOl5W5oz6iDbMIk2gWykK1u6lPql6AwsAjDh7gV24YfUIQItDyG1pBjUj2WOzGTkMHyCfF4f5Jem6SYw5oVbFyhMefG70XgJWJirutgCN5BrtBku_rlLlXh6kL67ElOp9Q8i2Yug/s1385/ex3.png" style="display: block; padding: 1em 0; text-align: center; "><img alt="" border="0" width="320" data-original-height="400" data-original-width="1385" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEhEp-ztlbqbW7Uz2nKKWFKWPY-01_wnzyRjKow6pdrDi-jX0HvP2TGKOl5W5oz6iDbMIk2gWykK1u6lPql6AwsAjDh7gV24YfUIQItDyG1pBjUj2WOzGTkMHyCfF4f5Jem6SYw5oVbFyhMefG70XgJWJirutgCN5BrtBku_rlLlXh6kL67ElOp9Q8i2Yug/s320/ex3.png"/></a></div> pythonで作成したコード ```python # テストケース生成クラスの抽象クラス from abc import ABC, abstractmethod import random import string class TestCaseGenerator(ABC): # テストケースを生成する抽象メソッド @abstractmethod def generateTestCases(self): pass # 英字のみランダムテストの戦略クラス class AlphaRandomTest(TestCaseGenerator): def generateTestCases(self): # 10文字の英字のみランダムな文字列を10個生成する cases = [] for _ in range(10): s = "".join(random.choices(string.ascii_letters, k=10)) cases.append(s) return cases # 数字のみランダムテストの戦略クラス class DigitRandomTest(TestCaseGenerator): def generateTestCases(self): # 10文字の数字のみランダムな文字列を10個生成する cases = [] for _ in range(10): s = "".join(random.choices(string.digits, k=10)) cases.append(s) return cases # 英数字ランダムテストの戦略クラス class AlnumRandomTest(TestCaseGenerator): def generateTestCases(self): # 10文字の英数字ランダムな文字列を10個生成する cases = [] for _ in range(10): s = "".join(random.choices(string.ascii_letters + string.digits, k=10)) cases.append(s) return cases # テストケース生成のコンテキストクラス class TestCaseContext: def __init__(self, generator): self.generator = generator def set_generator(self, generator): self.generator = generator def generateTestCases(self): return self.generator.generateTestCases() # テスト方法戦略の抽象クラス class TestMethod(ABC): # テストケースを実行する抽象メソッド @abstractmethod def executeTestCases(self, cases, target_function, expected_output): pass # 全体一致テストの戦略クラス class FullMatchTest(TestMethod): def executeTestCases(self, cases, target_function, expected_output): # テストケースを実行し、正解データと全体一致するか確認する for case in cases: assert target_function(case) == expected_output(case) # 末端と中央値テストの戦略クラス class EndAndMiddleTest(TestMethod): def executeTestCases(self, cases, target_function, expected_output): # テストケースを実行し、正解データと末端と中央値が一致するか確認する for case in cases: output = target_function(case) expected = expected_output(case) assert output[0] == expected[0] # 先頭が一致するか assert output[-1] == expected[-1] # 末尾が一致するか assert output[len(output)//2] == expected[len(expected)//2] # 中央値が一致するか # テストシステムのコンテキストクラス class TestSystemContext: def __init__(self, generator, method): self.generator = generator self.method = method def set_generator(self, generator): self.generator = generator def set_method(self, method): self.method = method def run_test(self, target_function, expected_output): # テストケースを生成する cases = self.generator.generateTestCases() # テストケースを実行する self.method.executeTestCases(cases, target_function, expected_output) # テスト対象のプログラム def reverse(s): return s[::-1] # 実行するmain関数 def main(): # テストシステムのコンテキストクラスをインスタンス化する context = TestSystemContext(AlphaRandomTest(), FullMatchTest()) # 英字のみランダムテストと全体一致テストを選択 # テストを実行する context.run_test(reverse, reverse) # reverse関数が正しいことを確認 # テストケース生成戦略とテスト方法戦略を切り替える context.set_generator(DigitRandomTest()) # 数字のみランダムテストを選択 context.set_method(EndAndMiddleTest()) # 末端と中央値テストを選択 # テストを実行する context.run_test(reverse, reverse) # reverse関数が正しいことを確認 if __name__ == "__main__": main() ``` </div> # Strategyパターンを使うときの注意点と誤用例 Strategyパターンを使うと、コードの再利用性や拡張性、柔軟性が高まりますが、同時にクラス数やインターフェイス数も増えて管理が煩雑になる可能性もあります。Strategyパターンを使うかどうかは、プログラムの目的や要件に応じて慎重に判断する必要があります。 ## 注意点 - アルゴリズムが少なくて変更される可能性が低い場合。<br> Strategyパターンを使うと、クラス数やインターフェイス数が増えてコードの複雑度が上がります。アルゴリズムの種類や変更頻度が少ない場合は、シンプルな条件分岐で十分かもしれません。 - アルゴリズムが複雑で共通のインターフェイスを定義するのが困難な場合。<br> Strategyパターンでは、アルゴリズムを同じインターフェイスで実装することで、コンテキストから独立させます。しかし、アルゴリズム間に共通点や差異点がある場合は、それらを抽象化したり整理したりする必要があります。アルゴリズムの複雑さや多様さによっては、インターフェイスの設計や実装が難しくなる可能性があります。 - アルゴリズムの選択基準が不明確で選択ロジックが複雑になる場合。<br> Strategyパターンでは、コンテキストはアルゴリズムの詳細を知らずに、インターフェイスだけでアルゴリズムを呼び出します。しかし、コンテキストはアルゴリズムを選択するためのロジックを持っています。このロジックが複雑になると、コンテキストの責任が増えてしまいます。また、ロジックの変更によってコンテキストのコードも変更しなければならなくなります。 ## 誤用例 - コンテキストがアルゴリズムの詳細に依存している場合。<br> Strategyパターンの目的は、コンテキストとアルゴリズムを分離することです。しかし、コンテキストがアルゴリズムの詳細に依存している場合は、Strategyパターンを使っても分離できません。例えば、コンテキストがアルゴリズムの戻り値や例外を特定の方法で処理している場合は、アルゴリズムの詳細に依存していると言えます。この場合は、インターフェイスを見直したり、コンテキストの責任を分割したりする必要があります。 - アルゴリズムの選択ロジックがアルゴリズム自身にある場合。<br> Strategyパターンでは、コンテキストがアルゴリズムを選択するロジックを持ちます。しかし、アルゴリズム自身が選択ロジックを持っている場合は、Strategyパターンを使っても意味がありません。例えば、アルゴリズムが自分自身の適用条件や優先度などを持っている場合は、アルゴリズム自身が選択ロジックを持っていると言えます。この場合は、選択ロジックをコンテキストに移動したり、別のクラスに委譲したりする必要があります。 - アルゴリズム間に関連性や依存性がある場合。<br> Strategyパターンでは、アルゴリズムは互いに独立しています。しかし、アルゴリズム間に関連性や依存性がある場合は、Strategyパターンを使っても問題が解決できません。例えば、アルゴリズムが他のアルゴリズムの結果や状態に影響される場合は、アルゴリズム間に依存性があると言えます。この場合は、関連性や依存性を解消したり、別のデザインパターンを検討したりする必要があります。 # まとめ Strategyパターンは、アルゴリズムを実行時に選択することができるようにするデザインパターンです。適切に設計されたContextとStrategyクラスのクラス階層により、拡張性や柔軟性のある機能を実装できるようになります。ただし、適用時にはアルゴリズムの種類や変更頻度、複雑さや多様さ、選択基準やロジックなどを考慮し、適切な設計を行う必要があります。