0%

Spring AOP

Spring AOP

AOP称为切面编程(Aspect Oriented Programming),是面向对象的一种补充,通过预编译方式与运行期动态代理实现程序功能的一种技术,用于处理系统中分布于各个模块的横切关注点,比如事务管理、日志、缓存等。Spring AOP中使用的是动态代理。

为什么要使用AOP

如果你有一个系统包含很多包和类并没有使用AOP,比如日志追踪,事务和异常处理,我们不得不在每一个类和每一个方法实现它们。

这将导致很多问题:

  • 代码混乱 每个类和方法包含日志追踪,事务和异常处理甚至业务逻辑
  • 代码分散 切面比如事务是分散在代码中,没有在系统的一个特别部分实现
  • 代码冗余 很多相同的代码需要写几遍甚至十几遍

而AOP做的事情就是将相同逻辑的重复代码横向抽取出来,使用动态代理技术将这些重复代码织入到目标对象方法中,实现和原来一样的功能

动态代理不会去修改字节码,而是在内存中临时为方法生成一个AOP对象,这个AOP对象包含了目标对象的全部方法,并且在特定的切点做了增强处理,并回调原对象的方法。

AOP的核心是切面,它将多个类的通用行为封装成可重用的模块,该模块含有一组API提供横切的功能,在SpringAOP中,切面通过@Aspect注解,也可以使用XML配置

AOP中的概念

  • 横切关注点 从每个方法中抽取出来的非核心业务

  • 目标(Target) 目标对象

  • 代理(Proxy) 向目标对象应用通知之后创建的对象

  • 连接点(Joinpoint) 应用程序执行过程中插入切面的点,也就是目标对象的方法

  • 切点(pointCut) 切点是对连接点进行拦截的定义,连接点的集合

  • 通知(Advice) 切面需要完成的各个具体工作,实际增强的逻辑部分被称为通知,通知有多种类型,包含有前置、后置、返回、异常、环绕五种通知,BeforeAdvice接口、AfterAdvice接口

  • 织入(Weaving) 将通知(Advice)添加到目标对象的具体连接点上的过程

  • 引介(Introduction) 可以在运行期为类动态的添加新方法或属性

  • 切面(Aspect) 切入点和通知的结合

  • 通知器(Advisor) 和切面类似,将pointCut和Advice结合起来

有五种类型的AOP通知

  • before 前置通知BeforeAdvice,在方法执行之前被调用 @Before

  • after 后置通知AfterAdvice,在方法执行之后调用,无论方法执行是否成功,所以后置通知无法获取到返回结果@After

  • after-returning AfterReturningAdvice,仅当方法成功完成后执行@AfterReturning

  • after-throwing ThrowsAdvice,在方法抛出异常退出时执行@AfterThrowing

  • around 在方法执行之前和之后调用@Around

切点标识符

  • execution 最基本的标识符,匹配某个类中的某个方法 execution([权限修饰符] [返回类型] [类全路径] [方法名称] ([参数列表]))
  • within 匹配特定包下的所有连接点,within(包名或类名),最小可精确到类,无法精确到方法 如 within(com.zhanghe.*)
  • this 匹配一个bean,代理对象,this(类名)
  • target 匹配的是实现该接口的目标对象,target(类名)
  • bean 根据bean的名称进行匹配
  • args 匹配参数满足要求的方法 args(name) 匹配第一个参数为Long的 args(Long,..)
  • @annotation 匹配由注解标注的方法 @annotation(com.zhanghe.datasource.DataSource)
  • @within(类名) 匹配类上有该注解的方法,注解的RetentionPolicy级别为Class
  • @target(类名) 匹配类上有该注解的方法,要求注解中RetentionPolicy级别为RUNTIME
  • @args(类名) 匹配参数上标注有该注解的方法

AOP动态代理方式

Spring AOP中动态代理主要有两种方式,JDK动态代理和CGLIB动态代理。

spring中DefaultAopProxyFactory类创建aop代理的方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
public AopProxy createAopProxy(AdvisedSupport config) throws AopConfigException {
if (config.isOptimize() || config.isProxyTargetClass() || hasNoUserSuppliedProxyInterfaces(config)) {
Class<?> targetClass = config.getTargetClass();
if (targetClass == null) {
throw new AopConfigException("TargetSource cannot determine target class: " +
"Either an interface or a target is required for proxy creation.");
}
if (targetClass.isInterface() || Proxy.isProxyClass(targetClass)) {
return new JdkDynamicAopProxy(config); // jdk动态代理
}
return new ObjenesisCglibAopProxy(config); // cglib动态代理
}
else {
return new JdkDynamicAopProxy(config); // jdk动态代理
}
}

JDK动态代理

JDK动态代理通过反射来接收被代理的类,并且要求被代理的类必须实现一个接口,JDK代理的核心是InvocationHandler接口和Proxy类。

CGLIB代理

如果目标类没有实现接口,那么Spring AOP会使用CGLIB代理来动态代理目标类。CGLIB是一个代码生成的类库,可以在运行时动态的生成某个类的子类(通过继承的方式做的动态代理,如果某个类被标记为final,无法使用CGLIB做动态代理)

AOP使用方式

AOP所需要的依赖

1
2
3
4
5
6
7
8
9
10
11
12
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aop</artifactId>
<version>4.3.29.RELEASE</version>
</dependency>

<!-- aspect -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>4.3.29.RELEASE</version>
</dependency>

使用注解

使用注解的时候需要在xml中配置<aop:aspectj-autoproxy/>或者在javaConfig类上使用@EnableAspectJAutoProxy来启用自动代理功能

1
2
<!-- 使@Aspect注解生效 -->
<aop:aspectj-autoproxy/>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
/**
* 声明切面
*/
@Aspect
@Component
@Order(1)// 使用Order指定切面优先级 数字越小 优先级越高 越先执行
public class LoggingAspect {
// @Before 前置通知
// JoinPoint 可以获取到方法的一些信息
@Before("execution(public String com.zhanghe.study.spring4.beans.aoptest.MyInterface.log(..))")
public void before(JoinPoint point){
// 获取方法名
String methodName = point.getSignature().getName();
// point.getArgs()获取参数
System.out.println(methodName+"方法执行前,参数为"+ Arrays.toString(point.getArgs()));
}

// 方法正常执行完,可以获取方法返回值
// returning中配置的名字必须与第二个参数同名
@AfterReturning(value="execution(public String com.zhanghe.study.spring4.beans.aoptest.MyInterface.log(..))",
returning = "result")
public void afterReturn(JoinPoint point,Object result){
// 获取方法名
String methodName = point.getSignature().getName();
System.out.println(methodName+"方法执行完成,结果为"+ result);
}


// 方法出现异常
// throwing中配置的名字必须与第二个参数同名,且可以指定对于哪些异常进行执行 第二个参数类型可以为所要捕获的异常类型
@AfterThrowing(value="execution(public String com.zhanghe.study.spring4.beans.aoptest.MyInterface.log(..))",
throwing = "exception")
public void afterThrowing(JoinPoint point,Exception exception){
// 获取方法名
String methodName = point.getSignature().getName();
System.out.println(methodName+"方法执行出现异常,异常信息为"+ exception.getMessage());
}
}

在使用切面的时候必须保证切面是Spring IOC容器中的bean

使用XML

所有的aop配置都应该配置在<aop:config>标签中,在xml中只需要关注切面、通知以及切入点表达式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!-- LoggingAspect所对应的bean -->
<bean name="loggingAspect" class="com.zhanghe.study.spring4.beans.aoptest.LoggingAspect"/>

<!-- 配置AOP -->
<aop:config>
<!-- 配置切点表达式 -->
<aop:pointcut id="pointcut" expression="execution(public String com.zhanghe.study.spring4.beans.aoptest.MyInterface.log(..)))"/>

<!-- 配置切面及通知 -->
<aop:aspect ref="loggingAspect" order="1">
<!-- 通知 -->
<aop:before method="before" pointcut-ref="pointcut"/>
<aop:after-returning method="afterReturn" returning="result" pointcut-ref="pointcut"/>
<aop:after-throwing method="afterThrowing" throwing="exception" pointcut-ref="pointcut"/>
</aop:aspect>
</aop:config>

注意:使用xml的模式进行配置记得保证切面是Spring IOC容器中的bean

无法使用AOP代理的情况

由于spring aop使用了两种动态代理方式,所以分两种情况来说明

  • 基于接口代理(JDK代理)

    基于接口代理,凡是类的方法非public修饰,或者用了static关键字修饰,那这些方法都不能被Spring AOP增强

  • 基于CGLib代理(子类代理)

    基于子类代理,凡是类的方法使用了private、static、final修饰,那这些方法都不能被Spring AOP增强

欢迎关注我的其它发布渠道