JavaにおけるExecute Aroundパターン：前処理と後処理のステップのカプセル化

約3分

別名

Aroundメソッドパターン
リソースブロック管理

Execute Aroundデザインパターンの目的

実際のビジネスアプリケーションでは、ビジネスメソッドの呼び出し前後に必要な操作を実行する必要があることがよくあります。JavaのExecute Aroundパターンは、これらの操作をカプセル化する方法を提供し、コードの可読性と再利用性を向上させます。

Execute Aroundパターンの詳細な説明と実例

実例

Execute Aroundパターンの現実世界の例えとして、レンタカーの利用が挙げられます。レンタカーを借りる場合、レンタカー会社はすべての準備（車の清掃、ガソリンの補充、良好な状態の確保）と後片付け（車の返却、損傷の検査、必要に応じて燃料の補充）のプロセスを処理します。顧客として、あなたは準備と後片付けを気にすることなく、目的のために車を使用するだけです。主要な操作に関する反復的なタスクを抽象化するこのパターンは、ソフトウェアにおけるExecute Aroundパターンに似ています。リソースの準備と後片付けは再利用可能なメソッドによって処理され、主要なロジックをシームレスに実行できます。

簡単な言葉で

Execute Aroundイディオムは、ビジネスメソッドの前後に定型コードを処理します。

Stack Overflowによると

基本的に、これは常に必要な処理、例えばリソースの割り当てとクリーンアップを行うメソッドを記述し、呼び出し側に「リソースで何をしたいか」を渡すパターンです。

JavaにおけるExecute Aroundパターンのプログラム例

Execute Aroundパターンは、Javaプログラミングでリソースの割り当てと解放を管理するために広く使用されているデザインパターンです。重要なセットアップとクリーンアップ操作が、コアビジネス操作の前後に確実に実行されるようにします。このパターンは、Javaアプリケーションでファイル、データベース、ネットワーク接続などのリソース管理に特に役立ちます。

テキスト文字列をファイルに書き込むためのクラスを提供する必要があります。ユーザーにとって使いやすくするために、サービスクラスはファイルを自動的に開閉します。ユーザーは、どのファイルに何が書き込まれるかを指定するだけで済みます。

SimpleFileWriterクラスは、Execute Aroundイディオムを実装しています。コンストラクタ引数としてFileWriterActionを受け取り、ファイルに書き込まれる内容をユーザーが指定できるようにします。


@FunctionalInterface
public interface FileWriterAction {
    void writeFile(FileWriter writer) throws IOException;
}

@Slf4j
public class SimpleFileWriter {
    public SimpleFileWriter(String filename, FileWriterAction action) throws IOException {
        LOGGER.info("Opening the file");
        try (var writer = new FileWriter(filename)) {
            LOGGER.info("Executing the action");
            action.writeFile(writer);
            LOGGER.info("Closing the file");
        }
    }
}

次のコードは、SimpleFileWriterの使用方法を示しています。書き込みが完了した後、Scannerを使用してファイルの内容を出力します。

  public static void main(String[] args) throws IOException {

    // create the file writer and execute the custom action
    FileWriterAction writeHello = writer -> writer.write("Gandalf was here");
    new SimpleFileWriter("testfile.txt", writeHello);

    // print the file contents
    try (var scanner = new Scanner(new File("testfile.txt"))) {
        while (scanner.hasNextLine()) {
            LOGGER.info(scanner.nextLine());
        }
    }
}

コンソール出力は次のとおりです。

21:18:07.185 [main] INFO com.iluwatar.execute.around.SimpleFileWriter - Opening the file
21:18:07.188 [main] INFO com.iluwatar.execute.around.SimpleFileWriter - Executing the action
21:18:07.189 [main] INFO com.iluwatar.execute.around.SimpleFileWriter - Closing the file
21:18:07.199 [main] INFO com.iluwatar.execute.around.App - Gandalf was here

JavaでExecute Aroundパターンを使用する場合

特にリソース管理（ファイル、ネットワーク接続、データベースセッションなど）において、反復的なセットアップとクリーンアップアクティビティが必要なシナリオで役立ちます。
例外が発生した場合でも適切なリソース処理とクリーンアップを確保し、リソースリークを防ぐのに最適です。
さまざまなコア機能の前後で同じ準備と終了手順が実行されるJavaアプリケーションに適しています。

JavaにおけるExecute Aroundパターンの実際のアプリケーション

実際のJavaアプリケーションでは、Execute Aroundパターンは次のシナリオで適用されます。

例外がスローされたかどうかに関係なく、実行後にリソースが閉じられることを保証するJavaのtry-with-resourcesステートメント。
実行結果に応じて定義済みのクリーンアップまたはロールバック操作が実行される、データベーストランザクションを管理するためのSpringなどのフレームワーク。

Execute Aroundパターンの利点と欠点

JavaでExecute Aroundパターンを実装すると、いくつかの利点と欠点があります。

利点

ルーチンのセットアップとクリーンアップタスクを抽象化することにより、定型コードを削減します。
ビジネスロジックをリソース管理から分離することにより、コードの明確さと保守性を向上させます。
エラーが発生した場合でも、リソースのクリーンアップを自動的に処理することにより、堅牢性を確保します。

欠点

追加の抽象化レイヤーが導入されるため、一部の開発者にとって複雑さが増し、制御フローがわかりにくくなる可能性があります。
Javaのクロージャと関数型インターフェースについて、より高度な理解が必要になる場合があります。

テンプレートメソッド：概念は似ていますが、継承と抽象クラスを使用する点で異なり、Execute Aroundは通常、インターフェースとラムダを使用します。
デコレータ：コアコンポーネントの周りに機能を追加するという概念を共有します。追加の動作を動的にラップするように拡張できます。