Spring学习（三） -- AOP

AOP 概述

• AOP：全称是 Aspect Oriented Programming,即：面向切面编程。
• 通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续，是软件开发中的一个热点，也是Spring框架中的一个重要内容，是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率
• 简单说就是 把我们程序重复的代码抽取出来，在需要执行的时候，使用动态代理技术，在不需要修改源码的基础上，对我们已有的方法进行增强。

作用及优势

• 作用：
  在程序运行期间，不修改源码对已有方法进行增强。
• 优势
  减少重复代码
  提高开发效率
  维护方便

实现方式

• 使用动态代理技术

Spring中的AOP相关术语

• Joinpoint（连接点）：
  所谓连接点是指那些被拦截到的点，在 Spring中，这些点指的是方法，因为 spring只支持方法类型的连接点。
• Pointcut（切入点）：
  所谓切入点是指我们要对哪些 Joinpoint进行拦截的定义。
• Advice（通知/增强）：
  所谓通知是指拦截到 Joinpoint之后所要做的事情就是通知。
  通知的类型：前置通知，后置通知，异常通知，最终通知，环绕通知。
• Introduction（引介）：
  引介是一种特殊的同在在不修改类代码的前提下，Introduction可以在运行期为类动态地添加一些方法或 Field。
• Target（目标对象）：
  代理的目标对象。
• Weaving（织入）：
  是指把增强应用到目标对象来创建新的代理对象的过程
  spring采用动态代理织入，而 AspectJ采用编译期织入和类转载器织入。
• Proxy（代理）：
  一个类被 AOP织入增强后，就产生一个结果代理类。
• Aspect（切面）：
  是切入点和通知（引介）的结合。

---

XML方式：

导入：org.springframework ， org.aspectj

• 配置 bean.xml, spring中基于XML的AOP配置步骤

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

    <!--spring中基于XML的AOP配置步骤
        1.把通知Bean也交给spring来管理
        2.使用aop:config标签表面开始AOP的配置
        3.使用aop:aspect标签表面配置切面
            id属性：是给切面提供一个唯一标识
            ref属性：是指定通知类bean的id
        4.在aop:aspect标签的内部使用对应标签来配置通知的类型
            我们现在示例是让printLog方法在切入点放执行之前执行：所以是前置通知
            aop:before：表示配置前置通知
                method属性:用于指定Logger类中那个方法是前置通知
                pointcut属性：用于指定切入点表达式，该表达式的含义指的是对业务层中哪些方法增强

          切入点表达式的写法：
                关键字：execution（表达式）
                表达式：
                    访问修饰符 返回值 包名.包名...类名.方法名（参数列表）
                标准的表达式写法：
                    public void com.oym.service.impl.AccountServiceImpl.saveAccount()
                访问修饰符是可以省略的
                    void com.oym.service.impl.AccountServiceImpl.saveAccount()
                返回值可以使用通配符，表示任意返回值
                    * com.oym.service.impl.AccountServiceImpl.saveAccount()
                包名可以使用通配符，表示任意包，但是有几级包，就需要写几个*
                    * *.*.*.*.AccountServiceImpl.saveAccount()
                包名可以使用..表示当前包及其子包
                    * *..AccountServiceImpl.saveAccount()
                类名和方法名都可以使用*来实现通配
                    * *..*.*()
                参数列表：
                    可以直接写数据类型：
                        基本数据类型直接写名称     int
                        引用类型写包名.类名的方式  java.lang.String
                    可以使用通配符表示任意类型，但是必须有参数
                    可以使用..表示有无参数均可，有参数可以是任意类型
                全通配写法：
                    * *..*.*(..)

                实际开发中切入点表达式通常写法：
                    切到业务层实现类下的所有方法
                        * com.oym.service.impl.*.*(..)
    -->

    <!--配置spring的ioc，把service对象配置进来-->
    <bean id="accountService" class="com.oym.service.impl.AccountServiceImpl"></bean>

    <!--配置Logger类-->
    <bean id="logger" class="com.oym.utils.Logger"></bean>

    <!--配置AOP-->
    <aop:config>
        <!--配置切面-->
        <aop:aspect id="logAdvice" ref="logger">
            <!--配置通知的类型，并且建立通知方法和切入点方法的关联-->
            <aop:before method="printLog" pointcut="execution(public void com.oym.service.impl.AccountServiceImpl.saveAccount())"></aop:before>
        </aop:aspect>

    </aop:config>

• 各通知类型的配置：

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


    <!--配置spring的ioc，把service对象配置进来-->
    <bean id="accountService" class="com.oym.service.impl.AccountServiceImpl"></bean>

    <!--配置Logger类-->
    <bean id="logger" class="com.oym.utils.Logger"></bean>

    <!--配置AOP-->
    <aop:config>
        <!--配置切入点表达式 id属性用于指定表达式的唯一标识。expression属性用于指定表达式内容
                此标签写在aop:aspect标签内部，只能给当前切面使用
                它还可以写在aop:aspect外面，此时就变成了所有切面可用
            -->
        <aop:pointcut id="pt1" expression="execution(* com.oym.service.impl.AccountServiceImpl.*(..))"/>
        <!--配置切面-->
        <aop:aspect id="logAdvice" ref="logger">
            <!--配置前置通知:在切入点方法执行之前执行-->
            <aop:before method="beforePrintLog" pointcut-ref="pt1"></aop:before>

            <!--配置后置通知：在切入点方法正常执行之后执行。它和异常通知只能执行一个-->
            <aop:after-returning method="afterReturnPrintLog" pointcut-ref="pt1"></aop:after-returning>

            <!--配置异常通知：在切入点方法执行产生异常之后执行-->
            <aop:after-throwing method="afterThrowingLog" pointcut-ref="pt1"></aop:after-throwing>

            <!--配置最终通知：无论方法是否正常执行都会在最后执行-->
            <aop:after method="afterPrintLog" pointcut-ref="pt1"></aop:after>

            <!--配置环绕通知-->
            <aop:around method="aroundPrintLog" pointcut-ref="pt1"></aop:around>
        </aop:aspect>

    </aop:config>
</beans>

• 在类中环绕通知的部署

/*
     * 环绕通知
     * 问题：
     *      当我们配置了环绕通知之后，切入点方法没有执行，而通知方法执行了
     * 分析：
     *      通过对比动态代理中的环绕通知代码，发现动态代理的环绕通知有明确的切入点方法调用，而我们代码没有。
     * 解决：
     *      Spring框架为我们提供了一个接口：ProceedingJoinPoint 该接口有一个方法proceed()，此方法就相当于明确调用切入点方法
     *      该接口可以作为环绕通知的方法参数，在程序执行时，spring框架会为我们提供该接口的实现类供我们使用。
     * spring中的环绕通知：
     *      它是spring框架为我们提供的一种可以在代码中手动控制增强方法何时执行的方法
     * */
    public Object aroundPrintLog(ProceedingJoinPoint pjp) {
        Object rtValue = null;
        try {
            Object[] args = pjp.getArgs();   //得到方法执行所需的参数

            System.out.println("Logger类中aroundPrintLog方法开始记录日志了 前置");

            rtValue = pjp.proceed(args);     //明确调用业务层方法(切入点方法)

            System.out.println("Logger类中aroundPrintLog方法开始记录日志了 后置");

            return rtValue;
        } catch (Throwable throwable) {
            System.out.println("Logger类中aroundPrintLog方法开始记录日志了 异常");
            throw new RuntimeException(throwable);
        }finally {
            System.out.println("Logger类中aroundPrintLog方法开始记录日志了 最终");
        }

    }

---

基于注解的AOP

• 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"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/aop
        https://www.springframework.org/schema/aop/spring-aop.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd">

    <!--配置spring创建容器时要扫描的包-->
    <context:component-scan base-package="com.oym"></context:component-scan>

    <!--配置spring开启注解AOP的支持-->
    <aop:aspectj-autoproxy></aop:aspectj-autoproxy>
</beans>

• 在类中标签的使用

@Component("logger")
@Aspect     //表示当前类是切面类
public class Logger {

    @Pointcut("execution(* com.oym.service.impl.*.*(..))")
    private void pt1() {
    }

    /*
    * 前置通知*/
    //@Before("pt1()")
    public void beforePrintLog() {
        System.out.println("前置通知:Logger类中beforePrintLog方法开始记录日志了");
    }

    /*
     * 后置通知*/
    //@AfterReturning("pt1()")
    public void afterReturnPrintLog() {
        System.out.println("后置通知:Logger类中afterReturnPrintLog方法开始记录日志了");
    }

    /*
     * 异常通知*/
    //@AfterThrowing("pt1()")
    public void afterThrowingLog() {
        System.out.println("异常通知:Logger类中afterThrowingLog方法开始记录日志了");
    }

    /*
     * 最终通知*/
   // @After("pt1()")
    public void afterPrintLog() {
        System.out.println("最终通知:Logger类中afterPrintLog方法开始记录日志了");
    }

    /*
     * 环绕通知
     * 问题：
     *      当我们配置了环绕通知之后，切入点方法没有执行，而通知方法执行了
     * 分析：
     *      通过对比动态代理中的环绕通知代码，发现动态代理的环绕通知有明确的切入点方法调用，而我们代码没有。
     * 解决：
     *      Spring框架为我们提供了一个接口：ProceedingJoinPoint 该接口有一个方法proceed()，此方法就相当于明确调用切入点方法
     *      该接口可以作为环绕通知的方法参数，在程序执行时，spring框架会为我们提供该接口的实现类供我们使用。
     * spring中的环绕通知：
     *      它是spring框架为我们提供的一种可以在代码中手动控制增强方法何时执行的方法
     * */
    @Around("pt1()")
    public Object aroundPrintLog(ProceedingJoinPoint pjp) {
        Object rtValue = null;
        try {
            Object[] args = pjp.getArgs();   //得到方法执行所需的参数

            System.out.println("Logger类中aroundPrintLog方法开始记录日志了 前置");

            rtValue = pjp.proceed(args);     //明确调用业务层方法(切入点方法)

            System.out.println("Logger类中aroundPrintLog方法开始记录日志了 后置");

            return rtValue;
        } catch (Throwable throwable) {
            System.out.println("Logger类中aroundPrintLog方法开始记录日志了 异常");
            throw new RuntimeException(throwable);
        }finally {
            System.out.println("Logger类中aroundPrintLog方法开始记录日志了 最终");
        }

    }
}

---

• 总结：基于注解的AOP配置，最好使用环绕通知类型，避免顺序出错。