spring-reading./spring-aop/spring-aop-advice-methodInterceptor

MethodInterceptor

• MethodInterceptor
  • 一、基本信息
  • 二、基本描述
  • 三、主要功能
  • 四、接口源码
  • 五、主要实现
  • 六、类关系图
  • 七、最佳实践

一、基本信息

✒️ 作者 - Lex 📝 博客 - 掘金 📚 源码地址 - github

二、基本描述

MethodInterceptor接口是Spring框架中的一个核心接口，用于实现面向切面编程（AOP）。通过实现该接口，可以在目标方法执行前后、异常抛出时等关键点对方法进行拦截和增强，从而实现横切关注点的集中管理，提高代码的可维护性和灵活性。

三、主要功能

1. 方法拦截和增强

   • 可以在目标方法执行前后、异常抛出时等关键点对方法进行拦截和增强，从而实现横切关注点的代码集中管理。

四、接口源码

MethodInterceptor接口是用于拦截接口方法调用并在目标方法之前和之后执行额外处理的核心接口。我们需要实现其中的invoke方法来定义拦截器的具体行为，例如，可以实现一个跟踪拦截器来追踪被拦截方法的调用情况。在invoke方法中，通常会调用proceed()方法来继续执行目标方法，并在必要时对返回值或异常进行处理。

/**
 * 拦截器，用于拦截接口方法调用并在目标方法之前和之后执行额外处理。
 * 这些拦截器被嵌套在目标方法之上。
 *
 * <p>用户应该实现 {@link #invoke(MethodInvocation)} 方法来修改原始行为。例如，以下类实现了一个跟踪拦截器（跟踪所有被拦截方法的调用）
 *
 * @author Rod Johnson
 */
@FunctionalInterface
public interface MethodInterceptor extends Interceptor {

    /**
     * 实现此方法以在调用之前和之后执行额外处理。礼貌的实现应该肯定地调用 {@link Joinpoint#proceed()}。
     * @param invocation 方法调用连接点
     * @return 调用 {@link Joinpoint#proceed()} 的结果；可能会被拦截器拦截
     * @throws Throwable 如果拦截器或目标对象抛出异常
     */
    @Nullable
    Object invoke(@Nonnull MethodInvocation invocation) throws Throwable;

}

五、主要实现

1. MethodBeforeAdviceInterceptor

   • 实现了前置通知的拦截器。前置通知在目标方法执行之前执行，允许我们在方法执行前插入额外的逻辑。

2. AfterReturningAdviceInterceptor

   • 实现了返回后通知的拦截器。返回后通知在目标方法成功执行并返回结果后执行，允许我们在方法返回后插入额外的逻辑。

3. ThrowsAdviceInterceptor

   • 实现了异常抛出后通知的拦截器。异常抛出后通知在目标方法抛出异常后执行，允许我们在方法抛出异常后插入额外的逻辑。

4. AspectJAfterAdvice

   • 实现了后置通知（After Advice），在目标方法执行后执行额外逻辑，不影响目标方法的执行结果。

5. AspectJAfterThrowingAdvice

   • 实现了异常抛出后通知（After Throwing Advice），在目标方法抛出异常后执行额外逻辑，允许处理异常或执行一些清理操作。

6. AspectJAroundAdvice

   • 实现了环绕通知（Around Advice），是最强大的一种通知类型，允许在目标方法执行前后添加额外逻辑，并完全控制目标方法的执行过程，包括是否执行目标方法和如何处理返回值。

六、类关系图

classDiagram
direction BT
class AbstractAspectJAdvice
class Advice {
<<Interface>>

}

class AspectJAfterAdvice
class AspectJAfterThrowingAdvice
class AspectJAroundAdvice
class Interceptor {
<<Interface>>

}
class MethodBeforeAdviceInterceptor
class AfterReturningAdviceInterceptor
class MethodInterceptor {
<<Interface>>

}
class ThrowsAdviceInterceptor

AbstractAspectJAdvice  ..>  Advice 
AfterReturningAdviceInterceptor  ..>  Advice 
AfterReturningAdviceInterceptor  ..>  MethodInterceptor 
AspectJAfterAdvice  -->  AbstractAspectJAdvice 
AspectJAfterAdvice  ..>  Advice 
AspectJAfterAdvice  ..>  MethodInterceptor 
AspectJAfterThrowingAdvice  -->  AbstractAspectJAdvice 
AspectJAfterThrowingAdvice  ..>  Advice 
AspectJAfterThrowingAdvice  ..>  MethodInterceptor 
AspectJAroundAdvice  -->  AbstractAspectJAdvice 
AspectJAroundAdvice  ..>  MethodInterceptor 
Interceptor  -->  Advice 
MethodBeforeAdviceInterceptor  ..>  Advice 
MethodBeforeAdviceInterceptor  ..>  MethodInterceptor 
MethodInterceptor  -->  Interceptor 
ThrowsAdviceInterceptor  ..>  Advice 
ThrowsAdviceInterceptor  ..>  MethodInterceptor 

七、最佳实践

创建了一个代理工厂 ProxyFactory，并传入了目标对象 MyService。然后通过 proxyFactory.addAdvice() 方法添加了一个自定义的方法拦截器 MyMethodInterceptor 作为通知。接着，通过 proxyFactory.getProxy() 方法获取代理对象 MyService 的实例。最后，调用代理对象的方法 doSomething()。

public class MethodInterceptorDemo {

    public static void main(String[] args) {
        // 创建代理工厂&创建目标对象
        ProxyFactory proxyFactory = new ProxyFactory(new MyService());
        // 创建通知
        proxyFactory.addAdvice(new MyMethodInterceptor());
        // 获取代理对象
        MyService proxy = (MyService) proxyFactory.getProxy();
        // 调用代理对象的方法
        proxy.foo();
    }
}

MyMethodInterceptor 类用于实现方法拦截和增强的功能。在 invoke() 方法中，首先通过 MethodInvocation 对象获取被调用方法的信息，例如方法名等，并在方法调用之前输出方法被调用的信息。然后调用 invocation.proceed() 方法来执行原始方法，获取方法执行结果。最后并将其返回。

public class MyMethodInterceptor implements MethodInterceptor {
    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        // 在方法调用之前执行的逻辑
        System.out.println("Before Method " + invocation.getMethod().getName());
        // 调用原始方法
        Object result = invocation.proceed();
        // 在方法调用之后执行的逻辑
        System.out.println("After Method " + invocation.getMethod().getName());
        return result;
    }
}

MyService 类是一个简单的服务类，其中包含了一个名为 foo() 的方法。在上下文中，MyService 类被用作目标对象，即需要被拦截和增强的对象。

public class MyService {

    public void foo() {
        System.out.println("foo...");
    }
}

运行结果，在调用 MyService 实例的 foo() 方法时，MyMethodInterceptor 拦截器成功地拦截了方法的执行，并在方法执行前后添加了额外的逻辑处理。

Before Method foo
foo...
After Method foo