Cglib及其基本使用

╰+攻爆jí腚メ 2022-04-08 13:57 248阅读 0赞

# [Cglib及其基本使用][Cglib] #

**前言**

最近一直在看Spring源码，其实我之前一直知道AOP的基本实现原理：

*  如果针对接口做代理默认使用的是JDK自带的Proxy+InvocationHandler
 *  如果针对类做代理使用的是Cglib
 *  即使针对接口做代理，也可以将代理方式配置成走Cglib的

之后要看AOP源码了，Proxy+InvocationHandler这套我已经很熟了，想着如果把Cglib研究研究，应该看AOP源码的时候会更快一些，因此本文就研究一下Cglib是什么、如何一些基本的使用、底层实现原理。

**Cglib是什么**

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

![20181218144604169][]

对此图总结一下：

*  最底层的是字节码Bytecode，字节码是Java为了保证“一次编译、到处运行”而产生的一种虚拟指令格式，例如iload\_0、iconst\_1、if\_icmpne、dup等
 *  位于字节码之上的是ASM，这是一种直接操作字节码的框架，应用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代码示例----对类做代理。首先定义一个Dao类，里面有一个select()方法和一个update()方法：

![复制代码][20181218144604187]

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

![复制代码][20181218144604187]

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

![复制代码][20181218144604187]

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;
        }
        
    }

![复制代码][20181218144604187]

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

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

写一个测试类：

![复制代码][20181218144604187]

public class CglibTest {
    
        @Test
        public void testCglib() {
            DaoProxy daoProxy = new DaoProxy();
            
            Enhancer enhancer = new Enhancer();
            enhancer.setSuperclass(Dao.class);
            enhancer.setCallback(daoProxy);
            
            Dao dao = (Dao)enhancer.create();
            dao.update();
            dao.select();
        }
        
    }

![复制代码][20181218144604187]

这是使用Cglib的通用写法，setSuperclass表示设置要代理的类，setCallback表示设置回调即MethodInterceptor的实现类，使用create()方法生成一个代理对象，注意要强转一下，因为返回的是Object。最后看一下运行结果：

Before Method Invoke
    PeopleDao.update()
    After Method Invoke
    Before Method Invoke
    PeopleDao.select()
    After Method Invoke

符合我们的期望。

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

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

在本例中，即我们想对select()方法与update()方法使用不同的拦截策略，那么我们先定义一个新的Proxy：

![复制代码][20181218144604187]

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;
        }
        
    }

![复制代码][20181218144604187]

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

![复制代码][20181218144604187]

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

![复制代码][20181218144604187]

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

![复制代码][20181218144604187]

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();
        }
        
    }

![复制代码][20181218144604187]

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

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

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

StartTime=[1491198489261]
    PeopleDao.update()
    EndTime=[1491198489275]
    Before Method Invoke
    PeopleDao.select()
    After Method Invoke

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

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

**构造函数不拦截方法**

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

![复制代码][20181218144604187]

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

![复制代码][20181218144604187]

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

![复制代码][20181218144604187]

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();
        }
        
    }

![复制代码][20181218144604187]

运行结果为：

![复制代码][20181218144604187]

PeopleDao.update()
    StartTime=[1491202022297]
    PeopleDao.update()
    EndTime=[1491202022311]
    Before Method Invoke
    PeopleDao.select()
    After Method Invoke

![复制代码][20181218144604187]

看到第一次update()方法的调用，即Dao类构造方法中的调用没有拦截，符合预期。

**后记**

本文演示了一些Cglib的基本用法，由于Cglib的原理探究篇幅比较长，就不放在本文写了，会在下一篇文章中写。

想要深入使用Cglib的朋友还需要多多尝试Cglib的各种API，才能更好地使用这个优秀的字节码生成框架。

**==================================================================================   
  
我不能保证写的每个地方都是对的，但是至少能保证不复制、不黏贴，保证每一句话、每一行代码都经过了认真的推敲、仔细的斟酌。每一篇文章的背后，希望都能看到自己对于技术、对于生活的态度。  
  
我相信乔布斯说的，只有那些疯狂到认为自己可以改变世界的人才能真正地改变世界。面对压力，我可以挑灯夜战、不眠不休；面对困难，我愿意迎难而上、永不退缩。  
  
其实我想说的是，我只是一个程序员，这就是我现在纯粹人生的全部。  
  
==================================================================================**

分类: [Java基础][Java]

好文要顶 关注我 收藏该文 ![20181218144604454][] ![20181218144604473][]

[![20181218144604488][]][20181218144604488 1]

[五月的仓颉][20181218144604488 1]  
[关注 - 2][- 2]  
[粉丝 - 3449][- 3449]

\+加关注

[« ][Link 1]上一篇：[Java回调机制解读][Link 1]  
[» ][Link 2]下一篇：[记一次synchronized锁字符串引发的坑兼再谈Java字符串][Link 2]

posted @ 2017-04-03 14:49 [五月的仓颉][Link 3] 阅读(9170) 评论(4) [编辑][Link 4] [收藏][Link 5]

评论列表

[\#1楼][1] 2017-07-10 16:01 [hei,hai][hei_hai] [ ][Link 6]

楼主，DaoAnotherProxy 中的method invoke 好像写错了吧？

支持(0)反对(0)

[\#2楼][2]\[楼主\] 2017-07-10 20:50 [五月的仓颉][Link 3] [ ][Link 7][@][1] hei,hai

[引用][1]楼主，DaoAnotherProxy 中的method invoke 好像写错了吧？

哪里？

支持(0)反对(0)

[\#3楼][3] 2017-08-21 16:37 [norlitatelee][] [ ][Link 8]

楼主，在Cblig第二个例子里面DaoanotherFilter，如果调用的是invoke而不是invokesuper会引起一个死循环，查了一下invokesuper执行的是原始类的方法，invoke执行的是子类的方法，如果invoke后面传进去参数是子类的话，就会引起循环调用。

支持(0)反对(0)

[\#4楼][4] 2017-10-26 17:33 [tony\_lu229][tony_lu229] [ ][Link 9]

System.out.println("StartTime=\[" + System.currentTimeMillis() + "\]");  
method.invoke(object, objects);  
System.out.println("EndTime=\[" + System.currentTimeMillis() + "\]");  
此处应该还是：  
proxy.invokeSuper(object, objects);

[Cglib]: https://www.cnblogs.com/xrq730/p/6661692.html
[20181218144604169]: /images/20220404/c3c42267e43045ab899350544f02dca0.png
[20181218144604187]: /images/20220404/3ffad6162cec44b08ff1ff8f33b20624.png
[Java]: https://www.cnblogs.com/xrq730/category/731394.html
[20181218144604454]: https://img-blog.csdnimg.cn/20181218144604454
[20181218144604473]: /images/20220404/e8685078d32f4268a3fd820aab09b07a.png
[20181218144604488]: /images/20220404/d7a7a0007265410e86a63db17e0bfb0c.png
[20181218144604488 1]: http://home.cnblogs.com/u/xrq730/
[- 2]: http://home.cnblogs.com/u/xrq730/followees
[- 3449]: http://home.cnblogs.com/u/xrq730/followers
[Link 1]: https://www.cnblogs.com/xrq730/p/6424471.html
[Link 2]: https://www.cnblogs.com/xrq730/p/6662232.html
[Link 3]: https://www.cnblogs.com/xrq730/
[Link 4]: https://i.cnblogs.com/EditPosts.aspx?postid=6661692
[Link 5]: https://www.cnblogs.com/xrq730/p/6661692.html#
[1]: https://www.cnblogs.com/xrq730/p/6661692.html#3731994
[hei_hai]: http://home.cnblogs.com/u/1186874/
[Link 6]: http://msg.cnblogs.com/send/hei%2Chai
[2]: https://www.cnblogs.com/xrq730/p/6661692.html#3732208
[Link 7]: http://msg.cnblogs.com/send/%E4%BA%94%E6%9C%88%E7%9A%84%E4%BB%93%E9%A2%89
[3]: https://www.cnblogs.com/xrq730/p/6661692.html#3762742
[norlitatelee]: http://home.cnblogs.com/u/1208345/
[Link 8]: http://msg.cnblogs.com/send/norlitatelee
[4]: https://www.cnblogs.com/xrq730/p/6661692.html#3822512
[tony_lu229]: https://www.cnblogs.com/tony-lu229/
[Link 9]: http://msg.cnblogs.com/send/tony_lu229