Cglib及其基本使用

向右看齐 2022-03-01 02:50 167阅读 0赞

原文地址：[https://www.cnblogs.com/xrq730/p/6661692.html][https_www.cnblogs.com_xrq730_p_6661692.html]

### **一、Cglib是什么** ###

Cglib是一个强大的、高性能的**代码生成包**，它广泛被许多AOP框架使用，为他们**提供方法的拦截**。下图是我网上找到的一张Cglib与一些框架和语言的关系：

![801753-20170403122105941-1116862243.gif][]

对此图总结一下：

*  最底层的是字节码Bytecode，字节码是Java为了保证“一次编译、到处运行”而产生的一种虚拟指令格式，例如iload\_0、iconst\_1、if\_icmpne、dup等
 *  位于字节码之上的是ASM（assembly 意为汇编，装配），这是一种直接操作字节码的框架，应用ASM需要对Java字节码、Class结构比较熟悉
 *  位于ASM之上的是CGLIB、Groovy、BeanShell，后两种并不是Java体系中的内容而是脚本语言，它们通过ASM框架生成字节码变相执行Java代码，这说明**在JVM中执行程序并不一定非要写Java代码----只要你能生成Java字节码，JVM并不关心字节码的来源**，当然通过Java代码生成的JVM字节码是通过编译器直接生成的，算是最“正统”的JVM字节码
 *  位于CGLIB、Groovy、BeanShell之上的就是Hibernate、Spring AOP这些框架了，这一层大家都比较熟悉
 *  最上层的是Applications，即具体应用，一般都是一个Web项目或者本地跑一个程序

### **二、使用Cglib代码对类做代理** ###

详细请参照代理模式详解之Cglib动态代理：[https://mp.csdn.net/postedit/88715234][https_mp.csdn.net_postedit_88715234]

下面演示一下Cglib代码示例----对类做代理。首先定义一个Dao类，里面有一个select()方法和一个update()方法：

### 三、**使用Cglib定义不同的拦截策略** ###

再扩展一点点，比方说在AOP中我们经常碰到的一种复杂场景是：**我们想对类A的B方法使用一种拦截策略、类A的C方法使用另外一种拦截策略**。

如果我们想对同一个类的两个方法使用不同的拦截策略，例子如下：

创建一个Dao代理，实现MethodInterceptor接口，目标是在update()方法与select()方法调用前后输出两句话：

public class Dao {
        
        public void update() {
            System.out.println("PeopleDao.update()");
        }
        
        public void select() {
            System.out.println("PeopleDao.select()");
        }
    }

intercept方法的参数名并不是原生的参数名，我做了自己的调整，几个参数的含义为：

*  Object表示要进行增强的对象
 *  Method表示拦截的方法
 *  Object\[\]数组表示参数列表，基本数据类型需要传入其包装类型，如int-->Integer、long-Long、double-->Double
 *  MethodProxy表示对方法的代理，invokeSuper方法表示对被代理对象方法的调用

public class DaoProxy implements MethodInterceptor {
    
        @Override
        public Object intercept(Object object, Method method, Object[] objects, MethodProxy proxy) throws Throwable {
            System.out.println("Before Method Invoke");
            proxy.invokeSuper(object, objects);
            System.out.println("After Method Invoke");
            
            return object;
        }
        
    }

再定义一个新的proxy类

public class DaoAnotherProxy implements MethodInterceptor {
    
        @Override
        public Object intercept(Object object, Method method, Object[] objects, MethodProxy proxy) throws Throwable {
            
            System.out.println("StartTime=[" + System.currentTimeMillis() + "]");
            method.invoke(object, objects);
            System.out.println("EndTime=[" + System.currentTimeMillis() + "]");
            return object;
        }
        
    }

方法调用前后输出一下开始时间与结束时间。为了实现我们的需求，实现一下CallbackFilter：

public class DaoFilter implements CallbackFilter {
    
        @Override
        public int accept(Method method) {
            if ("select".equals(method.getName())) {
                return 0;
            }
            return 1;
        }
        
    }

返回的数值表示顺序，结合下面的代码解释，测试代码：

public class CglibTest {
    
        @Test
        public void testCglib() {
            DaoProxy daoProxy = new DaoProxy();
            DaoAnotherProxy daoAnotherProxy = new DaoAnotherProxy();
            
            Enhancer enhancer = new Enhancer();
            enhancer.setSuperclass(Dao.class);
            enhancer.setCallbacks(new Callback[]{daoProxy, daoAnotherProxy, NoOp.INSTANCE});
            enhancer.setCallbackFilter(new DaoFilter());
            
            Dao dao = (Dao)enhancer.create();
            dao.update();
            dao.select();
        }
        
    }

意思是CallbackFilter的accept方法返回的数值表示的是顺序，顺序和setCallbacks里面Proxy的顺序是一致的。再解释清楚一点，Callback数组中有三个callback，那么：

*  方法名为"select"的方法返回的顺序为0，即使用Callback数组中的0位callback，即DaoProxy
 *  方法名不为"select"的方法返回的顺序为1，即使用Callback数组中的1位callback，即DaoAnotherProxy

因此，方法的执行结果为：

![20190322134354562.png][]

符合我们的预期，因为update()方法不是方法名为"select"的方法，因此返回1，返回1使用DaoAnotherProxy，即打印时间；select()方法是方法名为"select"的方法，因此返回0，返回0使用DaoProxy，即方法调用前后输出两句话。

这里要额外提一下，Callback数组中我特意定义了一个NoOp.INSTANCE，这表示一个空Callback，即如果不想对某个方法进行拦截，可以在DaoFilter中返回2，具体效果可以自己尝试一下。

### **四、构造函数不拦截方法** ###

如果Update()方法与select()方法在构造函数中被调用，那么也是会对这两个方法进行相应的拦截的，现在我想要的是构造函数中调用的方法不会被拦截，那么应该如何做？先改一下Dao代码，加一个构造方法Dao()，调用一下update()方法：

public class Dao {
        
        public Dao() {
            update();
        }
        
        public void update() {
            System.out.println("PeopleDao.update()");
        }
        
        public void select() {
            System.out.println("PeopleDao.select()");
        }
    }

如果想要在构造函数中调用update()方法时，不拦截的话，Enhancer中有一个setInterceptDuringConstruction(boolean interceptDuringConstruction)方法设置为false即可，默认为true，即构造函数中调用方法也是会拦截的。那么测试方法这么写：

public class CglibTest {
    
        @Test
        public void testCglib() {
            DaoProxy daoProxy = new DaoProxy();
            DaoAnotherProxy daoAnotherProxy = new DaoAnotherProxy();
            
            Enhancer enhancer = new Enhancer();
            enhancer.setSuperclass(Dao.class);
            enhancer.setCallbacks(new Callback[]{daoProxy, daoAnotherProxy, NoOp.INSTANCE});
            enhancer.setCallbackFilter(new DaoFilter());
            enhancer.setInterceptDuringConstruction(false);
            
            Dao dao = (Dao)enhancer.create();
            dao.update();
            dao.select();
        }
        
    }

运行结果为：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x4ejM1MjkwNzgzOQ_size_16_color_FFFFFF_t_70][]

[https_www.cnblogs.com_xrq730_p_6661692.html]: https://www.cnblogs.com/xrq730/p/6661692.html
[801753-20170403122105941-1116862243.gif]: /images/20220301/e1ed28e4f7c941a48732cb4d57293129.png
[https_mp.csdn.net_postedit_88715234]: https://mp.csdn.net/postedit/88715234
[20190322134354562.png]: /images/20220301/619e0f38f7ee441ab3439ddbb0b05a53.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x4ejM1MjkwNzgzOQ_size_16_color_FFFFFF_t_70]: /images/20220301/afae8bf75e794304a8da5b7041a86fdf.png