您的位置:  首页 > 技术杂谈 > 正文

从XML配置角度理解Spring AOP

2024-05-13 11:00 https://my.oschina.net/u/4526289/blog/11106069 华为云开发者联盟 次阅读 条评论

本文分享自华为云社区《Spring高手之路18——从XML配置角度理解Spring AOP》,作者: 砖业洋__。

1. Spring AOP与动态代理

1.1 Spring AOP和动态代理的关系

Spring AOP使用动态代理作为其主要机制来实现面向切面的编程。这种机制允许Spring在运行时动态地创建代理对象,这些代理对象包装了目标对象(即业务组件),以便在调用目标对象的方法前后插入额外的行为(如安全检查、事务管理、日志记录等)。

  • JDK动态代理:当目标对象实现了一个或多个接口时,Spring AOP默认使用JDK的动态代理。JDK动态代理通过反射机制,为接口创建一个代理对象,这个代理对象会拦截对目标接口方法的所有调用。

  • CGLIB代理:如果目标对象没有实现任何接口,Spring AOP会退回到使用CGLIB库生成目标类的子类。CGLIBCode Generation Library)是一个强大的高性能代码生成库,它在运行时扩展了Java类,并在子类中覆盖了方法来实现方法拦截。

无论使用哪种代理方式,目的都是在不改变原有业务逻辑代码的基础上,通过切面定义的通知在方法执行的不同阶段插入附加行为。

1.2 AOP基本术语

切面(Aspect):切面是面向切面编程的核心,它是将横跨多个类的关注点(如日志记录、事务管理等)模块化的构造。一个切面可以包含多种类型的通知(Advice)和一个或多个切点(Pointcut),用于定义在何处以及何时执行这些通知。

连接点(Join Point):连接点代表程序执行过程中的某个特定位置,Spring AOP限定这些位置为方法的调用。简而言之,连接点就是能够插入切面通知的点。

通知(Advice):通知定义了切面在连接点上要执行的动作。根据通知类型的不同,这些动作可以在方法调用之前、之后、返回结果后或抛出异常时执行。通知类型包括:

  • 前置通知(Before advice):在方法执行之前执行。
  • 后置通知(After advice):在方法执行后执行,无论其结果如何。
  • 返回后通知(After-returning advice):在方法成功执行之后执行。
  • 异常后通知(After-throwing advice):在方法抛出异常后执行。
  • 环绕通知(Around advice):在方法执行之前和之后执行,提供对方法调用的全面控制。

切点(Pointcut):切点是一个表达式,切点表达式允许通过方法名称、访问修饰符等条件来匹配连接点,决定了通知应该在哪些方法执行时触发。

目标对象(Target Object):被一个或多个切面所通知的对象。也被称为被代理对象。

AOP代理(AOP Proxy)AOP框架创建的对象,用于实现切面契约(由通知和切点定义)。在Spring AOP中,AOP代理可以是JDK动态代理或CGLIB代理。

引入(Introduction):引入允许向现有的类添加新的方法或属性。这是通过定义一个或多个附加接口(Introduction interfaces)实现的,AOP框架会为目标对象创建一个代理,该代理实现这些接口。

如果还是觉得抽象,我们再举一个电影制作的例子来类比

切面(Aspect)

想象一下,有人正在拍摄一部电影,而电影中的特效(比如爆炸和特殊光效)就像是应用程序中需要处理的横切关注点(比如日志记录或事务管理)。这些特效会在电影的许多不同场景中出现,而不仅仅局限于某一个特定场景。在AOP中,这些“特效”就是切面,它们可以被应用到程序的多个部分,而不需要改变实际的场景(或代码)。

连接点(Join Point)

继续使用电影的比喻,每个场景中的特定时刻,比如一个爆炸发生的瞬间,可以看作是一个连接点。在编程中,这通常对应于方法的调用。

通知(Advice)

通知就像是导演对特效团队的具体指令,比如“在这个场景开始之前加入一个爆炸效果”或“场景结束后显示烟雾渐散的效果”。这些指令告诉特效团队在电影的哪个具体时刻应该添加特定的效果。在AOP中,这些“指令”就是通知,指定了切面(特效)应该在连接点(特定的代码执行时刻)之前、之后或周围执行。

切点(Pointcut)

如果说通知是导演对特效团队的指令,那么切点就是指令中包含的具体条件,比如“所有夜晚的外景戏”。切点定义了哪些连接点(比如哪些具体的方法调用)应该接收通知(特效指令)。

目标对象(Target Object)

目标对象就是那些需要添加特效的场景。在我们的编程比喻中,它们是那些被切面逻辑影响的对象(比如需要日志记录的类)。

AOP代理(AOP Proxy)

AOP代理就像是特效团队提供的一个虚拟的、可控制特效的场景副本。这个副本在观众看来与原场景无异,但实际上它能在导演需要的时刻自动添加特效。在编程中,代理是一个被AOP框架自动创建的对象,它包装了目标对象,确保了通知(特效指令)在正确的时间被执行。

引入(Introduction)

引入就好比是在电影中加入一个全新的角色或者场景,这在原本的脚本中并不存在。在AOP中,引入允许我们向现有的类添加新的方法或属性,这就像是在不改变原始脚本的情况下扩展电影的内容。

2. 通过XML配置实现Spring AOP

Spring提供了丰富的AOP支持,可以通过XML配置来定义切面、通知(advice)和切点(pointcuts)。这样可以在不修改源代码的情况下增加额外的行为(如日志、事务管理等)

实现步骤:

  1. 添加Spring依赖:在项目的pom.xml中添加Spring框架和AOP相关的依赖。

  2. 定义业务接口和实现类:创建业务逻辑接口及其实现,比如一个简单的服务类。

  3. 定义切面类:创建一个切面类,用于定义前置、后置、环绕等通知。

  4. 配置XML:在applicationContext.xml中配置切面和业务bean,以及AOP相关的标签。

2.1 添加Spring依赖

pom.xml文件中,添加以下依赖

<dependencies>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>5.3.10</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</artifactId>
        <version>5.3.10</version>
    </dependency>
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
        <version>1.9.6</version>
    </dependency>
</dependencies>

2.2 定义业务接口和实现类

首先,我们定义一个业务逻辑接口MyService和它的实现MyServiceImpl

MyService.java:

package com.example.demo.aop;
public interface MyService {
    String performAction(String input) throws Exception;
}

MyServiceImpl.java:

package com.example.demo.aop;
public class MyServiceImpl implements MyService {
    @Override
    public String performAction(String action) throws Exception {
        System.out.println("Performing action in MyService: " + action);
        if ("throw".equals(action)) {
            throw new Exception("Exception from MyService");
        }
        return "Action performed: " + action;
    }
}

2.3 定义切面类

接下来,我们定义一个切面类MyAspect,这个类将包含一个前置通知(advice),它在MyServiceperformAction方法执行之前执行。

MyAspect.java:

package com.example.demo.aop;

import org.aspectj.lang.ProceedingJoinPoint;

public class MyAspect {

    // 前置通知
    public void beforeAdvice() {
        System.out.println("Before advice is running!");
    }

    // 后置通知
    public void afterAdvice() {
        System.out.println("After advice is running!");
    }

    // 返回后通知
    public void afterReturningAdvice(Object retVal) {
        System.out.println("After returning advice is running! Return value: " + retVal);
    }

    // 异常后通知
    public void afterThrowingAdvice(Throwable ex) {
        System.out.println("After throwing advice is running! Exception: " + ex.getMessage());
    }

    // 环绕通知
    public Object aroundAdvice(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("Around advice: Before method execution");
        Object result = null;
        try {
            result = joinPoint.proceed();
        } finally {
            System.out.println("Around advice: After method execution");
        }
        return result;
    }
}

2.4 配置XML

最后,我们需要在Spring的配置文件applicationContext.xml中配置上述bean以及AOP的相关内容。

applicationContext.xml:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
                           http://www.springframework.org/schema/beans/spring-beans.xsd
                           http://www.springframework.org/schema/aop
                           http://www.springframework.org/schema/aop/spring-aop.xsd">
<!-- 
上面这是XML文件的头部声明,它定义了文件的版本和编码类型,同时引入了Spring beans 和 AOP 的命名空间。
通过这些命名空间,我们可以在XML中使用<bean>和<aop:*>标签。 
-->
    <!-- Bean definitions -->
    <bean id="myService" class="com.example.demo.aop.MyServiceImpl"/>
    <bean id="myAspect" class="com.example.demo.aop.MyAspect"/>
	<!-- AOP配置 -->
    <aop:config>
        <!-- 定义切面及其通知 -->
        <aop:aspect id="myAspectRef" ref="myAspect">
            <!-- 定义切点,指定通知应该在哪些方法执行时触发 -->
            <aop:pointcut id="serviceOperation" expression="execution(* com.example.demo.aop.MyService.performAction(..))"/>
            <!-- 应用前置通知,指定方法执行前的操作 -->
            <aop:before method="beforeAdvice" pointcut-ref="serviceOperation"/>
            <!-- 应用后置通知,指定方法执行后的操作,不论方法执行成功还是抛出异常 -->
            <aop:after method="afterAdvice" pointcut-ref="serviceOperation"/>
            <!-- 应用返回后通知,指定方法成功执行并返回后的操作 -->
            <aop:after-returning method="afterReturningAdvice" pointcut-ref="serviceOperation" returning="retVal"/>
            <!-- 应用异常后通知,指定方法抛出异常后的操作 -->
            <aop:after-throwing method="afterThrowingAdvice" pointcut-ref="serviceOperation" throwing="ex"/>
            <!-- 应用环绕通知,提供方法执行前后的完全控制 -->
            <aop:around method="aroundAdvice" pointcut-ref="serviceOperation"/>
        </aop:aspect>
    </aop:config>
</beans>

myService:这是业务逻辑的bean,指向MyServiceImpl类的实例。

myAspect:这是切面的bean,指向MyAspect类的实例。

<aop:config>:这是AOP配置的根元素,所有的AOP配置,包括切面定义、切点和通知方法等,都需要在此元素内部定义。

切面(Aspect):通过<aop:aspect>元素定义,它包含了一系列通知(advice)和一个或多个切点(pointcut)。这个元素将切面类(包含通知逻辑的类)与具体的操作(如何、何时对目标对象进行增强)关联起来。

切点(Pointcut):通过<aop:pointcut>元素定义,切点通过表达式来指定,当需要精确控制哪些方法执行时会触发通知时,就需要定义切点。切点表达式可以非常精确地指定方法,例如通过方法名称、参数类型、注解等。expression定义了切点的表达式,指明了切点的匹配规则。这里的表达式execution(* com.example.demo.aop.MyService.performAction(..))意味着切点匹配MyService接口中performAction方法的执行,切点用于指定在哪些连接点(Join Point,例如方法调用)上应用通知。

关于解析表达式execution(* com.example.demo.aop.MyService.performAction(..))

execution:是最常用的切点函数,用于匹配方法执行的连接点。

*:表示方法的返回类型是任意的。

com.example.demo.aop.MyService.performAction:指定了全路径的接口名和方法名。

(…):表示方法参数是任意的,无论方法有多少个参数都匹配。

  • 连接点(Join Point)连接点是指在程序执行过程中的某一点,比如方法的调用。 连接点是通过切点(Pointcut)的表达式来识别和匹配的,execution(* com.example.demo.aop.MyService.performAction(..))表达式定义了一个切点,它指定了一个明确的连接点集合——即MyService接口的performAction方法的所有调用。这个例子中,MyService接口的performAction方法的调用就是潜在的连接点。每次performAction方法被调用时,就达到了一个连接点。这个连接点就是这里通知应用的时机。

  • 通知(Advice):这是AOP通过在特定时机执行的操作来增强方法的执行。method属性指明当切点匹配时应该执行的切面的方法名,pointcut-ref引用了上面定义的切点。比如这里的beforeAdvice是在目标方法performAction执行之前被调用的方法。这意味着每当MyService.performAction(..)方法被调用时,beforeAdvice方法将首先被执行。

总结为一句话:Spring AOP通过在切面中定义规则(切点)来指定何时(连接点)以及如何(通知)增强特定方法,实现代码的模块化和关注点分离,无需修改原有业务逻辑。

通过这种方式,Spring AOP 允许定义在特定方法执行前、执行后、环绕执行等时机插入自定义逻辑,而无需修改原有业务逻辑代码。这是实现关注点分离的一种强大机制,特别是对于跨越应用程序多个部分的横切关注点(如日志、事务管理等)。

注意,如果<aop:config>设置为

<aop:config proxy-target-class="true">
    <!-- 其他配置不变 -->
</aop:config>

设置proxy-target-class="true"会使Spring AOP优先使用CGLIB代理,即使目标对象实现了接口。默认情况下,不需要设置proxy-target-class属性,或者将其设置为false,则是使用JDK动态代理。

主程序:

DemoApplication.java:

package com.example.demo;

import com.example.demo.aop.MyService;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class DemoApplication {
    public static void main(String[] args) {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        MyService myService = (MyService) context.getBean("myService");

        try {
            System.out.println(myService.performAction("normal"));
        } catch (Exception e) {
            e.printStackTrace();
        }

        System.out.println("=======================");

        try {
            System.out.println(myService.performAction("throw"));
        } catch (Exception e) {
            System.out.println("Exception caught in main: " + e.getMessage());
        }

        context.close();
    }
}

运行结果:

通过结合动态代理技术和这些AOP概念,Spring AOP能够以非侵入式的方式为应用程序提供横切关注点的支持,这样开发者就可以将这些关注点模块化,并保持业务逻辑组件的聚焦和简洁。

如果对动态代理感兴趣可以再调试看看,这里是JDK动态代理是因为public class MyServiceImpl implements MyService 实现了接口,调试如下:

简单说一下这里能看到的关键类和接口

ProxyFactory: 这是Spring AOP用来创建代理对象的工厂类。它可以根据目标对象是否实现接口来决定使用JDK动态代理还是CGLIB代理。

AopProxy: 这个接口定义了获取代理对象的方法。它有两个主要实现:JdkDynamicAopProxy(用于JDK动态代理)和CglibAopProxy(用于CGLIB代理)。

JdkDynamicAopProxy: 实现了AopProxy接口,使用JDK动态代理技术创建代理。它实现了InvocationHandler接口,拦截对代理对象的所有方法调用。

CglibAopProxy: 同样实现了AopProxy接口,但使用CGLIB库来创建代理对象。对于没有实现接口的类,Spring会选择这种方式来创建代理。

如果大家想深入了解Spring AOP的源码,可以直接查看JdkDynamicAopProxyCglibAopProxy这两个类的实现。这里不是本篇重点,简单提一下:

比如在JdkDynamicAopProxy中看到动态代理的实现:

  1. JdkDynamicAopProxy类实现了InvocationHandler接口,这是JDK动态代理的核心。在其invoke方法中,会有逻辑判断是否需要对调用进行拦截,并在调用前后应用相应的通知。

  2. 创建代理的过程主要是在ProxyFactory通过调用createAopProxy()方法时完成的,这个方法会根据配置返回JdkDynamicAopProxyCglibAopProxy的实例。

  3. 代理的使用:客户端代码通过ProxyFactory获取代理对象,并通过这个代理对象调用目标方法。代理对象在内部使用JdkDynamicAopProxyCglibAopProxy来拦截这些调用,并根据AOP配置执行通知。通过ProxyFactory获取代理对象的过程,通常在Spring的配置和使用中是隐式完成的,特别是在使用Spring容器管理AOP时。这一过程不需要开发者直接调用ProxyFactory类。当Spring配置中定义了一个bean,并对其应用了切面,Spring容器会自动处理代理的创建和应用通知的过程。这是通过Spring的后处理器和AOP命名空间的支持实现的,开发者通常只需声明式地配置切面和通知即可。

如果想看到CGLIB代理,这里有2种方法

1种方法是去掉MyServiceImpl实现的MyService接口,然后把主程序和expression表达式对应的地方改成MyServiceImpl
2种方法就是Spring配置文件中显式设置<aop:config>标签的proxy-target-class="true"属性来实现这一点。如下:

<aop:config proxy-target-class="true">
    <!-- 其他配置保持不变 -->
</aop:config>

调试如下:

 

欢迎一键三连~

有问题请留言,大家一起探讨学习

点击关注,第一时间了解华为云新鲜技术~

 

展开阅读全文
  • 0
    感动
  • 0
    路过
  • 0
    高兴
  • 0
    难过
  • 0
    搞笑
  • 0
    无聊
  • 0
    愤怒
  • 0
    同情
热度排行
友情链接