Spring5（五）——AOP

一、AOP

1、介绍

　　AOP（Aspect Oriented Programming），面向切面编程。它利用一种称为"横切"的技术，剖解开封装的对象内部，并将那些影响了多个类的公共行为封装到一个可重用模块，并将其命名为"Aspect"，即切面。所谓"切面"，简单说就是那些与业务无关，却为业务模块所共同调用的逻辑或责任封装起来，便于减少系统的重复代码，降低模块之间的耦合度，并有利于未来的可操作性和可维护性。
　　AOP是对所有对象或者是一类对象编程，核心是在不增加代码的基础上，还增加新功能。实际上在开发框架本身用的多，在实际项目中，用的不多。

　　切面（aspect）：要实现的交叉功能，是系统模块化的一个切面或领域。如日志记录。
　　连接点：应用程序执行过程中插入切面的地点，可以是方法调用，异常抛出，或者要修改的字段。
　　通知（增强）：切面的实际实现，他通知系统新的行为。如在日志通知包含了实现日志功能的代码，如向日志文件写日志。通知在连接点插入到应用系统中。
　　切入点：定义了通知应该应用在哪些连接点，通知可以应用到AOP框架支持的任何连接点。连接点（静态）-->切入点（动态）。
　　引入：为类添加新方法和属性。
　　目标对象：被通知的对象（被代理的对象）。既可以是你编写的类也可以是第三方类。
　　代理对象：将通知应用到目标对象后创建的对象，应用系统的其他部分不用为了支持代理对象而改变。
　　织入：将切面应用到目标对象从而创建一个新代理对象的过程。织入发生在目标对象生命周期的多个点上：
　　①编译期：切面在目标对象编译时织入，这需要一个特殊的编译器。
　　②类装载期：切面在目标对象被载入JVM时织入，这需要一个特殊的类载入器。
　　③运行期：切面在应用系统运行时织入。

　　原理：AOP的核心思想为设计模式的动态代理模式。

2、案例

　　注意：接下来介绍的案例，更像是AOP的静态代理实现，个人理解。
　　定义目标对象（被代理的对象）

// 定义一个接口
public interface ITeacher {
    void teach();
    int add(int i, int j);
}

// 定义目标对象
public class Teacher implements ITeacher {
     @Override
    public void teach() {
        System.out.println("老师正在上课");
    }

    @Override
    public int add(int i, int j) {
        int add = i + j;
        System.out.println("执行目标方法:老师正在做加法,结果为:" + add);
        // int throwable = 10 / 0; 测试异常通知
        return add;
    }
    
    // 目标对象自己的方法,此方法不是接口所以无法代理
    public void sayHello() {
        System.out.println("老师会说hello");
    }

}

　　编写一个通知（前置通知）

// 前置通知
public class MyMethodBeforeAdvice implements MethodBeforeAdvice {

    // method:被 代理对象 调用的方法(目标方法)
    // objects:被 代理对象 调用的方法入参(参数)
    // target:目标对象
    @Override
    public void before(Method method, Object[] objects, Object target) throws Throwable {
        System.out.println("前置通知=====1======函数名:" + method.getName());
       System.out.println("前置通知=====2======参数值:" + JSON.toJSONString(objects));
       System.out.println("前置通知=====3======对象值:" + JSON.toJSONString(target));
    }

}

　　配置 application.xml

<!-- 配置目标对象 -->
<bean id="teacher" class="com.lx.spring.day1.Teacher"/>

<!-- 配置前置通知 -->
<bean id="myMethodBeforeAdvice" class="com.lx.spring.day1.MyMethodBeforeAdvice"/>

<!-- 配置代理对象 -->
<bean id="proxyFactoryBean" class="org.springframework.aop.framework.ProxyFactoryBean">
    <!-- 1.指定要代理的目标对象 -->
    <property name="target" ref="teacher"/>

    <!-- 2.指定要代理的接口集 -->
    <property name="proxyInterfaces">
        <list>
            <value>com.lx.spring.day1.ITeacher</value>
        </list>
    </property>

    <!-- 3.指定要织入的通知 -->
    <property name="interceptorNames">
        <list>
            <value>myMethodBeforeAdvice</value>
        </list>
    </property>
</bean>

// 测试类
public class Main {
    public static void main(String[] args) {
        ApplicationContext app = new ClassPathXmlApplicationContext("app1.xml");
        // 获取代理对象
        ITeacher iTeacher = (ITeacher) app.getBean("proxyFactoryBean");
        // 通过代理对象执行目标对象的方法
        int add = iTeacher.add(1, 2);
    }
}

// 前置通知=====1======函数名:add
// 前置通知=====2======参数值:[1,2]
// 前置通知=====3======对象值:{}
// 执行目标方法:老师正在做加法,结果为:3

　　原理剖析：案例中，重点在于理解ProxyFactoryBean这个Bean到底做了什么？有一个前置通知，在目标方法前调用（从打印结果也能看出）。
　　那么，用静态代理模式不难理解，简单理解上面的实现如下，详细的请查看源码。

// 代理对象,静态代理
public class ProxyFactoryBean implements ITeacher { // 2.指定要代理的接口集,即要实现哪些接口
     // 目标对象,通过接口来聚合
     private Teacher target;
     // 前置通知
     private MethodBeforeAdvice methodBeforeAdvice;

     // 3.指定要织入的通知,即在执行目标对象方法要执行什么代码
     public void setMethodBeforeAdvice(MethodBeforeAdvice methodBeforeAdvice) {
        this.methodBeforeAdvice = methodBeforeAdvice;
    }

    public ProxyFactoryBean(Teacher teacher) { // 1.指定要代理的目标对象
        this.target = teacher;
    }

    @Override
    public void teach() {

    }

    // 代理方法的编写
    @Override
    public int add(int i, int j) {
        try {
            // 1.如果设置了前置通知,执行前置通知
            if (methodBeforeAdvice != null) {
                Method method = ITeacher.class.getMethod("add", int.class, int.class);
                List<Object> objectList = new ArrayList<>();
                objectList.add(i);
                objectList.add(j);
                Object[] objects = objectList.toArray();

                methodBeforeAdvice.before(method, objects, target);
            }

            // 2.执行目标方法
            return target.add(i, j);

            // 3.如果设置了后置通知,执行后置通知
        } catch (Throwable e) {
            e.printStackTrace();
        }
        return 0;
    }
}

// 测试类
public class Main {
    public static void main(String[] args) {
        // 创建代理对象,同时将创建的目标对象作为参数传递,即为谁代理.
        ProxyFactoryBean proxyFactoryBean = new ProxyFactoryBean(new Teacher());
        // 设置一个前置通知
        proxyFactoryBean.setMethodBeforeAdvice(new MyMethodBeforeAdvice());
        // 通过代理对象执行目标对象的方法.
        proxyFactoryBean.add(1, 4);
    }
}

// 前置通知=====1======函数名:add
// 前置通知=====2======参数值:[1,3]
// 前置通知=====3======对象值:{}
// 执行目标方法:老师正在做加法,结果为:4

3、通知类别

　　除了案例中使用的前置通知，Spring中还提供了如下几种通知：

通知类型	接口	描述
前置通知	org.springframework.aop.MethodBeforeAdvice	在目标方法前调用
后置通知	org.springframework.aop.AfterReturningAdvice	在目标方法后调用
环绕通知	org.aopalliance.intercept.MethodInterceptor	拦截对目标方法调用
异常通知	org.springframework.aop.ThrowsAdvice	目标方法抛出异常时调用
引入通知	org.springframework.aop.support.NameMatchMethodPointcutAdvisor	可以指定切入点

　　前置通知：接口提供了获得目标方法，参数和目标对象的机会。该接口唯一能阻止目标方法被调用的途径是抛出异常或(System.exit())。
　　后置通知：同前置通知类似。
　　环绕通知：该通知能够控制目标方法是否真的被调用。通过invocation.proceed()方法来调用。该通知可以控制返回的对象。可以返回一个与proceed()方法返回对象完全不同的对象。但要谨慎使用。特别注意：配置通知时，指定要织入的通知，环绕顺序不同，会影响执行顺序。
　　异常通知：该接口为标识性（tag）接口，没有任何方法，但实现该接口的类必须要有如下形式的方法：

　　void afterThrowing(Throwable throwable);
　　void afterThrowing(Method m,Object[] os,Object target,Exception e);
　　第一个方法只接受一个参数：需要抛出的异常。
　　第二个方法接受异常、被调用的方法、参数以及目标对象

　　引入通知：以前定义的通知类型是在目标对象的方法被调用的周围织入。引入通知给目标对象添加新的方法和属性。

　　几种通知：

// 前置通知(上面已介绍过)
public class MyMethodBeforeAdvice implements MethodBeforeAdvice {
    // 目标方法、参数、目标对象
    @Override
    public void before(Method method, Object[] objects, Object target) throws Throwable {
        System.out.println("前置通知=====1======函数名:" + method.getName());
        System.out.println("前置通知=====2======参数值:" + JSON.toJSONString(objects));
        System.out.println("前置通知=====3======对象值:" + JSON.toJSONString(target));
    }
}

// 后置通知
public class MyAfterReturningAdvice implements AfterReturningAdvice {
    // object:方法的返回值
    // method:目标方法
    // objects:参数
    // target:目标对象.注:该对象由前置通知传入的 target
    @Override
    public void afterReturning(Object object, Method method, Object[] objects, Object target) throws Throwable {
        System.out.println("后置通知=====0======返回值:" + object);
        System.out.println("后置通知=====1======函数名:" + method.getName());
        System.out.println("后置通知=====2======参数值:" + JSON.toJSONString(objects));
        System.out.println("后置通知=====3======对象值:" + JSON.toJSONString(target));
    }
}

// 环绕通知
public class MyMethodInterceptor implements MethodInterceptor {
    // object:目标方法的返回值
    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        System.out.println("============环绕前==============");
        Object object = invocation.proceed(); // 这里会切入目标方法
        System.out.println("============环绕后==============");
        return object;
    }
}

// 异常通知
public class MyThrowsAdvice implements ThrowsAdvice {

    public void afterThrowing(Method method, Object[] objects, Object target, Exception e) {
        System.out.println("异常通知=====1======函数名:" + method.getName());
        System.out.println("异常通知=====2======参数值:" + JSON.toJSONString(objects));
        System.out.println("异常通知=====3======对象值:" + JSON.toJSONString(target));
        System.out.println("异常通知=====4======异常值:" + JSON.toJSONString(e.getMessage()));
    }
}

　　经过上面案例及四种通知的说明，可以看到，ProxyFactoryBean是一个在BeanFactory中显式创建代理对象的中心类，可以给它一个要代理的目标对象、一个要代理的接口集、一个要织入的通知，他将创建一个崭新的代理对象。

　　引入通知（切点）：前四种通知已经指明了在目标方法前，还是后，还是环绕调用。如果不能表达在什么地方应用通知的话，通知将毫无用处，这就是切入点的用处。
　　切入点决定了一个特定的类的特定方法是否满足一定的规则。若符合，通知就应用到该方法上。引入通知可以指定切入点（即指定在哪些方法上织入通知）。
　　注：引入通知并不像前4个介绍的那样是一个通知。而重点思想在于：①在哪里（切点，或者说方法）引入？②引入一个什么样的通知？
　　规则如下：

符号	描述	示例	匹配	不匹配
.	匹配任何单个字符	setFoo.	setFooB	setFooBar setFooB
+	匹配前一个字符一次或多次	setFoo.+	setFooBar setFooB	setFoo
*	匹配前一个字符0次或多次	setFoo.*	setFoosetFooB, setFooBar
\	匹配任何正则表达式符号	\.setFoo.	bar.setFoo	setFoo

　　下面给出一份完整的配置文件 application.xml

<!-- 配置目标对象 -->
<bean id="teacher" class="com.lx.test.Teacher"/>

<!-- 配置前置通知 -->
<bean id="myMethodBeforeAdvice" class="com.lx.advice.MyMethodBeforeAdvice"/>
<!-- 配置后置通知 -->
<bean id="myAfterReturningAdvice" class="com.lx.advice.MyAfterReturningAdvice"/>
<!-- 配置环绕通知 -->
<bean id="myMethodInterceptor" class="com.lx.advice.MyMethodInterceptor"/>
<!-- 配置异常通知 -->
<bean id="myThrowsAdvice" class="com.lx.advice.MyThrowsAdvice"/>

<!-- 配置引入通知 -->
<bean id="pointcutAdvisor" class="org.springframework.aop.support.NameMatchMethodPointcutAdvisor">
    <property name="advice" ref="myMethodBeforeAdvice"/>
    <property name="mappedNames">
        <list>
            <value>add*</value> <!-- 对以add开头的函数织入前置通知 -->
            <value>del*</value>
            <value>teach*</value>
        </list>
    </property>
</bean>

<!-- 配置代理对象 -->
<bean id="proxyFactoryBean" class="org.springframework.aop.framework.ProxyFactoryBean">
    <!-- 指定要代理的目标对象 -->
    <property name="target" ref="teacher"/>

    <!-- 指定要代理的接口集 -->
    <property name="proxyInterfaces">
        <list>
            <value>com.lx.test.ITeacher</value>
        </list>
    </property>

    <!-- 指定要织入的通知 -->
    <property name="interceptorNames">
        <list>
            <value>myMethodBeforeAdvice</value>
            <value>myAfterReturningAdvice</value>
            <value>myMethodInterceptor</value>
            <value>myThrowsAdvice</value>

            <value>pointcutAdvisor</value>
        </list>
    </property>
</bean>

// 测试类
public class Main {
    public static void main(String[] args) {
        ApplicationContext app = new ClassPathXmlApplicationContext("beans.xml");
        ITeacher iTeacher = (ITeacher) app.getBean("proxyFactoryBean");
        int add = iTeacher.add(11, 22);
    }
}

// 前置通知=====1======函数名:add
// 前置通知=====2======参数值:[11,22]
// 前置通知=====3======对象值:{}
// ============环绕前==============
// 前置通知=====1======函数名:add
// 前置通知=====2======参数值:[11,22]
// 前置通知=====3======对象值:{}
// 执行目标方法:老师正在做加法,结果为:33
// ============环绕后==============
// 后置通知=====0======返回值:33
// 后置通知=====1======函数名:add
// 后置通知=====2======参数值:[11,22]
// 后置通知=====3======对象值:{}

// row14、15、16是由于配置了引入通知又执行了一次前置通知

4、小结

　　Spring在运行时通知对象，在运行期创建代理，不需要特殊的编译器。Spring有两种代理方式：
　　若目标对象实现了若干接口：Spring使用JDK的java.lang.reflect.Proxy类代理。该类让Spring动态产生一个新类，它实现了所需的接口，织入了通知和代理对目标对象的所有请求。
　　若目标对象没有实现任何接口：Spring使用CGLIB库生成目标对象的子类。使用该方式时需要注意：
　　①对接口创建代理优于对类创建代理，因为会产生更加松耦合的系统。对类代理是让遗留系统或无法实现接口的第三方类库同样可以得到通知，这种方式应该是备用方案。
　　②标记为final的方法不能够被通知。Spring是为目标类产生子类，任何需要被通知的方法都需要被复写，将通知织入。final方法是不允许重写的。
　　Spring实现了aop联盟接口。Spring只支持方法连接点，不提供属性接入点。Spring的观点是属性拦截破坏了封装。面向对象的概念是对象自己处理工作，其他对象只能通过方法调用的得到的结果。
　　问：说Spring的aop中，当你通过代理对象去实现aop的时候，获取的ProxyFactoryBean是什么类型？
　　答：返回的是一个代理对象，如果目标对象实现了接口，则Spring使用jdk动态代理技术；如果目标对象没有实现接口，则Spring使用CGLIB技术。