Spring-AOP

一、AOP概念及相关术语

1、概述

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

2、相关术语

①横切关注点
从每个方法中抽取出来的同一类非核心业务。在同一个项目中，我们可以使用多个横切关注点对相关方法进行多个不同方面的增强。
这个概念不是语法层面天然存在的，而是根据附加功能的逻辑上的需要：有十个附加功能，就有十个横切关注点。

②通知
每一个横切关注点上要做的事情都需要写一个方法来实现，这样的方法就叫通知方法。
前置通知：在被代理的目标方法前执行
返回通知：在被代理的目标方法成功结束后执行（寿终正寝）
异常通知：在被代理的目标方法异常结束后执行（死于非命）
后置通知：在被代理的目标方法最终结束后执行（盖棺定论）
环绕通知：使用try…catch…finally结构围绕整个被代理的目标方法，包括上面四种通知对应的所有位置

③切面
封装通知方法的类。

④目标
被代理的目标对象。

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

⑥连接点
这也是一个纯逻辑概念，不是语法定义的。
把方法排成一排，每一个横切位置看成x轴方向，把方法从上到下执行的顺序看成y轴，x轴和y轴的交叉点就是连接点。

⑦切入点
定位连接点的方式。
每个类的方法中都包含多个连接点，所以连接点是类中客观存在的事物（从逻辑上来说）。
如果把连接点看作数据库中的记录，那么切入点就是查询记录的 SQL 语句。
Spring 的 AOP 技术可以通过切入点定位到特定的连接点。
切点通过 org.springframework.aop.Pointcut 接口进行描述，它使用类和方法作为连接点的查询条件。

3、作用

①简化代码：把方法中固定位置的重复的代码抽取出来，让被抽取的方法更专注于自己的核心功能，提高内聚性。
②代码增强：把特定的功能封装到切面类中，看哪里有需要，就往上套，被套用了切面逻辑的方法就被切面给增强了。

二、基于注解的AOP

1、技术说明

动态代理（InvocationHandler）：JDK原生的实现方式，需要被代理的目标类必须实现接口。因为这个技术要求代理对象和目标对象实现同样的接口（兄弟两个拜把子模式）。
cglib：通过继承被代理的目标类（认干爹模式）实现代理，所以不需要目标类实现接口。
AspectJ：本质上是静态代理，将代理逻辑“织入”被代理的目标类编译得到的字节码文件，所以最终效果是动态的。weaver就是织入器。Spring只是借用了AspectJ中的注解。

2、准备工作

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

<!-- spring-aspects会帮我们传递过来aspectjweaver -->
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-aspects</artifactId>
	<version>5.3.1</version>
</dependency>

②准备被代理的目标资源
接口：

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 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;
    }
}

3、创建切面类并配置

@Component
@Aspect  //将当前组件标识为切面
public class LoggerAspect {
    /*重用切入点表达式*/
    @Pointcut("execution(* com.spring.aop.annotation.CalculatorImpl.*(..))")
    public void pointCut(){ }

    //@Before("execution(public int com.spring.aop.annotation.CalculatorImpl.add(int,int ))")
    @Before("execution(* com.spring.aop.annotation.CalculatorImpl.*(..))")
    public void beforeAdviceMethod(JoinPoint joinPoint){
        //获取连接对应的方法的签名信息
        Signature signature = joinPoint.getSignature();
        //获取连接点所对应方法的参数
        Object[] args = joinPoint.getArgs();
        System.out.println("LoggerAspect,方法："+signature.getName()+",参数"+ Arrays.toString(args));
    }

    @After("pointCut()")
    public void afterAdviceMethod(JoinPoint joinPoint){
        //获取连接对应的方法的签名信息
        Signature signature = joinPoint.getSignature();
        System.out.println("LoggerAspect,方法："+signature.getName()+",执行完毕");
    }

    /*在返回通知中若要获取目标对象方法的返回值
    只需要通过@AfterReturning注解的returning属性
    就可以将通知方法的某个参数指定为接收目标对象方法的返回值的参数
    */
    @AfterReturning(value = "pointCut()",returning = "result")
    public void afterReturningAdviceMethod(JoinPoint joinPoint,Object result){
        //获取连接对应的方法的签名信息
        Signature signature = joinPoint.getSignature();
        System.out.println("LoggerAspect,方法："+signature.getName()+",结果："+result);
    }

    /*在异常通知中若要获取目标对象方法的返回值
    只需要通过@AfterThrowing注解的throwing属性
    就可以将通知方法的某个参数指定为接收目标对象方法的返回值的参数
    */
    @AfterThrowing(value = "pointCut()",throwing = "ex")
    public void afterThrowingAdviceMethod(JoinPoint joinPoint,Throwable ex){
        //获取连接对应的方法的签名信息
        Signature signature = joinPoint.getSignature();
        System.out.println("LoggerAspect,方法："+signature.getName()+"，异常:"+ex);
    }

    @Around("pointCut()")
    //目标方法的执行，目标方法的返回值一定要返回给外界调用者
    public Object aroundAdviceMethod(ProceedingJoinPoint joinPoint){
        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;
    }
}

在Spring的配置文件中配置：

<context:component-scan base-package="com.spring.aop.annotation"></context:component-scan>

    <!--开启基于注解的AOP-->
    <aop:aspectj-autoproxy />

4、重用切入点表达式

①声明

/*重用切入点表达式*/
    @Pointcut("execution(* com.spring.aop.annotation.CalculatorImpl.*(..))")
    public void pointCut(){ }

②在同一个切面中使用

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

③在不同切面中使用

@Before("com.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);
}

5、各种通知

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

@Before("execution(* com.spring.aop.annotation.CalculatorImpl.*(..))")
//获取连接点信息可以在通知方法的参数位置设置JoinPoint类型的形参
    public void beforeAdviceMethod(JoinPoint joinPoint){
        //获取连接对应的方法的签名信息
        Signature signature = joinPoint.getSignature();
        //获取连接点所对应方法的参数
        Object[] args = joinPoint.getArgs();
        System.out.println("LoggerAspect,方法："+signature.getName()+",参数"+ Arrays.toString(args));
    }

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

@AfterReturning(value = "pointCut()",returning = "result")
    public void afterReturningAdviceMethod(JoinPoint joinPoint,Object result){
        //获取连接对应的方法的签名信息
        Signature signature = joinPoint.getSignature();
        System.out.println("LoggerAspect,方法："+signature.getName()+",结果："+result);
    }

在返回通知中若要获取目标对象方法的返回值，
只需要通过@AfterReturning注解的returning属性，就可以将通知方法的某个参数指定为接收目标对象方法的返回值的参数

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

@AfterThrowing(value = "pointCut()",throwing = "ex")
    public void afterThrowingAdviceMethod(JoinPoint joinPoint,Throwable ex){
        //获取连接对应的方法的签名信息
        Signature signature = joinPoint.getSignature();
        System.out.println("LoggerAspect,方法："+signature.getName()+"，异常:"+ex);
    }

在异常通知中若要获取目标对象方法的返回值，
只需要通过@AfterThrowing注解的throwing属性，就可以将通知方法的某个参数指定为接收目标对象方法的返回值的参数

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

@After("pointCut()")
    public void afterAdviceMethod(JoinPoint joinPoint){
        //获取连接对应的方法的签名信息
        Signature signature = joinPoint.getSignature();
        System.out.println("LoggerAspect,方法："+signature.getName()+",执行完毕");
    }

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

@Around("pointCut()")
    //目标方法的执行，目标方法的返回值一定要返回给外界调用者
    public Object aroundAdviceMethod(ProceedingJoinPoint joinPoint){
        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;
    }

6、切面的优先级

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

优先级高的切面：外面
优先级低的切面：里面

可以通过@order注解的value属性设置优先级，默认值Integer的最大值
@order注解的value属性值越小,优先级越高

三、基于XML的AOP

1、准备工作

参考基于注解的AOP环境
（将除了@Component注解的其他注解都删除）

2、实现

<context:component-scan base-package="com.atguigu.aop.xml"></context:componentscan>
<aop:config>
	<!--配置切面类-->
	<aop:aspect ref="loggerAspect">
		<aop:pointcut id="pointCut" expression="execution(*
com.atguigu.aop.xml.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" pointcutref="pointCut"></aop:after-throwing>
		<aop:around method="aroundMethod" pointcut-ref="pointCut"></aop:around>
	</aop:aspect>
	<aop:aspect ref="validateAspect" order="1">
		<aop:before method="validateBeforeMethod" pointcut-ref="pointCut"></aop:before>
	</aop:aspect>
</aop:config>