From 1bc64a0e52450c551c90659b015ac8b078cf5460 Mon Sep 17 00:00:00 2001 From: linlei Date: Thu, 11 Apr 2024 10:30:37 +0800 Subject: [PATCH] =?UTF-8?q?MethodInterceptor=E6=8E=A5=E5=8F=A3=E6=BA=90?= =?UTF-8?q?=E7=A0=81=E5=88=86=E6=9E=90?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 1 + spring-aop/pom.xml | 11 ++ .../README.md | 165 ++++++++++++++++++ .../pom.xml | 14 ++ .../com/xcs/spring/MethodInterceptorDemo.java | 17 ++ .../com/xcs/spring/MyMethodInterceptor.java | 17 ++ .../main/java/com/xcs/spring/MyService.java | 9 + .../spring-aop-annotation-after/pom.xml | 14 ++ .../pom.xml | 14 ++ .../pom.xml | 14 ++ .../spring-aop-annotation-around/pom.xml | 14 ++ .../spring-aop-annotation-aspect/pom.xml | 14 ++ .../spring-aop-annotation-before/pom.xml | 14 ++ .../pom.xml | 14 ++ .../pom.xml | 14 ++ .../pom.xml | 14 ++ .../spring-aop-annotation-pointcut/pom.xml | 14 ++ 17 files changed, 374 insertions(+) create mode 100644 spring-aop/spring-aop-advice-methodInterceptor/README.md create mode 100644 spring-aop/spring-aop-advice-methodInterceptor/pom.xml create mode 100644 spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MethodInterceptorDemo.java create mode 100644 spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MyMethodInterceptor.java create mode 100644 spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MyService.java create mode 100644 spring-aop/spring-aop-annotation-after/pom.xml create mode 100644 spring-aop/spring-aop-annotation-afterReturning/pom.xml create mode 100644 spring-aop/spring-aop-annotation-afterThrowing/pom.xml create mode 100644 spring-aop/spring-aop-annotation-around/pom.xml create mode 100644 spring-aop/spring-aop-annotation-aspect/pom.xml create mode 100644 spring-aop/spring-aop-annotation-before/pom.xml create mode 100644 spring-aop/spring-aop-annotation-declareParents/pom.xml create mode 100644 spring-aop/spring-aop-annotation-enableAspectJAutoProxy/pom.xml create mode 100644 spring-aop/spring-aop-annotation-enableLoadTimeWeaving/pom.xml create mode 100644 spring-aop/spring-aop-annotation-pointcut/pom.xml diff --git a/README.md b/README.md index d2a2783..561bbdd 100644 --- a/README.md +++ b/README.md @@ -203,6 +203,7 @@ - [MethodMatcher](spring-aop/spring-aop-methodMatcher/README.md)：确定方法是否匹配拦截条件。 - [Pointcut](spring-aop/spring-aop-pointcut/README.md)：定义切入点，匹配被拦截的方法。 - [Advice](spring-aop/spring-aop-advice/README.md)：AOP核心接口，定义切面通知行为。 + - [MethodInterceptor](spring-aop/spring-aop-advice-methodInterceptor/README.md)：拦截方法执行，允许在前后添加额外逻辑。 - [Advisor](spring-aop/spring-aop-advisor/README.md)：用于将通知和切点结合，实现切面编程的横切关注点。 - [AdvisorAdapter](spring-aop/spring-aop-advisorAdapter/README.md)：适配不同类型通知到拦截器链。 - [TargetSource](spring-aop/spring-aop-targetSource/README.md)：管理AOP代理对象的获取与释放。 diff --git a/spring-aop/pom.xml b/spring-aop/pom.xml index 1242b85..86cc06f 100644 --- a/spring-aop/pom.xml +++ b/spring-aop/pom.xml @@ -19,6 +19,17 @@ spring-aop-methodMatcher spring-aop-jdkProxy spring-aop-cglibProxy + spring-aop-annotation-aspect + spring-aop-annotation-pointcut + spring-aop-annotation-around + spring-aop-annotation-before + spring-aop-annotation-after + spring-aop-annotation-afterReturning + spring-aop-annotation-afterThrowing + spring-aop-annotation-declareParents + spring-aop-annotation-enableAspectJAutoProxy + spring-aop-annotation-enableLoadTimeWeaving + spring-aop-advice-methodInterceptor 4.0.0 diff --git a/spring-aop/spring-aop-advice-methodInterceptor/README.md b/spring-aop/spring-aop-advice-methodInterceptor/README.md new file mode 100644 index 0000000..dab0821 --- /dev/null +++ b/spring-aop/spring-aop-advice-methodInterceptor/README.md @@ -0,0 +1,165 @@ +## MethodInterceptor + +- [MethodInterceptor](#methodinterceptor) + - [一、基本信息](#一基本信息) + - [二、基本描述](#二基本描述) + - [三、主要功能](#三主要功能) + - [四、接口源码](#四接口源码) + - [五、主要实现](#五主要实现) + - [六、最佳实践](#六最佳实践) + - [七、源码分析](#七源码分析) + - [八、常见问题](#八常见问题) + + +### 一、基本信息 + +✒️ **作者** - Lex 📝 **博客** - [掘金](https://juejin.cn/user/4251135018533068/posts) 📚 **源码地址** - [github](https://github.com/xuchengsheng/spring-reading) + +### 二、基本描述 + +`MethodInterceptor`接口是Spring框架中的一个核心接口，用于实现面向切面编程（AOP）。通过实现该接口，可以在目标方法执行前后、异常抛出时等关键点对方法进行拦截和增强，从而实现横切关注点的集中管理，提高代码的可维护性和灵活性。 + +### 三、主要功能 + +1. **方法拦截和增强** + + + 可以在目标方法执行前后、异常抛出时等关键点对方法进行拦截和增强，从而实现横切关注点的代码集中管理。 + +2. **横切关注点的集中管理** + + + 可以对横切关注点（如日志记录、权限控制、事务管理等）进行集中管理，避免代码重复，提高代码的可维护性。 + +### 四、接口源码 + +`MethodInterceptor`接口是用于拦截接口方法调用并在目标方法之前和之后执行额外处理的核心接口。我们需要实现其中的`invoke`方法来定义拦截器的具体行为，例如，可以实现一个跟踪拦截器来追踪被拦截方法的调用情况。在`invoke`方法中，通常会调用`proceed()`方法来继续执行目标方法，并在必要时对返回值或异常进行处理。 + +```java +/** + * 拦截器，用于拦截接口方法调用并在目标方法之前和之后执行额外处理。 + * 这些拦截器被嵌套在目标方法之上。 + * + *

用户应该实现 {@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. **AspectJAroundAdvice** + + + 实现了环绕通知，使用 AspectJ 风格定义的通知，可以在目标方法执行前后进行增强，并控制目标方法的执行过程。 + +2. **AspectJMethodBeforeAdvice** + + + 实现了前置通知，使用 AspectJ 风格定义的通知，用于在目标方法执行前执行额外的逻辑。 + +3. **AspectJAfterAdvice** + + + 实现了后置通知，使用 AspectJ 风格定义的通知，用于在目标方法执行后执行额外的逻辑。 + +4. **AspectJAfterReturningAdvice** + + + 实现了返回后通知，使用 AspectJ 风格定义的通知，用于在目标方法成功执行并返回结果后执行额外的逻辑。 + +5. **AspectJAfterThrowingAdvice** + + + 实现了异常抛出后通知，使用 AspectJ 风格定义的通知，用于在目标方法抛出异常后执行额外的逻辑。 + +6. **MethodBeforeAdviceInterceptor** + + + 实现了前置通知的拦截器。前置通知在目标方法执行之前执行，允许我们在方法执行前插入额外的逻辑。通常用于日志记录、参数验证等场景。 + +7. **AfterReturningAdviceInterceptor** + + + 实现了返回后通知的拦截器。返回后通知在目标方法成功执行并返回结果后执行，允许我们在方法返回后插入额外的逻辑。通常用于日志记录、结果处理等场景。 + +8. **ThrowsAdviceInterceptor** + + + 实现了异常抛出后通知的拦截器。异常抛出后通知在目标方法抛出异常后执行，允许我们在方法抛出异常后插入额外的逻辑。通常用于异常处理、日志记录等场景。 + +### 六、最佳实践 + +创建了一个代理工厂 `ProxyFactory`，并传入了目标对象 `MyService`。然后通过 `proxyFactory.addAdvice()` 方法添加了一个自定义的方法拦截器 `MyMethodInterceptor` 作为通知。接着，通过 `proxyFactory.getProxy()` 方法获取代理对象 `MyService` 的实例。最后，调用代理对象的方法 `doSomething()`。 + +```java +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.doSomething(); + } +} +``` + +`MyMethodInterceptor` 类用于实现方法拦截和增强的功能。在 `invoke()` 方法中，首先通过 `MethodInvocation` 对象获取被调用方法的信息，例如方法名等，并在方法调用之前输出方法被调用的信息。然后调用 `invocation.proceed()` 方法来执行原始方法，获取方法执行结果。最后，在方法调用之后输出方法返回值，并将其返回。 + +```java +public class MyMethodInterceptor implements MethodInterceptor { + @Override + public Object invoke(MethodInvocation invocation) throws Throwable { + // 在方法调用之前执行的逻辑 + System.out.println("Method " + invocation.getMethod().getName() + " is called."); + // 调用原始方法 + Object result = invocation.proceed(); + // 在方法调用之后执行的逻辑 + System.out.println("Method " + invocation.getMethod().getName() + " returns " + result); + return result; + } +} +``` + +`MyService` 类是一个简单的服务类，其中包含了一个名为 `doSomething()` 的方法。在上下文中，`MyService` 类被用作目标对象，即需要被拦截和增强的对象。 + +```java +public class MyService { + + public void doSomething() { + System.out.println("Doing something..."); + } +} +``` + +运行结果，在调用 `MyService` 实例的 `doSomething()` 方法时，`MyMethodInterceptor` 拦截器成功地拦截了方法的执行，并在方法执行前后添加了额外的逻辑处理。 + +```java +Method doSomething is called. +Doing something... +Method doSomething returns hello world +``` + +### 七、源码分析 + +暂无 + +### 八、常见问题 + +1. **使用问题** + + + 我们可能会遇到如何正确实现和使用 `MethodInterceptor` 接口的问题，包括如何编写拦截器逻辑、如何将拦截器应用到目标方法上等。 + +2. **执行顺序问题** + + + 在多个拦截器同时作用于同一个目标方法时，我们可能会关注拦截器的执行顺序问题，即哪个拦截器会先执行、哪个会后执行等。 + +3. **异常处理问题** + + 当目标方法执行过程中发生异常时，我们可能需要考虑如何在拦截器中处理异常，以及如何保证异常处理不会影响其他拦截器的执行。 \ No newline at end of file diff --git a/spring-aop/spring-aop-advice-methodInterceptor/pom.xml b/spring-aop/spring-aop-advice-methodInterceptor/pom.xml new file mode 100644 index 0000000..ce6dd97 --- /dev/null +++ b/spring-aop/spring-aop-advice-methodInterceptor/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-advice-methodInterceptor + + \ No newline at end of file diff --git a/spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MethodInterceptorDemo.java b/spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MethodInterceptorDemo.java new file mode 100644 index 0000000..e8968ae --- /dev/null +++ b/spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MethodInterceptorDemo.java @@ -0,0 +1,17 @@ +package com.xcs.spring; + +import org.springframework.aop.framework.ProxyFactory; + +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.doSomething(); + } +} diff --git a/spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MyMethodInterceptor.java b/spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MyMethodInterceptor.java new file mode 100644 index 0000000..4294107 --- /dev/null +++ b/spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MyMethodInterceptor.java @@ -0,0 +1,17 @@ +package com.xcs.spring; + +import org.aopalliance.intercept.MethodInterceptor; +import org.aopalliance.intercept.MethodInvocation; + +public class MyMethodInterceptor implements MethodInterceptor { + @Override + public Object invoke(MethodInvocation invocation) throws Throwable { + // 在方法调用之前执行的逻辑 + System.out.println("Method " + invocation.getMethod().getName() + " is called."); + // 调用原始方法 + Object result = invocation.proceed(); + // 在方法调用之后执行的逻辑 + System.out.println("Method " + invocation.getMethod().getName() + " returns " + result); + return result; + } +} diff --git a/spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MyService.java b/spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MyService.java new file mode 100644 index 0000000..66cef7c --- /dev/null +++ b/spring-aop/spring-aop-advice-methodInterceptor/src/main/java/com/xcs/spring/MyService.java @@ -0,0 +1,9 @@ +package com.xcs.spring; + +public class MyService { + + public String doSomething() { + System.out.println("Doing something..."); + return "hello world"; + } +} diff --git a/spring-aop/spring-aop-annotation-after/pom.xml b/spring-aop/spring-aop-annotation-after/pom.xml new file mode 100644 index 0000000..f687832 --- /dev/null +++ b/spring-aop/spring-aop-annotation-after/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-annotation-after + + \ No newline at end of file diff --git a/spring-aop/spring-aop-annotation-afterReturning/pom.xml b/spring-aop/spring-aop-annotation-afterReturning/pom.xml new file mode 100644 index 0000000..88d625b --- /dev/null +++ b/spring-aop/spring-aop-annotation-afterReturning/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-annotation-afterReturning + + \ No newline at end of file diff --git a/spring-aop/spring-aop-annotation-afterThrowing/pom.xml b/spring-aop/spring-aop-annotation-afterThrowing/pom.xml new file mode 100644 index 0000000..566196a --- /dev/null +++ b/spring-aop/spring-aop-annotation-afterThrowing/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-annotation-afterThrowing + + \ No newline at end of file diff --git a/spring-aop/spring-aop-annotation-around/pom.xml b/spring-aop/spring-aop-annotation-around/pom.xml new file mode 100644 index 0000000..ee6f5ee --- /dev/null +++ b/spring-aop/spring-aop-annotation-around/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-annotation-around + + \ No newline at end of file diff --git a/spring-aop/spring-aop-annotation-aspect/pom.xml b/spring-aop/spring-aop-annotation-aspect/pom.xml new file mode 100644 index 0000000..1aee724 --- /dev/null +++ b/spring-aop/spring-aop-annotation-aspect/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-annotation-aspect + + \ No newline at end of file diff --git a/spring-aop/spring-aop-annotation-before/pom.xml b/spring-aop/spring-aop-annotation-before/pom.xml new file mode 100644 index 0000000..fccb018 --- /dev/null +++ b/spring-aop/spring-aop-annotation-before/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-annotation-before + + \ No newline at end of file diff --git a/spring-aop/spring-aop-annotation-declareParents/pom.xml b/spring-aop/spring-aop-annotation-declareParents/pom.xml new file mode 100644 index 0000000..5495e07 --- /dev/null +++ b/spring-aop/spring-aop-annotation-declareParents/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-annotation-declareParents + + \ No newline at end of file diff --git a/spring-aop/spring-aop-annotation-enableAspectJAutoProxy/pom.xml b/spring-aop/spring-aop-annotation-enableAspectJAutoProxy/pom.xml new file mode 100644 index 0000000..912e4b4 --- /dev/null +++ b/spring-aop/spring-aop-annotation-enableAspectJAutoProxy/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-annotation-enableAspectJAutoProxy + + \ No newline at end of file diff --git a/spring-aop/spring-aop-annotation-enableLoadTimeWeaving/pom.xml b/spring-aop/spring-aop-annotation-enableLoadTimeWeaving/pom.xml new file mode 100644 index 0000000..8ff9dfd --- /dev/null +++ b/spring-aop/spring-aop-annotation-enableLoadTimeWeaving/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-annotation-enableLoadTimeWeaving + + \ No newline at end of file diff --git a/spring-aop/spring-aop-annotation-pointcut/pom.xml b/spring-aop/spring-aop-annotation-pointcut/pom.xml new file mode 100644 index 0000000..68f4154 --- /dev/null +++ b/spring-aop/spring-aop-annotation-pointcut/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-annotation-pointcut + + \ No newline at end of file