Spring AOP 面向切面编程

快乐的小三菊

已于 2024-01-29 11:17:06 修改

阅读量617

点赞数

分类专栏： # Spring 杂记文章标签： spring

于 2018-11-14 16:47:02 首次发布

本文链接：https://blog.csdn.net/xhf852963/article/details/84069400

版权

Spring 杂记专栏收录该内容

15 篇文章 1 订阅

订阅专栏

一、场景模拟

1.1 示例代码

1、创建子模块 spring6-aop

2、声明计算器接口 Calculator，包含加减乘除的抽象方法，代码如下：

public interface Calculator {
    
    int add(int i, int j); 
    int sub(int i, int j);
    int mul(int i, int j);
    int div(int i, int j);
    
}

3、创建实现类，如下：

public class CalculatorImpl implements Calculator {
    
    @Override
    public int add(int i, int j) {
        int result = i + j;
        System.out.println("方法内部 result = " + result);
        return result;
    }
    
    @Override
    public int sub(int i, int j) {
        int result = i - j;
        System.out.println("方法内部 result = " + result);
        return result;
    }
    
    @Override
    public int mul(int i, int j) {
        int result = i * j;
        System.out.println("方法内部 result = " + result);
        return result;
    }
    
    @Override
    public int div(int i, int j) {
        int result = i / j;
        System.out.println("方法内部 result = " + result);
        return result;
    }
}

4、创建一个带日志功能的实现类

public class CalculatorLogImpl implements Calculator {
    
    @Override
    public int add(int i, int j) {
    
        System.out.println("[日志] add 方法开始了，参数是：" + i + "," + j);
  
        int result = i + j;
    
        System.out.println("方法内部 result = " + result);
    
        System.out.println("[日志] add 方法结束了，结果是：" + result);
    
        return result;
    }
    
    @Override
    public int sub(int i, int j) {
    
        System.out.println("[日志] sub 方法开始了，参数是：" + i + "," + j);
    
        int result = i - j;
    
        System.out.println("方法内部 result = " + result);
    
        System.out.println("[日志] sub 方法结束了，结果是：" + result);
    
        return result;
    }
    
    @Override
    public int mul(int i, int j) {
    
        System.out.println("[日志] mul 方法开始了，参数是：" + i + "," + j);
    
        int result = i * j;
    
        System.out.println("方法内部 result = " + result);
    
        System.out.println("[日志] mul 方法结束了，结果是：" + result);
    
        return result;
    }
    
    @Override
    public int div(int i, int j) {
    
        System.out.println("[日志] div 方法开始了，参数是：" + i + "," + j);
    
        int result = i / j;
    
        System.out.println("方法内部 result = " + result);
    
        System.out.println("[日志] div 方法结束了，结果是：" + result);
    
        return result;
    }
}

1.2 提出问题

1.2.1 现有代码缺陷

针对带日志功能的实现类，我们发现有如下缺陷：对核心业务功能有干扰，导致程序员在开发核心业务功能时分散了精力。附加功能分散在各个业务功能方法中，不利于统一维护。

1.2.2 解决思路

解决这两个问题，核心就是：解耦。我们需要把附加功能从业务功能代码中抽取出来。

1.2.3 困难

解决问题的困难：要抽取的代码在方法内部，靠以前把子类中的重复代码抽取到父类的方式没法解决。所以需要引入新的技术。

二、代理模式

2.1 概念

代理模式的作用就是通过提供一个代理类，让我们在调用目标方法的时候，不再是直接对目标方法进行调用，而是通过代理类间接调用。让不属于目标方法核心逻辑的代码从目标方法中剥离出来，从而实现解耦。调用目标方法时先调用代理对象的方法，减少对目标方法的调用和打扰，同时让附加功能能够集中在一起也有利于统一维护。

2.2 静态代理

创建一个静态代理类，如下所示：

public class CalculatorStaticProxy implements Calculator {
    
    // 将被代理的目标对象声明为成员变量
    private Calculator target;
    
    public CalculatorStaticProxy(Calculator target) {
        this.target = target;
    }
    
    @Override
    public int add(int i, int j) {
    
        // 附加功能由代理类中的代理方法来实现
        System.out.println("[日志] add 方法开始了，参数是：" + i + "," + j);
    
        // 通过目标对象来实现核心业务逻辑
        int addResult = target.add(i, j);
    
        System.out.println("[日志] add 方法结束了，结果是：" + addResult);
    
        return addResult;
    }
}

静态代理确实实现了解耦，但是由于代码都写死了，完全不具备任何的灵活性。就拿日志功能来说，将来其他地方也需要附加日志，那还得再声明更多个静态代理类，那就产生了大量重复的代码，日志功能还是分散的，没有统一管理。

能否将日志功能集中到一个代理类中，将来有任何日志需求，都通过这一个代理类来实现。这就需要使用动态代理技术了。

2.3 动态代理

创建一个生产代理对象的工厂类，代码如下：

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.Arrays;

public class ProxyFactory {

    private Object target;

    public ProxyFactory(Object target) {
        this.target = target;
    }

    public Object getProxy(){

        /**
         * newProxyInstance()：创建一个代理实例
         * 其中有三个参数：
         * 1、classLoader：加载动态生成的代理类的类加载器
         * 2、interfaces：目标对象实现的所有接口的class对象所组成的数组
         * 3、invocationHandler：设置代理对象实现目标对象方法的过程，即代理类中如何重写接口中的抽象方法
         */
        ClassLoader classLoader = target.getClass().getClassLoader();
        Class<?>[] interfaces = target.getClass().getInterfaces();
        InvocationHandler invocationHandler = new InvocationHandler() {
            @Override
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                /**
                 * proxy：代理对象
                 * method：代理对象需要实现的方法，即其中需要重写的方法
                 * args：method 所对应方法的参数
                 */
                Object result = null;
                try {
                    System.out.println("[动态代理][日志] "+method.getName()+"，参数："+ Arrays.toString(args));
                    result = method.invoke(target, args);
                    System.out.println("[动态代理][日志] "+method.getName()+"，结果："+ result);
                } catch (Exception e) {
                    e.printStackTrace();
                    System.out.println("[动态代理][日志] "+method.getName()+"，异常："+e.getMessage());
                } finally {
                    System.out.println("[动态代理][日志] "+method.getName()+"，方法执行完毕");
                }
                return result;
            }
        };

        return Proxy.newProxyInstance(classLoader, interfaces, invocationHandler);
    }
}

测试代码如下：

@Test
public void testDynamicProxy(){
	ProxyFactory factory = new ProxyFactory(new CalculatorLogImpl());
	Calculator proxy = (Calculator) factory.getProxy();
	proxy.div(1,2);
	//proxy.div(1,1);
}

三、AOP 概念及相关术语

3.1 概念

AOP（Aspect Oriented Programming）是一种设计思想，是软件设计领域中的面向切面编程，它是面向对象编程的一种补充和完善，它以通过预编译方式和运行期动态代理方式实现，在不修改源代码的情况下，给程序动态统一添加额外功能的一种技术。

利用 AOP 可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。

3.2 相关术语

3.2.1 横切关注点

分散在每个各个模块中解决同一样的问题，如用户验证、日志管理、事务处理、数据缓存都属于横切关注点。

从每个方法中抽取出来的同一类非核心业务。在同一个项目中，我们可以使用多个横切关注点对相关方法进行多个不同方面的增强。

这个概念不是语法层面的，而是根据附加功能的逻辑上的需要：有十个附加功能，就有十个横切关注点。

3.2.2 通知

每一个横切关注点上要做的事情都需要写一个方法来实现，这样的方法就叫通知方法。通知方法有以下几种：

1、前置通知：在被代理的目标方法前执行

2、返回通知：在被代理的目标方法成功结束后执行

3、异常通知：在被代理的目标方法异常结束后执行

4、后置通知：在被代理的目标方法最终结束后执行

5、环绕通知：使用 try...catch...finally 结构围绕整个被代理的目标方法，包括上面四种通知对应的所有位置。

3.2.3 切面

封装通知方法的类

3.2.4 目标

被代理的目标对象。

3.2.5 代理

向目标对象应用通知之后创建的代理对象。

3.2.6 连接点

这也是一个纯逻辑概念，不是语法定义的。

把方法排成一排，每一个横切位置看成 x 轴方向，把方法从上到下执行的顺序看成 y 轴，x 轴和 y 轴的交叉点就是连接点。通俗说，就是 spring 允许你使用通知的地方。

3.2.7 切入点

定位连接点的方式。每个类的方法中都包含多个连接点，所以连接点是类中客观存在的事物（从逻辑上来说）。如果把连接点看作数据库中的记录，那么切入点就是查询记录的 SQL 语句。

Spring 的 AOP 技术可以通过切入点定位到特定的连接点。通俗说，要实际去增强的方法，切点通过 org.springframework.aop.Pointcut 接口进行描述，它使用类和方法作为连接点的查询条件。

3.2.8 作用

1、简化代码：把方法中固定位置的重复的代码抽取出来，让被抽取的方法更专注于自己的核心功能，提高内聚性。

2、代码增强：把特定的功能封装到切面类中，看哪里有需要，就往上套，被套用了切面逻辑的方法就被切面给增强了。

四、基于注解的 AOP

4.1 技术说明

1、动态代理分为 JDK 动态代理和 cglib 动态代理

2、当目标类有接口的情况使用 JDK 动态代理和 cglib 动态代理，没有接口时只能使用 cglib 动态代理。

3、JDK 动态代理动态生成的代理类会在 com.sun.proxy 包下，类名为 $proxy1，和目标类实现相同的接口。

4、cglib 动态代理动态生成的代理类会和目标在在相同的包下，会继承目标类。

5、动态代理（InvocationHandler）：JDK 原生的实现方式，需要被代理的目标类必须实现接口。因为这个技术要求代理对象和目标对象实现同样的接口（兄弟两个拜把子模式）。

6、cglib：通过继承被代理的目标类（认干爹模式）实现代理，所以不需要目标类实现接口。

7、AspectJ：是 AOP 思想的一种实现。本质上是静态代理，将代理逻辑 “织入” 被代理的目标类编译得到的字节码文件，所以最终效果是动态的。weaver 就是织入器。Spring 是依赖 AspectJ 中的注解来实现了 AOP 的功能。

4.2 准备工作

4.2.1 添加依赖

在 IOC 所需依赖基础上再加入下面依赖即可

<!--spring aop依赖-->
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-aop</artifactId>
	<version>6.0.16</version>
</dependency>
<!--spring aspects依赖-->
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-aspects</artifactId>
	<version>6.0.16</version>
</dependency>

4.2.2 创建接口和实现类

准备被代理的接口和实现类，代码如下：

public interface Calculator {
    int add(int i, int j); 
    int sub(int i, int j);
    int mul(int i, int j);
    int div(int i, int j);
}

import com.tansun.Calculator;
import org.springframework.stereotype.Component;

@Component
public class CalculatorImpl implements Calculator {
    
    @Override
    public int add(int i, int j) {
        int result = i + j;
        System.out.println("方法内部 result = " + result);
        return result;
    }
    
    @Override
    public int sub(int i, int j) {
        int result = i - j;
        System.out.println("方法内部 result = " + result);
        return result;
    }
    
    @Override
    public int mul(int i, int j) {
        int result = i * j;
        System.out.println("方法内部 result = " + result);
        return result;
    }
    
    @Override
    public int div(int i, int j) {
        int result = i / j;
        System.out.println("方法内部 result = " + result);
        return result;
    }
}

4.2.3 配置 xml

在 Spring 的配置文件中开启注解扫描，并开启 AspectJ 的自动代理，如下：

<?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:context="http://www.springframework.org/schema/context"
       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/context
       http://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/aop
       http://www.springframework.org/schema/aop/spring-aop.xsd">
    <!--
        基于注解的AOP的实现：
        1、将目标对象和切面交给IOC容器管理（注解+扫描）
        2、开启AspectJ的自动代理，为目标对象自动生成代理
        3、将切面类通过注解@Aspect标识
    -->
    <context:component-scan base-package="com.tansun"></context:component-scan>

    <aop:aspectj-autoproxy />
</beans>

4.2.4 创建切面类

创建切面类并配置，如下：

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

import java.util.Arrays;

// @Aspect表示这个类是一个切面类
@Aspect
// @Component注解保证这个切面类能够放入IOC容器
@Component
public class LogAspect {
    
    @Before("execution(public int com.tansun.impl.CalculatorImpl.*(..))")
    public void beforeMethod(JoinPoint joinPoint){
        String methodName = joinPoint.getSignature().getName();
        String args = Arrays.toString(joinPoint.getArgs());
        System.out.println("Logger-->前置通知，方法名："+methodName+"，参数："+args);
    }

    @After("execution(* com.tansun.impl.CalculatorImpl.*(..))")
    public void afterMethod(JoinPoint joinPoint){
        String methodName = joinPoint.getSignature().getName();
        System.out.println("Logger-->后置通知，方法名："+methodName);
    }

    @AfterReturning(value = "execution(* com.tansun.impl.CalculatorImpl.*(..))", returning = "result")
    public void afterReturningMethod(JoinPoint joinPoint, Object result){
        String methodName = joinPoint.getSignature().getName();
        System.out.println("Logger-->返回通知，方法名："+methodName+"，结果："+result);
    }

    @AfterThrowing(value = "execution(* com.tansun.impl.CalculatorImpl.*(..))", throwing = "ex")
    public void afterThrowingMethod(JoinPoint joinPoint, Throwable ex){
        String methodName = joinPoint.getSignature().getName();
        System.out.println("Logger-->异常通知，方法名："+methodName+"，异常："+ex);
    }
    
    @Around("execution(* com.tansun.impl.CalculatorImpl.*(..))")
    public Object aroundMethod(ProceedingJoinPoint joinPoint){
        String methodName = joinPoint.getSignature().getName();
        String args = Arrays.toString(joinPoint.getArgs());
        Object result = null;
        try {
            System.out.println("环绕通知-->目标对象方法执行之前");
            //目标对象（连接点）方法的执行
            result = joinPoint.proceed();
            System.out.println("环绕通知-->目标对象方法返回值之后");
        } catch (Throwable throwable) {
            throwable.printStackTrace();
            System.out.println("环绕通知-->目标对象方法出现异常时");
        } finally {
            System.out.println("环绕通知-->目标对象方法执行完毕");
        }
        return result;
    }
}

4.2.5 测试

@Test
public void testAdd(){
	ApplicationContext ac = new ClassPathXmlApplicationContext("bean.xml");
	Calculator calculator = ac.getBean( Calculator.class);
	int add = calculator.add(1, 1);
	System.out.println("执行成功:"+add);
}

4.3 各种通知

4.3.1 通知类型

1、前置通知：使用 @Before 注解标识，在被代理的目标方法前执行

2、返回通知：使用 @AfterReturning 注解标识，在被代理的目标方法成功结束后执行

3、异常通知：使用 @AfterThrowing 注解标识，在被代理的目标方法异常结束后执行

4、后置通知：使用 @After 注解标识，在被代理的目标方法最终结束后执行

5、环绕通知：使用 @Around 注解标识，使用 try...catch...finally 结构围绕整个被代理的目标方法，包括上面四种通知对应的所有位置

4.3.2 通知执行顺序

Spring 版本 5.3.x 以前：前置通知 > 目标操作 > 后置通知 > 返回通知或异常通知

Spring 版本 5.3.x 以后：前置通知 > 目标操作 > 返回通知或异常通知 > 后置通知

4.4 切入点表达式语法

切入点表达式就是下面的这个东西，

@Before("execution(public int com.tansun.impl.CalculatorImpl.*(..))")

1、如果用 * 号代替 “权限修饰符” 和 “返回值” 部分，则表示 “权限修饰符” 和 “返回值” 不限。

2、在包名的部分，一个 * 号只能代表包的层次结构中的一层，表示这一层是任意的。比如说：*.Hello 匹配 com.Hello，不匹配 com.tansun.Hello

3、在包名的部分，使用 *.. 表示包名任意、包的层次深度任意

4、在类名的部分，类名部分整体用 * 号代替，表示类名任意

5、在类名的部分，可以使用 * 号代替类名的一部分，比如说：*Service 匹配所有名称以 Service 结尾的类或接口。

6、在方法名部分，可以使用 * 号表示方法名任意

7、在方法名部分，可以使用 * 号代替方法名的一部分，比如说：*Operation 匹配所有方法名以 Operation 结尾的方法。

8、在方法参数列表部分，使用 (..) 表示参数列表任意

9、在方法参数列表部分，使用 (int,..) 表示参数列表以一个 int 类型的参数开头

10、在方法参数列表部分，基本数据类型和对应的包装类型是不一样的，即切入点表达式中使用 int 和实际方法中 Integer 是不匹配的。

11、在方法返回值部分，如果想要明确指定一个返回值类型，那么必须同时写明权限修饰符。

// 正确
execution(public int *..*Service.*(.., int))

// 错误
execution(* int *..*Service.*(.., int))

4.5 重用切入点表达式

上面我们是把切入点表达式都写在了具体的方法上面，每个方法都需要写切入点表达式，这样太麻烦了，我们可以把切入点表达式写在一个方法上面，其他的方法只需要调用这个方法就可以了，如下：

@Pointcut("execution(* com.tansun.impl.CalculatorImpl.*(..))")
public void pointCut(){

}

切他的通知只需要类里面如下配置即可：

@After("pointCut()")
public void afterMethod(JoinPoint joinPoint){
	String methodName = joinPoint.getSignature().getName();
	System.out.println("Logger-->后置通知，方法名："+methodName);
}

4.5.1 在同一个切面中使用

只需要在 @After 中添加定义的切点方法名称即可

@After("pointCut()")
public void afterMethod(JoinPoint joinPoint){
	String methodName = joinPoint.getSignature().getName();
	System.out.println("Logger-->后置通知，方法名："+methodName);
}

4.5.2 在不同切面中使用

只需要加上方法所在的路径和类名再加上方法名即可，如下

@Before("com.atguigu.aop.CommonPointCut.pointCut()")
public void beforeMethod(JoinPoint joinPoint){
    String methodName = joinPoint.getSignature().getName();
    String args = Arrays.toString(joinPoint.getArgs());
    System.out.println("Logger-->前置通知，方法名："+methodName+"，参数："+args);
}

4.6 切面的优先级

相同目标方法上同时存在多个切面时，切面的优先级控制切面的内外嵌套顺序。

使用 @Order 注解可以控制切面的优先级：@Order（较小的数）优先级高，@Order（较大的数）优先级低。

五、基于 XML 的 AOP

5.1 修改配置类

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

import java.util.Arrays;


// @Component注解保证这个切面类能够放入IOC容器
@Component
public class LogAspect {

    public void beforeMethod(JoinPoint joinPoint){
        String methodName = joinPoint.getSignature().getName();
        String args = Arrays.toString(joinPoint.getArgs());
        System.out.println("Logger-->前置通知，方法名："+methodName+"，参数："+args);
    }

    public void afterMethod(JoinPoint joinPoint){
        String methodName = joinPoint.getSignature().getName();
        System.out.println("Logger-->后置通知，方法名："+methodName);
    }

    public void afterReturningMethod(JoinPoint joinPoint, Object result){
        String methodName = joinPoint.getSignature().getName();
        System.out.println("Logger-->返回通知，方法名："+methodName+"，结果："+result);
    }

    public void afterThrowingMethod(JoinPoint joinPoint, Throwable ex){
        String methodName = joinPoint.getSignature().getName();
        System.out.println("Logger-->异常通知，方法名："+methodName+"，异常："+ex);
    }

    public Object aroundMethod(ProceedingJoinPoint joinPoint){
        String methodName = joinPoint.getSignature().getName();
        String args = Arrays.toString(joinPoint.getArgs());
        Object result = null;
        try {
            System.out.println("环绕通知-->目标对象方法执行之前");
            //目标对象（连接点）方法的执行
            result = joinPoint.proceed();
            System.out.println("环绕通知-->目标对象方法返回值之后");
        } catch (Throwable throwable) {
            throwable.printStackTrace();
            System.out.println("环绕通知-->目标对象方法出现异常时");
        } finally {
            System.out.println("环绕通知-->目标对象方法执行完毕");
        }
        return result;
    }
}

5.2 修改配置文件

<?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:context="http://www.springframework.org/schema/context"
       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/context
       http://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/aop
       http://www.springframework.org/schema/aop/spring-aop.xsd">

    <!--开启注解扫描-->
    <context:component-scan base-package="com.tansun"></context:component-scan>

    <aop:config>
        <!--配置切面类,ref 指向的是我们的切面类-->
        <aop:aspect ref="logAspect">
            <!--配置切入点-->
            <aop:pointcut id="pointCut" expression="execution(* com.tansun.impl.CalculatorImpl.*(..))"/>
               <!-- 配置前置通知-->
            <aop:before method="beforeMethod" pointcut-ref="pointCut"></aop:before>
               <!-- 配置后置通知-->
            <aop:after method="afterMethod" pointcut-ref="pointCut"></aop:after>
               <!-- 配置返回后通知-->
            <aop:after-returning method="afterReturningMethod" returning="result" pointcut-ref="pointCut"></aop:after-returning>
                <!--  配置异常通知-->
            <aop:after-throwing method="afterThrowingMethod" throwing="ex" pointcut-ref="pointCut"></aop:after-throwing>
                <!--  配置环绕通知-->
            <aop:around method="aroundMethod" pointcut-ref="pointCut"></aop:around>
        </aop:aspect>
    </aop:config>
</beans>

5.3 测试

@Test
public void testAdd(){
	ApplicationContext ac = new ClassPathXmlApplicationContext("bean-aop.xml");
	Calculator calculator = ac.getBean( Calculator.class);
	int add = calculator.add(1, 1);
	System.out.println("执行成功:"+add);
}