【Spring入门系列】代理模式和AOP

代理模式概述

代理是一种设计模式，提供了对目标对象另外的访问方式，通过代理对象访问目标对象。这样可以在目标对象功能实现的基础上，增加额外的功能，从而达到扩展目标对象功能的效果。简言之，代理模式就是设置一个中间代理来控制访问原目标对象，以达到增强原对象的功能和简化访问方式。

静态代理

这种代理方式需要代理对象和目标对象实现一样的接口。

优点：可以在不修改目标对象的前提下扩展目标对象的功能。

缺点：1、冗余，由于代理对象要实现与目标对象一致的接口，会产生过多的代理类。2、不易维护，一旦接口增加方法，目标对象与代理对象都要进行修改。

/**
 * 接口类
 */
public interface IUserService {

    void save();

    void update();

}

/**
 * 目标对象类
 */
public class Userservlce implements IUserService {

    @Override
    public void save() {
        System.out.println("保存数据成功");
    }

    @Override
    public void update() {
        System.out.println("更新数据成功");
    }

/**

 * 代理对象类
 */
public class UserServiceProxy implements IUserService {

    private IUserService target;

    public UserServiceProxy(IUserService target){
        this.target = target;
    }

    @Override
    public void save() {
        System.out.println("开启事务");
        target.save();
        System.out.println("提交事务");
    }

    @Override
    public void update() {
        System.out.println("开启事务");
        target.update();
        System.out.println("提交事务");
    }
    
/**

 * 测试类
 */
public class TestProxy {

    @Test
    public void testStaticProxy(){
        IUserService target = new Userservlce();
        IUserService proxy = new UserServiceProxy(target);
        proxy.save();
　　　　 proxy.update();
　　} 
}

动态代理

动态地在内存中构建代理对象，从而实现对目标对象的代理功能,动态代理又被称为JDK代理或接口代理。

动态代理对象不需要实现接口，但是要求目标对象必须实现接口，否则不能使用动态代理。

静态代理与动态代理的主要区别：

静态代理在编译时就已经实现，编译完成后代理类是一个实际的class文件。

动态代理是在运行时动态生成的，即编译完成后没有实际的class文件，而是在运行时动态生成类字节码，并加载到JVM中。

Proxy这个类的作用就是用来动态创建一个代理对象的类，它提供了许多的方法，但是用的最多的就是 newProxyInstance 这个方法。

public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler handle) throws IllegalArgumentException

这个方法的作用就是得到一个动态的代理对象，其接收三个参数，loader：一个ClassLoader对象，定义了由哪个ClassLoader来对生成的代理对象进行加载；interfaces:一个Interface对象的数组，表示的是我将要给我需要代理的对象提供一组什么接口，如果我提供了一组接口给它，那么这个代理对象就宣称实现了该接口(多态)，这样我就能调用这组接口中的方法了；handle:一个InvocationHandler对象，表示当我这个动态代理对象在调用方法的时候，会关联到哪一个InvocationHandler对象上。

其实我们所说的动态代理类是这样一种class：它是在运行时生成的class，在生成它时你必须提供一组interface给它，然后该class就宣称它实现了这些interface。这样一来，我们可以把该class的实例当作这些interface中的任何一个来用（可以强转为相应的接口类型）。当然，这个动态代理类其实就是一个Proxy，它不会做实质性的工作，在生成它的实例时你必须提供一个handler，由它接管实际的工作。

 1 public class ProxyFactory {
 2 
 3     private Object target;
 4 
 5     public ProxyFactory(Object target){
 6         this.target = target;
 7     }
 8 
 9     public Object getProxyInstance(){
10 
11         return Proxy.newProxyInstance(
12                 target.getClass().getClassLoader(),
13                 target.getClass().getInterfaces(),
14                 new InvocationHandler() {
15                     @Override
16                     public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
17                         System.out.println("开启事务");
18 
19                         // 执行目标对象方法
20                         Object returnValue = method.invoke(target, args);
21 
22                         System.out.println("提交事务");
23                         return returnValue;
24                     }
25                 });
26     }
27 }

 1 /**
 2  * 测试类
 3  */
 4 public class TestProxy {
 5 
 6     @Test
 7     public void testDynamicProxy (){
 8         IUserService target = new Userservlce();
 9         // 输出目标对象信息
10         System.out.println(target.getClass());
11         // 获取代理对象实例
12         IUserService proxy = (IUserService) new ProxyFactory(target).getProxyInstance();
13         // 输出代理对象信息
14         System.out.println(proxy.getClass());
15         // 调用代理对象方法，触发事件处理器
16         proxy.save();
17         proxy.update();
18     }
19 }

AOP关键术语

1.target：目标类，需要被代理的类。

2.Joinpoint(连接点):所谓连接点是指那些可能被拦截到的方法。

3.PointCut 切入点：已经被增强的连接点。

4.advice 通知/增强，增强代码。例如：after、before

5.Weaving(织入):是指把增强advice应用到目标对象target来创建新的代理对象proxy的过程。

6.Aspect(切面): 是切入点pointcut和通知advice的结合

AOP通知类型

Spring按照通知Advice在目标类方法的连接点位置，分为5类

1、前置通知 org.springframework.aop.MethodBeforeAdvice

在目标方法执行前实施增强，比如上面例子的 before()方法

2、后置通知 org.springframework.aop.AfterReturningAdvice

在目标方法执行后实施增强，比如上面例子的 after()方法

3、环绕通知 org.aopalliance.intercept.MethodInterceptor

在目标方法执行前后实施增强

4、异常抛出通知 org.springframework.aop.ThrowsAdvice

在方法抛出异常后实施增强

5、引介通知 org.springframework.aop.IntroductionInterceptor

在目标类中添加一些新的方法和属性

注解方式实现AOP

第一步引入aop相关jar包

第二步引入名称空间，开启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: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-4.3.xsd
            http://www.springframework.org/schema/aop
            http://www.springframework.org/schema/aop/spring-aop.xsd">


    <!-- 组件扫描，扫描含有注解的类 -->
    <context:component-scan base-package="com.ysdrzp.aop"></context:component-scan>

    <!-- 开启AOP注解扫描 -->
    <aop:aspectj-autoproxy></aop:aspectj-autoproxy>

/**
 * 接口
 */
public interface IUserDao {

    void save();
}

/**
 * 目标对象
 */
@Component
public class UserDao implements IUserDao {

    @Override
    public void save() {
        System.out.println("核心业务-保存数据");
    }
}

@Component
public class OrderDao {

    public void save() {
        System.out.println("保存");
    }
}

/**
 * 切面类
 */
@Component
@Aspect
public class Aop {

    // 指定切入点表单式：拦截哪些方法；即为哪些类生成代理对象
    @Pointcut("execution(* com.ysdrzp.aop..*(..))")
    public void pointCut_(){
    }

    // 前置通知: 在执行目标方法之前执行
    @Before("pointCut_()")
    public void begin(){
        System.out.println("开始事务/异常");
    }

    // 后置/最终通知：在执行目标方法之后执行 【无论是否出现异常最终都会执行】
    @After("pointCut_()")
    public void after(){
        System.out.println("提交事务/关闭");
    }

    // 返回后通知：在调用目标方法结束后执行 【出现异常不执行】
    @AfterReturning("pointCut_()")
    public void afterReturning() {
        System.out.println("afterReturning()");
    }

    // 异常通知：当目标方法执行异常时候执行此通知/增强代码
    @AfterThrowing("pointCut_()")
    public void afterThrowing(){
        System.out.println("afterThrowing()");
    }

    // 环绕通知：环绕目标方式执行
    @Around("pointCut_()")
    public void around(ProceedingJoinPoint pjp) throws Throwable{
        System.out.println("环绕前....");
        pjp.proceed();
        System.out.println("环绕后....");
    }

}

/**
 * 测试类
 */
public class App {

    ApplicationContext ac =
            new ClassPathXmlApplicationContext("applicationContext.xml");

    // 目标对象有实现接口，spring会自动选择“JDK代理”
    @Test
    public void testApp() {
        IUserDao userDao = (IUserDao) ac.getBean("userDao");
        System.out.println(userDao.getClass());
        userDao.save();
    }

    // 目标对象没有实现接口， spring会用“cglib代理”
    @Test
    public void testCglib() {
        OrderDao orderDao = (OrderDao) ac.getBean("orderDao");
        System.out.println(orderDao.getClass());
        orderDao.save();
    }

    @Deprecated
    // 共性问题：如果目标对象有实现接口，在从容器中获取目标对象的时候，只能通过接口接收对象。
    public void testApp2() {
        // 错误代码： 只能用接口接收
        UserDao userDao = (UserDao) ac.getBean("userDao");
        System.out.println(userDao.getClass());
        userDao.save();
    }

}

通过aop命名空间的<aop:aspectj-autoproxy />声明自动为spring容器中那些配置@aspectJ切面的bean创建代理，织入切面。当然，spring在内部依旧采用AnnotationAwareAspectJAutoProxyCreator进行自动代理的创建工作，但具体实现的细节已经被<aop:aspectj-autoproxy />隐藏起来了。<aop:aspectj-autoproxy />有一个proxy-target-class属性，默认为false，表示使用jdk动态代理织入增强，当设置为true时，表示使用CGLib动态代理技术织入增强。不过即使proxy-target-class设置为false，如果目标类没有声明接口，则spring将自动使用CGLib动态代理。

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

    <!-- dao 实例 -->
    <bean id="userDao" class="com.ysdrzp.aop_xml.UserDao"></bean>
    <bean id="orderDao" class="com.ysdrzp.aop_xml.OrderDao"></bean>

    <!-- 切面类 -->
    <bean id="aop" class="com.ysdrzp.aop_xml.Aop"></bean>

    <!-- Aop配置 -->
    <aop:config>
        <!-- 定义一个切入点表达式：拦截哪些方法 -->
        <aop:pointcut expression="execution(* com.ysdrzp.aop_xml.*.*(..))" id="pt"/>
        <!-- 切面 -->
        <aop:aspect ref="aop">
            <!-- 环绕通知 -->
            <aop:around method="around" pointcut-ref="pt"/>
            <!-- 前置通知： 在目标方法调用前执行 -->
            <aop:before method="begin" pointcut-ref="pt"/>
            <!-- 后置通知： -->
            <aop:after method="after" pointcut-ref="pt"/>
            <!-- 返回后通知 -->
            <aop:after-returning method="afterReturning" pointcut-ref="pt"/>
            <!-- 异常通知 -->
            <aop:after-throwing method="afterThrowing" pointcut-ref="pt"/>
        </aop:aspect>
    </aop:config>

</beans>

/**
 * 接口
 */
public interface IUserDao {

    void save();
}

/**
 * 目标对象
 */
public class UserDao implements IUserDao {

    @Override
    public void save() {
        System.out.println("核心业务-保存数据");
    }
}

public class OrderDao {

    public void save() {
        System.out.println("保存数据");
    }
}

/**
 * 切面类
 */
public class Aop {

    public void begin(){
        System.out.println("开始事务/异常");
    }

    public void after(){
        System.out.println("提交事务/关闭");
    }

    public void afterReturning() {
        System.out.println("afterReturning()");
    }

    public void afterThrowing(){
        System.out.println("afterThrowing()");
    }

    public void around(ProceedingJoinPoint pjp) throws Throwable{
        System.out.println("环绕前....");
        pjp.proceed();  
        System.out.println("环绕后....");
    }

}

/**
 * 测试类
 */
public class App {

    ApplicationContext ac =
            new ClassPathXmlApplicationContext("bean.xml");

    // 目标对象有实现接口，spring会自动选择“JDK代理”
    @Test
    public void testApp() {
        IUserDao userDao = (IUserDao) ac.getBean("userDao");
        System.out.println(userDao.getClass());
        userDao.save();
    }

    // 目标对象没有实现接口， spring会用“cglib代理”
    @Test
    public void testCglib() {
        OrderDao orderDao = (OrderDao) ac.getBean("orderDao");
        System.out.println(orderDao.getClass());
        orderDao.save();
    }

    @Deprecated
    // 共性问题：如果目标对象有实现接口，在从容器中获取目标对象的时候，只能通过接口接收对象。
    public void testApp2() {
        // 错误代码： 只能用接口接收
        UserDao userDao = (UserDao) ac.getBean("userDao");
        System.out.println(userDao.getClass());
        userDao.save();
    }

}