Spring之aop

一、AOP中关键性概念 

连接点(Joinpoint)：程序执行过程中明确的点，如方法的调用，或者异常的抛出.

目标(Target)：被通知(被代理)的对象

通知(Advice)：在某个特定的连接点上执行的动作，同时Advice也是程序代码的具体实现，例如一个实现日志记录的代码(通知有些书上也称为处理)

代理(Proxy)：将通知（公共部分的代码，日志记录）应用到目标（具体的业务逻辑方法）对象后创建的对象(代理=目标+通知),
             例子：外科医生+护士

切入点(Pointcut)：多个连接点的集合，定义了通知应该应用到那些连接点。
                 (也将Pointcut理解成一个条件 ，此条件决定了容器在什么情况下将通知和目标组合成代理返回给外部程序)
    
适配器(Advisor)：适配器=通知(Advice)+切入点(Pointcut)

如何实现AOP？
目标对象只负责业务逻辑代码
通知对象负责AOP代码，这二个对象都没有AOP的功能，只有代理对象才有

1. AOP
   即面向切面编程
2. AOP带来的好处
   让我们可以 “专心做事”
   通知+目标=代理对象，只有完整的代理对象才具备AOP的特性

   如果只有目标，则只会去做核心业务逻辑处理，不会收集日志；
   如果只有通知，则只会去做日志记录，不会执行核心业务逻辑；
   通知应用到目标上才能得到代理对象（通知+目标=代理）
   只有完整的代理对象才具备AOP的特性，而AOP的公共代码（日志收集）是写在通知中的！！

    例子：病人做手术 

     外科医生+护士

    主刀医生：理解为AOP中的目标，专注具体的业务逻辑操作
    麻醉师和护士：理解为AOP中的通知，在某种特定的连接点上执行的动作
    上述结合：AOP 代理对象：将通知应用到具体目标对象后创建对象
    代理=目标+通知
    只有代理对象才有AOP功能。

3. 工具类org.springframework.aop.framework.ProxyFactoryBean用来创建一个代理对象,在一般情况下它需要注入以下三个属性：
  proxyInterfaces：代理应该实现的接口列表(List)
  interceptorNames：需要应用到目标对象上的通知Bean的名字。(List)
  target：目标对象 (Object)
  

4. 前置通知(org.springframework.aop.MethodBeforeAdvice)：在连接点之前执行的通知()
   案例：在购书系统当中使用AOP方式实现日志系统

package com.zking.spring02.advice;

import org.springframework.aop.MethodBeforeAdvice;

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

public class BeforeAdvice implements MethodBeforeAdvice {
    /**
     * 前置通知，用于目标方法被调用之前进行日志收集
     * @param method 目标方法
     * @param objects 目标方法所执行的参数
     * @param o 目标对象
     * @throws Throwable
     */
    @Override
    public void before(Method method, Object[] objects, Object o) throws Throwable {
        //获取被调用的方法名
        String methodName=method.getName();
        //获取目标方法的类的全路径名
        String className=o.getClass().getName();
        System.out.println("[前置通知]"+className+"."+methodName+"执行参数："+ Arrays.toString(objects));


    }
}

5. 后置通知(org.springframework.aop.AfterReturningAdvice)：在连接点正常完成后执行的通知
   案例：在线购书系统中，要求不修改BookBizImpl代码的情况下增加如下功能：对买书的用户进行返利：每买本书返利3元。(后置通知)
        即：每调用一次buy方法打印：“[销售返利][时间]返利3元。”

package com.zking.spring02.advice;

import org.springframework.aop.AfterReturningAdvice;

import java.lang.reflect.Method;

/**
 * 后置通知
 */
public class AfterAdvice implements AfterReturningAdvice {
    /**
     *
     * @param o 目标方法的返回值
     * @param method 目标方法
     * @param objects 目标方法发执行参数
     * @param o1 目标对象
     * @throws Throwable
     */
    @Override
    public void afterReturning(Object o, Method method,
                               Object[] objects, Object o1) throws Throwable {
        /* //获取目标方法名
        String methodName=method.getName();
        //获取目标方法类的路径名
        String className = target.getClass().getName();
        System.out.println("[后置通知]"+className+"."+methodName+"执行参数"+ Arrays.toString(args)+"返回值"+returnValue);*/
        System.out.println("【适配器】买书返利2元！");
    }
}

6. 环绕通知(org.aopalliance.intercept.MethodInterceptor)：包围一个连接点的通知，最大特点是可以修改返回值，由于它在方法前后都加入了自己的逻辑代码，因此功能异常强大。
             它通过MethodInvocation.proceed()来调用目标方法（甚至可以不调用，这样目标方法就不会执行）
   案例：修改日志系统不光要输出参数，还要输出返回值(环绕通知)
   

package com.zking.spring02.advice;

import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
import org.springframework.cglib.proxy.MethodProxy;

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

/**
 * 环绕通知
 */
public class AroundAdvice implements MethodInterceptor {

    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        //获取目标对象
        Object target = invocation.getThis();
        //获取目标方法
        Method method = invocation.getMethod();
        //获取目标方法的执行参数
        Object[] arguments = invocation.getArguments();

        System.out.println("[环绕通知]"+target.getClass().getName()+"."+
                method.getName()+"执行参数："+ Arrays.toString(arguments));
        //执行目标方法
        Object returnValue=invocation.proceed();
        System.out.println("[环绕通知]"+target.getClass().getName()+"."+
                method.getName()+"执行参数："+ Arrays.toString(arguments)+"返回值："+returnValue);
        return returnValue;
    }
}

7. 异常通知(org.springframework.aop.ThrowsAdvice)：这个通知会在方法抛出异常退出时执行
   案例： 书本价格为负数时抛出一个异常，通过异常通知取消此订单

package com.zking.spring02.advice;

import org.springframework.aop.ThrowsAdvice;

public class ExceptionAdvice implements ThrowsAdvice {

    public void afterThrowing(PriceException ex){
        System.out.println("[异常通知] 买书价格异常，购买失败！");
    }
}

8. 适配器(org.springframework.aop.support.RegexpMethodPointcutAdvisor) 适配器=通知(Advice)+切入点(Pointcut)
   案例：通过适配器解决发书评时也返利的问题
   .*buy
   
9. 请使用接口接收返回的代理对象

以上例子我将统一代码放在下面，首先是定义豆子的spring.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"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    <!--定义目标-->
    <bean id="bookBizTarget" class="com.zking.spring02.biz.BookBizImpl">
    </bean>

    <!--定义通知-->
    <!--前置通知-->
    <bean id="beforeAdvice" class="com.zking.spring02.advice.BeforeAdvice">
    </bean>
    <!-- 后置通知-->
    <bean id="afterAdvice" class="com.zking.spring02.advice.AfterAdvice">
    </bean>
    <!--环绕通知-->
    <bean id="aroundAdvice" class="com.zking.spring02.advice.AroundAdvice">
    </bean>
    <!--异常通知-->
    <bean id="exceptionAdvice" class="com.zking.spring02.advice.ExceptionAdvice">
    </bean>
    <!--适配器-->
    <bean id="regexpMethod" class="org.springframework.aop.support.RegexpMethodPointcutAdvisor">
        <!--通知-->
        <property name="advice">
            <ref bean="afterAdvice"/>
        </property>
        <!--切入点-->
        <!--<property name="pattern">
            <value>.*buy</value>
        </property>-->
        <property name="patterns">
            <list>
                <value>.*buy</value>
            </list>
        </property>
    </bean>
    <!--代理=通知+目标，只有代理对象才具备完整的Aop特性，向Aop代码是写通知中-->
    <bean id="proxy" class="org.springframework.aop.framework.ProxyFactoryBean">
        <!--通知-->
        <property name="interceptorNames">
            <list>
                <!-- <value>beforeAdvice</value>
                 <value>afterAdvice</value>
                 <value>aroundAdvice</value>
                 <value>exceptionAdvice</value>-->
                <value>regexpMethod</value>
            </list>
        </property>
        <!--目标-->
        <property name="target">
            <ref bean="bookBizTarget"></ref>
        </property>

        <!--定义代理对象实现接口-->
        <property name="proxyInterfaces">
            <list>
                <value>com.zking.spring02.biz.IBookBiz</value>
            </list>
        </property>
    </bean>
</beans>

其次是demo.java实现效果输出

package com.zking.spring02.util;

import com.zking.spring02.biz.BookBizImpl;
import com.zking.spring02.biz.IBookBiz;
import javafx.application.Application;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Demo {
    public static void main(String[] args){
        //AOP的关键性概念
        //1）连接点：程序之间过程中明确的点，如方法的调用，异常的抛出
        //2）目标：被通知被代理的对象（完成具体执行的业务逻辑）
        //3）通知：在某种特定的连接点上所执行的动作
        //4)代理：将通知应用到目标上所创建的对象（代理=通知+目标）
        //注：只有完整的代理对象才具备AOP特性，而AOP代码是写在通知中的（公共的代码，例如：日志）
        //5）切入点：多个连接点的集合，将通知应用到哪些连接点
        //6）适配器：通知+切入点（相当于必须满足切入点的条件才会应用通知分部）


        //1.初始化spring上下文容器（IOC）
        ApplicationContext ac=new ClassPathXmlApplicationContext("spring.xml");
      //  BookBizImpl book=ac.getBean("bookBizTarget", BookBizImpl.class);
        //book.buy("鸡芳","从你的全世界路过",39.9d);
        //book.comment("张传","好看");
        //获取Spring上下文中的代理对象
        //错误方式：
        //BookBizImpl proxy= ac.getBean("proxy",BookBizImpl.class);
        //正确方式：用接口接收代理对象，满足里氏替换原则
        IBookBiz proxy=ac.getBean("proxy", IBookBiz.class);
        System.out.println(proxy.getClass());
        //调用buy和comment方法时，会将前置通知应用到目标方法上得到代理对象
        proxy.buy("张传","小幸运",19.9d);
        proxy.comment("钟羽","好看，感人");
        //of type 'com.zking.spring02.biz.BookBizImpl'
        // but was actually of type 'com.sun.proxy.$Proxy4'

        //A
        //B  C
        //A=IBookBiz
        //B=BookBizImpl  C=Proxy
        //BookBizImp obj=(BookBizImpl)proxy;

        //里氏替换原则？？
        //必须要使用接口接收代理对象
        //IBookBiz bookBiz=new BookBizImpl();
        //IBookBiz bookBiz=(IBookBiz)Proxy;

        //BookBizImpl 实现了IBookBiz
        //proxy     实现了IBookBiz
        //BookBizImpl obj=（BookBizImpl）proxy

    }

}

以及下载jar包的pom.xml

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.zking</groupId>
  <artifactId>spring02</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>spring02 Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <!--junit-->
    <junit.version>4.13</junit.version>
    <!-- spring-->
    <spring.version>5.0.1.RELEASE</spring.version>
  </properties>

  <dependencies>
    <!-- junit-->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>${junit.version}</version>
      <scope>test</scope>
    </dependency>
    <!-- spring-->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>${spring.version}</version>
    </dependency>

    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>${spring.version}</version>
    </dependency>
  </dependencies>

  <build>
    <finalName>spring02</finalName>
    <plugins>
      <!--第一步就是配置maven-compiler-plugin插件-->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.7.0</version>
        <configuration>
          <source>${maven.compiler.source}</source>
          <target>${maven.compiler.target}</target>
          <encoding>${project.build.sourceEncoding}</encoding>
        </configuration>
      </plugin>

    </plugins>
  </build>
</project>

另外需要两个biz包中的java文件

package com.zking.spring02.biz;

public interface IBookBiz {
	// 购书
	public boolean buy(String userName, String bookName, Double price);

	// 发表书评
	public void comment(String userName, String comments);
}

package com.zking.spring02.biz;

public class BookBizImpl implements IBookBiz {

	public BookBizImpl() {
		super();
	}

	public boolean buy(String userName, String bookName, Double price) {
		// 通过控制台的输出方式模拟购书
		/*if (null == price || price <= 0) {
			throw new PriceException("book price exception");
		}*/
		System.out.println(userName + " buy " + bookName + ", spend " + price);
		return true;
	}

	public void comment(String userName, String comments) {
		// 通过控制台的输出方式模拟发表书评
		System.out.println(userName + " say:" + comments);
	}

}

本课内容重在理解理论知识，理解了示例是非常简单的