Advisor源码分析

master
linlei 2024-04-07 16:52:30 +08:00
parent 2a141eb5e6
commit 9ac46e30e0
7 changed files with 320 additions and 2 deletions

View File

@ -198,7 +198,8 @@
+ Spring AOP + Spring AOP
- [Pointcut](spring-aop/spring-aop-pointcut/README.md):定义切入点,匹配被拦截的方法。<img src="https://img.shields.io/badge/Level-%E7%AE%80%E5%8D%95-0099ff"></img> - [Pointcut](spring-aop/spring-aop-pointcut/README.md):定义切入点,匹配被拦截的方法。<img src="https://img.shields.io/badge/Level-%E7%AE%80%E5%8D%95-0099ff"></img>
- [Advice](spring-aop/spring-aop-advice/README.md)AOP核心接口定义切面通知行为。<img src="https://img.shields.io/badge/Level-%E4%B8%80%E8%88%AC-%23FF6347"></img> - [Advice](spring-aop/spring-aop-advice/README.md)AOP核心接口定义切面通知行为。<img src="https://img.shields.io/badge/Level-%E4%B8%80%E8%88%AC-%23FF6347"></img>
- [Advisor](spring-aop/spring-aop-advisor/README.md):用于将通知和切点结合,实现切面编程的横切关注点。<img src="https://img.shields.io/badge/Level-%E7%AE%80%E5%8D%95-0099ff"></img>
+ Spring AOT + Spring AOT
+ Spring Log + Spring Log

View File

@ -17,16 +17,238 @@
### 二、知识储备 ### 二、知识储备
1. **Spring AOP**
+ 理解Spring框架中的AOP模块包括如何配置和使用Spring AOP以及与AspectJ的集成。
2. **通知Advice**
+ 了解通知是在AOP中的一个核心概念它是在连接点join point上执行的代码常用的通知类型有前置通知、后置通知、环绕通知等。
3. **切点Pointcut**
+ 理解切点是在AOP中确定何时应该应用通知的一种机制切点定义了在应用程序中哪些地方应该执行通知。
### 三、基本描述 ### 三、基本描述
`Advisor`接口是Spring框架中的一个关键接口用于将切点Pointcut和通知Advice组合起来以便在AOP面向切面编程中定义何时、何地以及如何应用横切关注点。
### 四、主要功能 ### 四、主要功能
1. **组合切点和通知**
+ Advisor接口允许将切点Pointcut和通知Advice组合在一起。切点确定何时应该应用通知而通知定义了在连接点处执行的代码。
2. **定义横切逻辑**
+ 通过Advisor接口及其实现类可以定义在应用程序中何时、何地以及如何应用横切关注点cross-cutting concerns如日志记录、事务管理、安全性等。
3. **提供AOP配置的抽象**
+ Advisor接口是AOP配置的一种抽象它使得可以通过编程方式或声明式的方式定义切面并将它们应用到目标对象上。
4. **实现面向切面编程**
+ Advisor接口是面向切面编程AOP的核心组件之一它允许我们在不改变业务逻辑的情况下通过切面来管理横切关注点从而提高代码的模块化和可维护性。
### 五、接口源码 ### 五、接口源码
`Advisor`接口是Spring框架中的一个基础接口用于持有AOP通知在连接点执行的操作和确定通知适用性的过滤器例如切点。该接口定义了获取通知部分的方法`getAdvice()`,以及确定通知是否与特定实例相关联的方法`isPerInstance()`。同时,该接口还提供了一个常量`EMPTY_ADVICE`用作当未配置适当通知时的占位符。在Spring AOP中Advisor接口允许支持不同类型的通知例如拦截器、前置通知、异常通知等并且并非所有通知都需要使用拦截来实现。
```java
/**
* 基础接口持有AOP <b>通知</b>(在连接点执行的操作)和确定通知适用性的过滤器(例如切点)。
* <i>此接口不供Spring用户使用而是为了在支持不同类型的通知时提供共性。</i>
*
* <p>Spring AOP基于通过方法拦截interception提供的<b>环绕通知</b>符合AOP Alliance拦截API。
* Advisor接口允许支持不同类型的通知例如<b>前置</b><b>后置</b>通知,它们不一定要使用拦截来实现。
*
* @author Rod Johnson
* @author Juergen Hoeller
*/
public interface Advisor {
/**
* 如果尚未配置适当的通知,则从{@link #getAdvice()}返回一个空的{@code Advice}的常用占位符。
* @since 5.0
*/
Advice EMPTY_ADVICE = new Advice() {};
/**
* 返回此方面的通知部分。通知可以是拦截器、前置通知、异常通知等。
* @return 如果切点匹配,则应应用的通知
* @see org.aopalliance.intercept.MethodInterceptor
* @see BeforeAdvice
* @see ThrowsAdvice
* @see AfterReturningAdvice
*/
Advice getAdvice();
/**
* 返回此通知是否与特定实例相关联例如创建混入或与从同一Spring bean工厂获取的被通知类的所有实例共享。
* <p><b>请注意,框架当前不使用此方法。</b>
* 典型的Advisor实现总是返回{@code true}。
* 使用singleton/prototype bean定义或适当的编程代理创建来确保Advisor具有正确的生命周期模型。
* @return 此通知是否与特定目标实例关联
*/
boolean isPerInstance();
}
```
### 六、主要实现 ### 六、主要实现
1. **RegexpMethodPointcutAdvisor**
- 基于正则表达式来匹配方法名的切点。通过使用正则表达式,可以根据方法名模式匹配连接点,并将通知应用于匹配的连接点,从而实现基于方法名模式的切面逻辑。
2. **AspectJExpressionPointcutAdvisor**
- 基于AspectJ表达式来定义切点。通过使用AspectJ的语法可以更灵活地定义切面从而匹配连接点并将通知应用于匹配的连接点实现更复杂的切面逻辑。
3. **NameMatchMethodPointcutAdvisor**
- 基于方法名模式匹配来定义切点。通过使用方法名模式,可以轻松地匹配连接点,并将通知应用于匹配的连接点,从而实现基于方法名模式的切面逻辑。
4. **DefaultPointcutAdvisor**
- 一个通用的切点Advisor用于将切点和通知组合在一起。它允许将任何类型的通知与任何类型的切点结合使用并将通知应用于匹配的连接点从而实现横切关注点的管理。
5. **DefaultIntroductionAdvisor**
+ 是Spring AOP中的一个特殊类型的Advisor实现用于引入新的接口或Mixin到目标类中。它允许将新的接口实现引入到现有的目标类中以扩展目标类的功能。通过`DefaultIntroductionAdvisor`,可以在不修改现有类的情况下,向其添加新的行为或功能,从而实现更好的代码复用和扩展性。
### 七、最佳实践 ### 七、最佳实践
使用Advisor来创建代理对象并应用切面逻辑。首先我们创建了一个代理工厂`ProxyFactory`,并将目标对象`MyService`传递给它。然后,我们通过`proxyFactory.addAdvisor(new MyCustomAdvisor())`添加了一个自定义的Advisor该Advisor定义了切点和通知。接着我们通过`proxyFactory.getProxy()`获取了代理对象`MyService`。最后,我们调用了代理对象的方法`proxy.foo()`和`proxy.bar()`。
```java
public class AdvisorDemo {
public static void main(String[] args) {
// 创建代理工厂
ProxyFactory proxyFactory = new ProxyFactory(new MyService());
// 添加Advisor
proxyFactory.addAdvisor(new MyCustomAdvisor());
// 获取代理对象
MyService proxy = (MyService) proxyFactory.getProxy();
// 调用方法
proxy.foo(); // 会触发通知
proxy.bar(); // 不会触发通知
}
}
```
`MyCustomAdvisor`类是一个自定义的Advisor它继承自`AbstractPointcutAdvisor`,用于将通知应用于带有特定注解的方法。在该类中,我们定义了一个通知对象`advice`和一个切点对象`pointcut`,切点用于匹配带有自定义注解`MyCustomAnnotation`的方法。通过实现`getPointcut()`方法和`getAdvice()`方法我们指定了切点和通知的逻辑。这样在应用该Advisor时它将会根据定义的切点匹配带有指定注解的方法并在匹配的方法执行前后应用通知。
```java
/**
* 自定义Advisor用于将通知应用于带有特定注解的方法。
*/
public class MyCustomAdvisor extends AbstractPointcutAdvisor {
/**
* 通知对象
*/
private final Advice advice = new MyAdvice();
/**
* 切点对象,用于匹配带有自定义注解的方法
*/
private final Pointcut pointcut = new AnnotationMatchingPointcut(null, MyCustomAnnotation.class);
@Override
public Pointcut getPointcut() {
return pointcut;
}
@Override
public Advice getAdvice() {
return advice;
}
}
```
`MyAdvice`类是一个通知类,实现了`MethodBeforeAdvice`接口,用于在目标方法执行前执行一些操作。
```java
public class MyAdvice implements MethodBeforeAdvice {
@Override
public void before(Method method, Object[] args, Object target) throws Throwable {
System.out.println("Before method: " + method.getName());
}
}
```
`MyCustomAnnotation`是一个自定义的注解,通常用于标记需要特殊处理的方法。
```java
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyCustomAnnotation {
}
```
`MyService`类包含了两个方法`foo()`和`bar()`。其中,`foo()`方法被标记了`@MyCustomAnnotation`注解,而`bar()`方法没有。当调用`foo()`方法时,将会执行特定的逻辑,而调用`bar()`方法则不会执行特定逻辑。这种注解标记方式为方法提供了特殊的标记,使得在应用切面时可以针对带有特定注解的方法执行特定的通知。
```java
public class MyService {
@MyCustomAnnotation
public void foo() {
System.out.println("Executing foo method");
}
public void bar() {
System.out.println("Executing bar method");
}
}
```
运行结果,切面逻辑成功应用于带有特定注解的方法,并且未被标记的方法不受影响。
```java
Before method: foo
Executing foo method
Executing bar method
```
### 八、与其他组件的关系 ### 八、与其他组件的关系
### 九、常见问题 1. **Advice**
+ Advisor接口持有一个通知Advice对象通知定义了在连接点Join Point上要执行的逻辑如在方法执行前后、抛出异常时等。
2. **Pointcut**
+ Advisor接口使用切点来确定通知应该在哪些连接点上执行。切点定义了一个匹配规则用于匹配连接点例如方法执行
3. **ProxyFactory**
+ 在Spring AOP中Advisor通常与代理工厂一起使用以创建代理对象并将切面逻辑应用于目标对象。代理工厂负责创建代理对象并将Advisor与目标对象进行关联。
4. **Aspect**
+ Advisor是实现切面的一种方式。切面是一个横切关注点的模块化单元它由切点和通知组成。Advisor提供了一种将切点和通知结合在一起的机制因此它是切面的基本组成部分。
### 九、常见问题
1. **切点定义错误**
+ 定义切点时可能会出现错误,导致切面未能正确地匹配到预期的连接点。这可能是因为切点表达式错误,或者切点逻辑与实际场景不匹配。
2. **通知应用顺序错误**
+ 当存在多个Advisor时通知的应用顺序可能会影响最终的切面逻辑。如果通知的应用顺序不正确可能会导致意外的行为或不一致的结果。
3. **切面匹配范围不正确**
+ 切面的匹配范围可能过于宽泛或过于狭窄,导致通知被应用于不希望被影响的连接点,或者未能影响到应该被影响的连接点。
4. **性能问题**
+ 使用过多或过于复杂的切面可能会影响应用程序的性能。因此,在设计切面时需要考虑性能问题,并尽量减少切面的数量和复杂度。
5. **代理问题**
+ 如果代理配置不正确,可能会导致切面无法正确应用。例如,如果代理对象的类型与切面匹配范围不一致,或者代理对象不符合切面的预期行为,都可能导致切面无法正确工作。
6. **异常处理问题**
+ 切面中的异常处理可能会影响应用程序的正常运行。如果异常处理不正确,可能会导致应用程序无法正确处理异常情况,从而影响用户体验。
7. **与其他切面冲突**
+ 如果存在多个切面,并且它们的匹配范围有重叠,可能会导致切面之间的冲突。例如,两个切面都匹配同一个连接点,并且它们的通知行为相互矛盾,可能会导致意料之外的结果。

View File

@ -0,0 +1,24 @@
package com.xcs.spring;
import org.springframework.aop.framework.ProxyFactory;
/**
* AdvisorDemo
*
* @author xcs
* @date
*/
public class AdvisorDemo {
public static void main(String[] args) {
// 创建代理工厂
ProxyFactory proxyFactory = new ProxyFactory(new MyService());
// 添加Advisor
proxyFactory.addAdvisor(new MyCustomAdvisor());
// 获取代理对象
MyService proxy = (MyService) proxyFactory.getProxy();
// 调用方法
proxy.foo(); // 会触发通知
proxy.bar(); // 不会触发通知
}
}

View File

@ -0,0 +1,12 @@
package com.xcs.spring;
import org.springframework.aop.MethodBeforeAdvice;
import java.lang.reflect.Method;
public class MyAdvice implements MethodBeforeAdvice {
@Override
public void before(Method method, Object[] args, Object target) throws Throwable {
System.out.println("Before method: " + method.getName());
}
}

View File

@ -0,0 +1,32 @@
package com.xcs.spring;
import org.aopalliance.aop.Advice;
import org.springframework.aop.Pointcut;
import org.springframework.aop.support.AbstractPointcutAdvisor;
import org.springframework.aop.support.annotation.AnnotationMatchingPointcut;
/**
* Advisor
*/
public class MyCustomAdvisor extends AbstractPointcutAdvisor {
/**
*
*/
private final Advice advice = new MyAdvice();
/**
*
*/
private final Pointcut pointcut = new AnnotationMatchingPointcut(null, MyCustomAnnotation.class);
@Override
public Pointcut getPointcut() {
return pointcut;
}
@Override
public Advice getAdvice() {
return advice;
}
}

View File

@ -0,0 +1,14 @@
package com.xcs.spring;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
*
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyCustomAnnotation {
}

View File

@ -0,0 +1,13 @@
package com.xcs.spring;
public class MyService {
@MyCustomAnnotation
public void foo() {
System.out.println("Executing foo method");
}
public void bar() {
System.out.println("Executing bar method");
}
}