Spring AOP(代理模式及实践)

约定不等于承诺〃 2022-03-22 13:14 279阅读 0赞

为什么会有面向切面编程（AOP）？我们知道Java是一个面向对象（OOP）的语言，但它有一些弊端，比如当我们需要为多个不具有继承关系的对象引入一个公共行为，例如日志、权限验证、事务等功能时，只能在在每个对象里引用公共行为。这样做不便于维护，而且有大量重复代码。AOP的出现弥补了OOP的这点不足。

为了阐述清楚Spring AOP，我们从将以下方面进

(1).代理模式

(2).静态代理原理及实践

(3).动态代理原理及实践

(4).spring AOP原理及实践

### 1. 代理模式 ###

代理模式：为其他对象提供一种代理以控制对这个对象的访问。这段话比较官方，但我更倾向于用自己的语言理解：比如A对象要做一件事情，在没有代理前，自己来做；在对 A 代理后，由 A 的代理类 B 来做。代理其实是在原实例前后加了一层处理，这也是 AOP 的初级轮廓。

### 2.静态代理原理及实践 ###

静态代理模式：静态代理说白了，就是在程序运行前就已经存在代理类的字节码文件、代理类和原始类的关系在运行前就已经确定。废话不多说，我们看一下代码。为了方便阅读，博主把单独的 class 文件合并到接口中，读者可以直接复制代码运行：

// 接口
    public interface IUserDao {
        void save();
        void find();
    }
     
    //目标对象
    class UserDao implements IUserDao{
        @Override
        public void save() {
            System.out.println("模拟：保存用户！");
        }
        @Override
        public void find() {
            System.out.println("模拟：查询用户");
        }
    }
     
    /**
      * 静态代理
      * 特点：
      * 2. 目标对象必须要实现接口
      * 2. 代理对象，要实现与目标对象一样的接口
     */
    class UserDaoProxy implements IUserDao{
     
        // 代理对象，需要维护一个目标对象
        private IUserDao target = new UserDao();
     
        @Override
        public void save() {
            System.out.println("代理操作： 开启事务...");
            target.save();   // 执行目标对象的方法
            System.out.println("代理操作：提交事务...");
        }
     
        @Override
        public void find() {
            target.find();
        }
    }

测试：

public static void main(String[] args) {
        //代理对象
        IUserDao proxy = new UserDaoProxy();
    
        //执行代理方法
        proxy .save();
    }

测试结果:

代理操作: 开启事务...

模拟: 保存用户!

代理操作: 提交事务...

结论:

静态代理虽然保证了业务类只需关注逻辑本身，代理对象的一个接口只服务于一种类型的对象。如果要代理的方法很多，势必要为每一种方法都进行代理。再者，如果增加一个方法，除了实现类需要实现这个方法外，所有的代理类也要实现此方法。增加了代码的维护成本。那么要如何解决呢？答案是使用动态代理。

### 3.动态代理原理及实践 ###

动态代理模式：动态代理类的源码是在程序运行期间，通过 JVM 反射等机制动态生成。代理类和委托类的关系是运行时才确定的。实例如下：

// 接口
    public interface IUserDao {
        void save();
        void find();
    }
     
    //目标对象
    class UserDao implements IUserDao{
     
        @Override
        public void save() {
            System.out.println("模拟： 保存用户！");
        }
     
        @Override
        public void find() {
            System.out.println("查询");
        }
    }
     
    /**
     * 动态代理：
     * 代理工厂，给多个目标对象生成代理对象！
     *
     */
    class ProxyFactory {
     
        // 接收一个目标对象
        private Object target;
     
        public ProxyFactory(Object target) {
            this.target = target;
        }
     
        // 返回对目标对象(target)代理后的对象(proxy)
        public Object getProxyInstance() {
            Object proxy = Proxy.newProxyInstance(
                target.getClass().getClassLoader(),  // 目标对象使用的类加载器
                target.getClass().getInterfaces(),   // 目标对象实现的所有接口
                new InvocationHandler() {            // 执行代理对象方法时候触发
     
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args)
                            throws Throwable {
     
                        // 获取当前执行的方法的方法名
                        String methodName = method.getName();
                        // 方法返回值
                        Object result = null;
                        if ("find".equals(methodName)) {
                            // 直接调用目标对象方法
                            result = method.invoke(target, args);
                        } else {
                            System.out.println("开启事务...");
                            // 执行目标对象方法
                            result = method.invoke(target, args);
                            System.out.println("提交事务...");
                        }
                        return result;
                    }
                }
            );
            return proxy;
        }
    }

测试:

public static void main(String[] args) {
    	//创建目标对象
    	IUserDao target = new UserDao();
    	//代理对象
    	IUserDao  proxy = (IUserDao) new ProxyFactory(target).getProxyInstance();
    	System.out.println("代理对象:" + proxy.getClass());
    	//执行代理对象的方法
    	proxy.save();
    }

测试结果:

目标对象: class test.dynamicProxy.UserDao  
    代理对象: class com.sun.proxy.$Proxy0  
    开启事务...  
    模拟: 保存用户!  
    提交事务...

IUserDao proxy = (IUserDao)new ProxyFactory(target).getProxyInstance();

其实是 JDK 动态生成了一个类去实现接口，隐藏了这个过程：

class $jdkProxy implements IUserDao{}

**使用 JDK 生成的动态代理的前提是目标类必须有实现的接口**。但这里又引入一个问题，如果某个类没有实现接口，就不能使用 JDK 动态代理。所以 CGLIB 代理就是解决这个问题的。

CGLIB 是以动态生成的子类继承目标的方式实现，在运行期动态的在内存中构建一个子类，如下：

**CGLIB 使用的前提是目标类不能为 final 修饰**。因为 final 修饰的类不能被继承。

现在，我们可以看看 AOP 的定义：面向切面编程，核心原理是**使用动态代理模式在方法执行前后或出现异常时加入相关逻辑**。

通过定义和前面代码我们可以发现3点：

(1) AOP 是基于动态代理模式。

(2) AOP 是方法级别的。

(3) AOP 可以分离业务代码和关注点代码（重复代码），在执行业务代码时，动态的注入关注点代码。切面就是关注点代码形成的类。

### 4.Spring AOP ###

前文提到 JDK 代理和 CGLIB 代理两种动态代理。优秀的 Spring 框架把两种方式在底层都集成了进去，我们无需担心自己去实现动态生成代理。那么，Spring是如何生成代理对象的？

(1) 创建容器对象的时候，根据切入点表达式拦截的类，生成代理对象。

(2) 如果目标对象有实现接口，使用 JDK 代理。如果目标对象没有实现接口，则使用 CGLIB 代理。然后从容器获取代理后的对象，在运行期植入“切面”类的方法。通过查看 Spring 源码，我们在 DefaultAopProxyFactory 类中，找到这样一段话。

package org.springframework.aop.framework;
    
    import java.io.Serializable;
    import java.lang.reflect.Proxy;
    import org.springframework.aop.SpringProxy;
    
    public class DefaultAopProxyFactory implements AopProxyFactory, Serializable {
        public DefaultAopProxyFactory() {
        }
    
        public AopProxy createAopProxy(AdvisedSupport config) throws AopConfigException {
            if(!config.isOptimize() && !config.isProxyTargetClass() && !this.hasNoUserSuppliedProxyInterfaces(config)) {
                return new JdkDynamicAopProxy(config);
            } else {
                Class<?> targetClass = config.getTargetClass();
                if(targetClass == null) {
                    throw new AopConfigException("TargetSource cannot determine target class: Either an interface or a target is required for proxy creation.");
                } else {
                    return (AopProxy)(!targetClass.isInterface() && !Proxy.isProxyClass(targetClass)?new ObjenesisCglibAopProxy(config):new JdkDynamicAopProxy(config));
                }
            }
        }
    
        private boolean hasNoUserSuppliedProxyInterfaces(AdvisedSupport config) {
            Class<?>[] ifcs = config.getProxiedInterfaces();
            return ifcs.length == 0 || ifcs.length == 1 && SpringProxy.class.isAssignableFrom(ifcs[0]);
        }
    }

简单的从字面意思看出：如果有接口，则使用 JDK 代理，反之使用 CGLIB ，这刚好印证了前文所阐述的内容。Spring AOP 综合两种代理方式的使用前提有会如下结论：如果目标类没有实现接口，且 class 为 final 修饰的，则不能进行 Spring AOP 编程！

知道了原理，现在我们将自己手动实现 Spring 的 AOP：

public interface IUserDao {
        void save();
    }
     
    // 用于测试 CGLIB 动态代理
    class OrderDao {
        public void save() {
            //int i =1/0; 用于测试异常通知
            System.out.println("保存订单...");
        }
    }
     
    //用于测试 JDK 动态代理
    class UserDao implements IUserDao {
        public void save() {
            //int i =1/0; 用于测试异常通知
            System.out.println("保存用户...");
        }
    }
     
    //切面类
    class TransactionAop {
     
        public void beginTransaction() {
            System.out.println("[前置通知]  开启事务..");
        }
     
        public void commit() {
            System.out.println("[后置通知] 提交事务..");
        }
     
        public void afterReturing() {
            System.out.println("[返回后通知]");
        }
     
        public void afterThrowing() {
            System.out.println("[异常通知]");
        }
     
        public void arroud(ProceedingJoinPoint pjp) throws Throwable {
            System.out.println("[环绕前：]");
            pjp.proceed(); // 执行目标方法
            System.out.println("[环绕后：]");
        }
    }

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"
        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.xsd
            http://www.springframework.org/schema/aop
            http://www.springframework.org/schema/aop/spring-aop.xsd">
        
        <bean id="userDao" class="test.spring_aop_anno.UserDao"></bean>
    
        
        <bean id="orderDao" class="test.spring_aop_anno.OrderDao"></bean>
    
        
        <bean id="transactionAop" class="test.spring_aop_anno.TransactionAop"></bean>
    
        
        <aop:config>
            
            <aop:pointcut expression="execution(* test.spring_aop_anno.*Dao.*(..))" id="transactionPointcut"/>
            
            <aop:aspect ref="transactionAop">
                
                <aop:around method="arroud" pointcut-ref="transactionPointcut"/>
                
                <aop:before method="beginTransaction" pointcut-ref="transactionPointcut" />
                
                <aop:after method="commit" pointcut-ref="transactionPointcut"/>
                
                <aop:after-returning method="afterReturing" pointcut-ref="transactionPointcut"/>
                
                <aop:after-throwing method="afterThrowing" pointcut-ref="transactionPointcut"/>
            </aop:aspect>
        </aop:config>
    </beans>

切入点表达式不在这里介绍。参考 Spring AOP 切入点表达式

代码的测试如下：

private ApplicationContext ac = new ClassPathXmlApplicationContext("applicationContext.xml", getClass());
    
    @Test
    public void testProxy() throws Ecxeption {
    	//springIOC容器中获取对象,测试spring中jdk中的动态代理方式
    	IUserDao userDao = (IUserDao ) ac.getBean("userDao");
    	System.out.println(userDao.getClass());
    	userDao.save();
    }
    
    @Test
    public void testCglib() throws Ecxeption {
    	//springIOC容器中获取对象,测试spring中Cglib中的动态代理方式
    	OrderDao orderDao = (OrderDao ) ac.getBean("orderDao");
    	System.out.println(orderDao.getClass());
    	orderDao.save();
    }

测试结果:

class com.sun.proxy.$Proxy7  
    \[环绕前: \]  
    \[前置通知\]  开启事务..  
    保存用户...  
    \[环绕后: \]  
    \[后置通知\]  提交事务..  
    \[返回后通知\]

到这里，我们已经全部介绍完Spring AOP。回到开篇的问题，我们拿它做什么？

(1) Spring声明式事务管理配置

(2) Controller层的参数校验

(3) 使用 Spring AOP 实现 MySQL 数据库读写分离案例分析

(4) 在执行方法前，判断是否具有权限

(5) 对部分函数的调用进行日志记录：监控部分重要函数，若抛出指定的异常，可以以短信或邮件方式通知相关人员。

(6) 信息过滤，页面转发等等功能