Micronaut AOPのベストプラクティス！保守しやすい設計ポイントを解説

1. Interceptorの責務を最小化する

1. Interceptorの責務を最小化する

MicronautのAOPでは、Interceptorが1つの役割に集中することが保守性向上の基本です。複数の処理を1つのInterceptorに詰め込むとテストや修正が難しくなります。ログ記録や認証チェックなど、処理ごとにInterceptorを分けることが推奨されます。

@Singleton
public class LoggingInterceptor implements MethodInterceptor<Object, Object> {
    @Override
    public Object intercept(MethodInvocationContext<Object, Object> context) {
        System.out.println("開始: " + context.getMethodName());
        Object result = context.proceed();
        System.out.println("終了: " + context.getMethodName());
        return result;
    }
}

2. 共通処理は別Beanに委譲する

2. 共通処理は別Beanに委譲する

Interceptor内で複雑な処理を直接書くと、再利用やテストが困難です。共通処理は別のBeanに分離し、Interceptorは呼び出すだけにするとコードがすっきりし、テストも容易になります。

@Singleton
public class MetricsService {
    public void record(String metric) {
        System.out.println("メトリクス: " + metric);
    }
}

@Singleton
public class MetricsInterceptor implements MethodInterceptor<Object, Object> {
    @Inject MetricsService metricsService;

    @Override
    public Object intercept(MethodInvocationContext<Object, Object> context) {
        metricsService.record("開始: " + context.getMethodName());
        Object result = context.proceed();
        metricsService.record("終了: " + context.getMethodName());
        return result;
    }
}

3. メソッド適用範囲を意識する

3. メソッド適用範囲を意識する

AOPはすべてのメソッドに無差別に適用するより、対象メソッドを限定するほうが保守性が高くなります。プライベートメソッドやユーティリティメソッドにはAOPを適用せず、公開メソッドに絞ることが望ましいです。

@Timed
public class PaymentService {
    public void processPayment(String orderId) {
        System.out.println("処理: " + orderId);
    }
}

4. Interceptorの順序と依存関係を整理する

4. Interceptorの順序と依存関係を整理する

複数のInterceptorが同じメソッドに適用される場合、順序を意識しないと意図しない挙動になります。@Orderアノテーションを使用して明示的に順序を管理し、依存関係も整理しましょう。

@Around(Order = Ordered.HIGHEST_PRECEDENCE)
public @interface SecurityCheck {}

@Singleton
@SecurityCheck
public class AuthInterceptor implements MethodInterceptor<Object, Object> {
    @Override
    public Object intercept(MethodInvocationContext<Object, Object> context) {
        System.out.println("認証チェック: " + context.getMethodName());
        return context.proceed();
    }
}

5. 例外処理をInterceptor内で補足する

5. 例外処理をInterceptor内で補足する

Interceptor内で例外が発生すると、呼び出し元にも例外が伝播します。try-catchでログ出力や補足処理を行うことで、予期しない停止を防ぎ、保守性を高めることができます。

@Override
public Object intercept(MethodInvocationContext<Object, Object> context) {
    try {
        return context.proceed();
    } catch (Exception e) {
        System.out.println("Interceptor例外: " + e.getMessage());
        throw e;
    }
}

6. AOPのテストを自動化する

6. AOPのテストを自動化する

保守性を高めるためには、Interceptorの単体テストや統合テストを自動化することが重要です。MockBeanやTestResourceを使ってInterceptorの動作確認を行うと、変更時のリスクを減らせます。

@MicronautTest
public class LoggingInterceptorTest {

    @Inject PaymentService paymentService;

    @Test
    void testLoggingInterceptor() {
        paymentService.processPayment("12345");
        // ログ出力が行われることを確認
    }
}

7. ドキュメントと命名規則を統一する

7. ドキュメントと命名規則を統一する

InterceptorやAOP関連のクラスは命名規則を統一し、処理内容を明確にドキュメント化することで、チームでの保守が容易になります。LoggingInterceptorやMetricsInterceptorなど、目的が一目でわかる名前を付けましょう。