CGLIB(Code Generation Library) 引见与道理

发布日期:2019-07-23 19:48:00 阅读数: 275次 来源: 作者:

一、什么是 CGLIB?

CGLIB是一个功能强大,高机能的代码生成包。它为没有实现接口的类供给代办署理,为JDK的动态代办署理供给了很好的弥补。凡是能够利用Java的动态代办署理建立代办署理,但当要代办署理的类没有实现接口或者为了更好的机能,CGLIB是一个好的选择。

CGLIB作为一个开源项目,其代码托管在github,地址为:https://github.com/cglib/cglib


二、CGLIB 道理

CGLIB 道理:动态生成一个要代办署理类的子类,子类重写要代办署理的类的所有不是final的方式。在子类中采用方式拦截的手艺拦截所有父类方式的挪用,顺势织入横切逻辑。它比利用java反射的JDK动态代办署理要快。

CGLIB 底层:利用字节码处置框架ASM,来转换字节码并生成新的类。不激励间接利用ASM,由于它要求你必需对JVM内部布局包罗class文件的格局和指令集都很熟悉。

CGLIB错误谬误:对于final方式,无法进行代办署理。


三、CGLIB 的使用

普遍的被很多AOP的框架利用,例如Spring AOP和dynaop。Hibernate利用CGLIB来代办署理单端single-ended(多对一和一对一)联系关系。


四、为什么利用 CGLIB?

CGLIB代办署理次要通过对字节码的操作,为对象引入间接级别,以节制对象的拜候。我们晓得Java中有一个动态代办署理也是做这个工作的,那我们为什么不间接利用Java动态代办署理,而要利用CGLIB呢?谜底是CGLIB比拟于JDK动态代办署理愈加强大,JDK动态代办署理虽然简单易用,可是其有一个致命缺陷是,只能对接口进行代办署理。若是要代办署理的类为一个通俗类、没有接口,那么Java动态代办署理就没法利用了。


五、CGLIB构成布局

CGLIB底层利用了ASM(一个短小精干的字节码操作框架)来操作字节码生成新的类。除了CGLIB库外,脚本言语(如Groovy何BeanShell)也利用ASM生成字节码。ASM利用雷同SAX的解析器来实现高机能。我们不激励间接利用ASM,由于它需要对Java字节码的格局足够的领会。


六、CGLIB的API

1、Jar包:

  • cglib-nodep-2.2.jar:利用nodep包不需要联系关系asm的jar包,jar包内部包含asm的类.
  • cglib-2.2.jar:利用此jar包需要联系关系asm的jar包,不然运转时报错.

2、CGLIB类库:

因为根基代码很少,学起来有必然的坚苦,次要是贫乏文档和示例,这也是CGLIB的一个不足之处。

本系列利用的CGLIB版本是2.2。

  • net.sf.cglib.core: 底层字节码处置类,他们大部门与ASM相关系。
  • net.sf.cglib.transform: 编译期或运转期类和类文件的转换
  • net.sf.cglib.proxy: 实现建立代办署理和方式拦截器的类
  • net.sf.cglib.reflect: 实现快速反射和C#气概代办署理的类
  • net.sf.cglib.util: 调集排序等东西类
  • net.sf.cglib.beans: JavaBean相关的东西类

本篇引见通过MethodInterceptor和Enhancer实现一个动态代办署理。

一、起首说一下JDK中的动态代办署理:

JDK中的动态代办署理是通过反射类Proxy以和InvocationHandler回调接话柄现的,可是,JDK中所要进步履态代办署理的类必需要实现一个接口,也就是说只能对该类所实现接口中定义的方式进行代办署理,这在现实编程中具有必然的局限性,并且利用反射的效率也并不是很高。

二、利用CGLib实现:

利用CGLib实现动态代办署理,完全不受代办署理类必需实现接口的限制,并且CGLib底层采用ASM字节码生成框架,利用字节码手艺生成代办署理类,比利用Java反射效率要高。独一需要留意的是,CGLib不克不及对声明为final的方式进行代办署理,由于CGLib道理是动态生成被代办署理类的子类。

下面,将通过一个实例引见利用CGLib实现动态代办署理。

1、被代办署理类:

起首,定义一个类,该类没有实现任何接口。

package com.zghw.cglib; /** * 没有实现接口,需要CGlib动态代办署理的方针类 * * @author zghw * */ public class TargetObject { public String method1(String paramName) { return paramName; } public int method2(int count) { return count; } public int method3(int count) { return count; } @Override public String toString() { return "TargetObject []"+ getClass(); } }

2、拦截器:

定义一个拦截器。在挪用方针方式时,CGLib会回调MethodInterceptor接口方式拦截,来实现你本身的代办署理逻辑,雷同于JDK中的InvocationHandler接口。

package com.zghw.cglib; import java.lang.reflect.Method; import net.sf.cglib.proxy.MethodInterceptor; import net.sf.cglib.proxy.MethodProxy; /** * 方针对象拦截器,实现MethodInterceptor * @author zghw * */ public class TargetInterceptor implements MethodInterceptor{ /** * 重写方式拦截在方式前和方式后插手营业 * Object obj为方针对象 * Method method为方针方式 * Object[] params 为参数, * MethodProxy proxy CGlib方式代办署理对象 */ @Override public Object intercept(Object obj, Method method, Object[] params, MethodProxy proxy) throws Throwable { System.out.println("挪用前"); Object result = proxy.invokeSuper(obj, params); System.out.println(" 挪用后"+result); return result; } }

参数:Object为由CGLib动态生成的代办署理类实例,Method为上文中实体类所挪用的被代办署理的方式援用,Object[]为参数值列表,MethodProxy为生成的代办署理类对方式的代办署理援用。

前往:从代办署理实例的方式挪用前往的值。

此中,proxy.invokeSuper(obj,arg) 挪用代办署理类实例上的proxy方式的父类方式(即实体类TargetObject中对应的方式)

在这个示例中,只在挪用被代办署理类方式前后各打印了一句话,当然现实编程中能够是其它复杂逻辑。

3、生成动态代办署理类:

package com.zghw.cglib; import net.sf.cglib.proxy.Callback; import net.sf.cglib.proxy.CallbackFilter; import net.sf.cglib.proxy.Enhancer; import net.sf.cglib.proxy.NoOp; public class TestCglib { public static void main(String args[]) { Enhancer enhancer =new Enhancer(); enhancer.setSuperclass(TargetObject.class); enhancer.setCallback(new TargetInterceptor()); TargetObject targetObject2=(TargetObject)enhancer.create(); System.out.println(targetObject2); System.out.println(targetObject2.method1("mmm1")); System.out.println(targetObject2.method2(100)); System.out.println(targetObject2.method3(200)); } }

这里Enhancer类是CGLib中的一个字节码加强器,它能够便利的对你想要处置的类进行扩展,当前会经常看到它。

起首将被代办署理类TargetObject设置成父类,然后设置拦截器TargetInterceptor,最初施行enhancer.create()动态生成一个代办署理类,并从Object强制转型成父类型TargetObject。

最初,在代办署理类上挪用方式。

4、回调过滤器CallbackFilter

一、感化

在CGLib回调时能够设置对分歧方式施行分歧的回调逻辑,或者底子不施行回调。

在JDK动态代办署理中并没有雷同的功能,对InvocationHandler接口方式的挪用对代办署理类内的所以方式都无效。

定义实现过滤器CallbackFilter接口的类:

package com.zghw.cglib; import java.lang.reflect.Method; import net.sf.cglib.proxy.CallbackFilter; /** * 回调方式过滤 * @author zghw * */ public class TargetMethodCallbackFilter implements CallbackFilter { /** * 过滤方式 * 前往的值为数字,代表了Callback数组中的索引位置,要到用的Callback */ @Override public int accept(Method method) { if(method.getName().equals("method1")){ System.out.println("filter method1 ==0"); return 0; } if(method.getName().equals("method2")){ System.out.println("filter method2 ==1"); return 1; } if(method.getName().equals("method3")){ System.out.println("filter method3 ==2"); return 2; } return 0; } }

此中return值为被代办署理类的各个方式在回调数组Callback[]中的位置索引(见下文)。

package com.zghw.cglib; import net.sf.cglib.proxy.Callback; import net.sf.cglib.proxy.CallbackFilter; import net.sf.cglib.proxy.Enhancer; import net.sf.cglib.proxy.NoOp; public class TestCglib { public static void main(String args[]) { Enhancer enhancer =new Enhancer(); enhancer.setSuperclass(TargetObject.class); CallbackFilter callbackFilter = new TargetMethodCallbackFilter(); /** * (1)callback1:方式拦截器 (2)NoOp.INSTANCE:这个NoOp暗示no operator,即什么操作也不做,代办署理类间接挪用被代办署理的方式不进行拦截。 (3)FixedValue:暗示锁定方式前往值,无论被代办署理类的方式前往什么值,回调方式都前往固定值。 */ Callback noopCb=NoOp.INSTANCE; Callback callback1=new TargetInterceptor(); Callback fixedValue=new TargetResultFixed(); Callback[] cbarray=new Callback[]{callback1,noopCb,fixedValue}; //enhancer.setCallback(new TargetInterceptor()); enhancer.setCallbacks(cbarray); enhancer.setCallbackFilter(callbackFilter); TargetObject targetObject2=(TargetObject)enhancer.create(); System.out.println(targetObject2); System.out.println(targetObject2.method1("mmm1")); System.out.println(targetObject2.method2(100)); System.out.println(targetObject2.method3(100)); System.out.println(targetObject2.method3(200)); } }
package com.zghw.cglib; import net.sf.cglib.proxy.FixedValue; /** * 暗示锁定方式前往值,无论被代办署理类的方式前往什么值,回调方式都前往固定值。 * @author zghw * */ public class TargetResultFixed implements FixedValue{ /** * 该类实现FixedValue接口,同时锁定回调值为999 * (整型,CallbackFilter中定义的利用FixedValue型回调的方式为getConcreteMethodFixedValue,该方式前往值为整型)。 */ @Override public Object loadObject() throws Exception { System.out.println("锁定成果"); Object obj = 999; return obj; } }

5.延迟加载对象

一、感化:

说到延迟加载,该当经常接触到,特别是利用Hibernate的时候,本篇将通过一个实例阐发延迟加载的实现体例。 LazyLoader接口承继了Callback,因而也算是CGLib中的一种Callback类型。

另一种延迟加载接口Dispatcher。

Dispatcher接口同样承继于Callback,也是一种回调类型。

可是Dispatcher和LazyLoader的区别在于:LazyLoader只在第一次拜候延迟加载属性时触发代办署理类回调方式,而Dispatcher在每次拜候延迟加载属性时城市触发代办署理类回调方式。

二、示例:

起首定义一个实体类LoaderBean,该Bean内有一个需要延迟加载的属性PropertyBean。

package com.zghw.cglib; import net.sf.cglib.proxy.Enhancer; public class LazyBean { private String name; private int age; private PropertyBean propertyBean; private PropertyBean propertyBeanDispatcher; public LazyBean(String name, int age) { System.out.println("lazy bean init"); this.name = name; this.age = age; this.propertyBean = createPropertyBean(); this.propertyBeanDispatcher = createPropertyBeanDispatcher(); } /** * 只第一次懒加载 * @return */ private PropertyBean createPropertyBean() { /** * 利用cglib进行懒加载 对需要延迟加载的对象添加代办署理,在获取该对象属性时先通过代办署理类回调方式进行对象初始化。 * 在不需要加载该对象时,只需不去获取该对象内属性,该对象就不会被初始化了(在CGLib的实现中只需去拜候该对象内属性的getter方式, * 就会主动触发代办署理类回调)。 */ Enhancer enhancer = new Enhancer(); enhancer.setSuperclass(PropertyBean.class); PropertyBean pb = (PropertyBean) enhancer.create(PropertyBean.class, new ConcreteClassLazyLoader()); return pb; } /** * 每次都懒加载 * @return */ private PropertyBean createPropertyBeanDispatcher() { Enhancer enhancer = new Enhancer(); enhancer.setSuperclass(PropertyBean.class); PropertyBean pb = (PropertyBean) enhancer.create(PropertyBean.class, new ConcreteClassDispatcher()); return pb; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } public PropertyBean getPropertyBean() { return propertyBean; } public void setPropertyBean(PropertyBean propertyBean) { this.propertyBean = propertyBean; } public PropertyBean getPropertyBeanDispatcher() { return propertyBeanDispatcher; } public void setPropertyBeanDispatcher(PropertyBean propertyBeanDispatcher) { this.propertyBeanDispatcher = propertyBeanDispatcher; } @Override public String toString() { return "LazyBean [name=" + name + ", age=" + age + ", propertyBean=" + propertyBean + "]"; } }
package com.zghw.cglib; public class PropertyBean { private String key; private Object value; public String getKey() { return key; } public void setKey(String key) { this.key = key; } public Object getValue() { return value; } public void setValue(Object value) { this.value = value; } @Override public String toString() { return "PropertyBean [key=" + key + ", value=" + value + "]" +getClass(); } }
package com.zghw.cglib; import net.sf.cglib.proxy.LazyLoader; public class ConcreteClassLazyLoader implements LazyLoader { /** * 对需要延迟加载的对象添加代办署理,在获取该对象属性时先通过代办署理类回调方式进行对象初始化。 * 在不需要加载该对象时,只需不去获取该对象内属性,该对象就不会被初始化了(在CGLib的实现中只需去拜候该亚博手机app