cglib动态代理简单介绍

CGLIB(Code Generation Library)是一个开源项目，是一个强大的,高性能,高质量的Code生成类库,它可以在运行期扩展Java类与实现Java接口。Hibernate用它来实现PO字节码的动态生成。代理为控制要访问的目标对象提供了一种途径。当访问对象时，它引入了一个间接的层。JDK自从1.3版本开始，就引入了动态代理，并且经常被用来动态地创建代理。JDK的动态代理用起来非常简单，但它有一个限制，就是使用动态代理的对象必须实现一个或多个接口。如果想代理没有实现接口的继承的类，该怎么办？现在我们可以使用CGLIB包。

使用CGLIB实现动态代理的关键点有两个：

1.实现net.sf.cglib.proxy.MethodInterceptor接口。

2.使用Enhancer类生成代理对象。

下面请看一个例子：

org.itew.Dog.java

package org.itew;
/**
 * 这是个Pojo类,它很普通，它描述了一个狗的行为（方法）和属性（域）
 * @author JiLu
 * @version 1.0
 */
public class Dog {
	
	private String name;
	private int age;
	
	public Dog()
	{
		name = "dog";
		age = 0;
	}

	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 void bark()
	{
		System.out.println("Wang Wang!\nMy name is "+name+"!");
	}

}

org.itew.CGlibTest.java

package org.itew;

import java.lang.reflect.Method;

import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
/**
 * 这是一个实现了MethodInterceptor接口的泛型类，他有两个主要的方法，getProxyInstence用于创建某个类的代理类，intercept方法是实现接口MethodInterceptor声明方法，它拦截代理类的全部方法。
 * @author JiLu
 * @version 1.0
 */
public class CGlibTest<T> implements MethodInterceptor{

	
	/**
	 * 返回指定类的一个代理类
	 * @param targetClass 指定的类
	 * @return 返回指定类targetClass的代理类
	 */
	@SuppressWarnings("unchecked") //忽略类型转换的警告
	public T getProxyInstence(Class<T> targetClass)
	{
		Enhancer enhancer = new Enhancer();
		enhancer.setSuperclass(targetClass);
		enhancer.setCallback(this);
		
		return (T) enhancer.create();//类型转换会有一个警告
	}
	
	/**
	 * 返回拦截方法之后的生成的返回值
	 * @param obj 执行方法的代理对象
	 * @param method 原方法的对象
	 * @param args 调用方法传入的参数
	 * @param proxyMethod 执行方法的代理对象
	 * @return 返回拦截方法之后的生成的返回值
	 */
	@Override
	public Object intercept(Object obj, Method method, Object[] args,
			MethodProxy proxyMethod) throws Throwable {
		
		
		//打印方法名称
		System.out.println("************************************\n方法调用前!\n\t方法名称:"+method.getName()+"\n\t方法信息:"+proxyMethod.getSignature());
		
		//得到所有参数的类型
		Class<? extends Object>[] parameterType = method.getParameterTypes();
		//打印参数类型和参数值
		System.out.print("\t参数:[");
		for(int i=0;i<parameterType.length;i++){
			System.out.print(parameterType[i].getName()+":"+args[i].toString());
			if(i!=parameterType.length-1)
				System.out.print(",");
		}
		System.out.println("]");
		
		//调用实际执行方法，注意一般不要使用下面两种形式，处理不当可能对死循环
		Object returnObj = proxyMethod.invokeSuper(obj, args);
		
		
		//该方法已经被条用，若在调用则会陷入死循环
		//Object returnObj = proxyMethod.invoke(obj, args);
		//该方法已经被条用，若在调用则会陷入死循环
		//Object returnObj = method.invoke(obj, args);
		
		System.out.println("方法调研后!\n************************************\n");
		
		return returnObj;
	}
	
	
	public static void main(String[] args) {
		CGlibTest<Dog> CGlibTestInstance = new CGlibTest<Dog>();
		Dog dog1 = CGlibTestInstance.getProxyInstence(Dog.class);
		dog1.bark();
		System.out.println("小狗名字:"+dog1.getName()+"\t小狗年龄:"+dog1.getAge()+"\n");
		
		Dog dog2 = CGlibTestInstance.getProxyInstence(Dog.class);
		dog2.setAge(5);
		dog2.setName("dog2");
		dog2.bark();
		System.out.println("小狗名字:"+dog2.getName()+"\t小狗年龄:"+dog2.getAge()+"\n");
		
	}

}

上面代码运行输出为：

************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
Wang Wang!
My name is dog!
方法调研后!
************************************

************************************
方法调用前!
	方法名称:getName
	方法信息:getName()Ljava/lang/String;
	参数:[]
方法调研后!
************************************

************************************
方法调用前!
	方法名称:getAge
	方法信息:getAge()I
	参数:[]
方法调研后!
************************************

小狗名字:dog	小狗年龄:0

************************************
方法调用前!
	方法名称:setAge
	方法信息:setAge(I)V
	参数:[int:5]
方法调研后!
************************************

************************************
方法调用前!
	方法名称:setName
	方法信息:setName(Ljava/lang/String;)V
	参数:[java.lang.String:dog2]
方法调研后!
************************************

************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
Wang Wang!
My name is dog2!
方法调研后!
************************************

************************************
方法调用前!
	方法名称:getName
	方法信息:getName()Ljava/lang/String;
	参数:[]
方法调研后!
************************************

************************************
方法调用前!
	方法名称:getAge
	方法信息:getAge()I
	参数:[]
方法调研后!
************************************

小狗名字:dog2	小狗年龄:5

上面代码中Dog类是一个普通的Java类，CGlibTest类实现了MethodInterceptor接口的intercept用于监听，代理类调用的所有方法，该方法说明如下：

Object intercept(Object obj, Method method, Object[] args,MethodProxy proxyMethod) throws Throwable

• 参数obj：调用方法的代理类；
• 参数method：代理类调用的方法的反射实例，用于得到方法的一些信息，如方法的签名和返回值等；
• 参数args：方法传入的参数；
• 参数proxyMethod：代理类的代理方法的实例，用于获得一些方法信息（比method中获得的信息少），并可以proxyMethod.invokeSuper(Object obj,Object[] args);执行该方法（这个特性是非常重要的）；
• 返回值Object：代理方法执行后的返回值，可以是原方法的返回值，也可以是代理方法中新生成的返回值。

另外CGlibTest类通过Enhancer类产生一个目标类的子类（动态代理类），并注册了方法执行时的监听器（某个实现MethodInterceptor接口的实例）。

注意我带 CGlibTest的代码中是调用proxyMethod.invokeSuper(obj,args);来执行被实际代理类的方法的，而没有使用proxyMethod.invoke(obj,args);或method.invoke(obj,args);来执行该方法。这样做的原因是后两个方法的调用会引起监听器MethodIntercepter的响应从而执行intercept方法。从而又执行proxyMethod.invoke(obj,args);或method.invoke(obj,args);方法，从而又引起监听器......。然后就死循环了。

或使用proxyMethod.invoke(obj,args);或method.invoke(obj,args);来替换proxyMethod.invokeSuper(obj,args);则运行报错:

************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
************************************
方法调用前!
	方法名称:bark
	方法信息:bark()V
	参数:[]
************************************
.........................................
(这里还会有很多"方法调用前!"..................)
Exception in thread "main" java.lang.StackOverflowError
	at sun.nio.cs.ext.DoubleByte$Encoder.encodeArrayLoop(Unknown Source)
	at sun.nio.cs.ext.DoubleByte$Encoder.encodeLoop(Unknown Source)
	at java.nio.charset.CharsetEncoder.encode(Unknown Source)
	at sun.nio.cs.StreamEncoder.implWrite(Unknown Source)
	at sun.nio.cs.StreamEncoder.write(Unknown Source)
	at java.io.OutputStreamWriter.write(Unknown Source)
	at java.io.BufferedWriter.flushBuffer(Unknown Source)
	at java.io.PrintStream.write(Unknown Source)
	at java.io.PrintStream.print(Unknown Source)
	at java.io.PrintStream.println(Unknown Source)
	at org.itew.CGlibTest.intercept(CGlibTest.java:45)
	at org.itew.Dog$$EnhancerByCGLIB$$548ce077.bark(<generated>)
	at org.itew.Dog$$FastClassByCGLIB$$d8615e95.invoke(<generated>)
	at net.sf.cglib.proxy.MethodProxy.invoke(MethodProxy.java:204)
	at org.itew.CGlibTest.intercept(CGlibTest.java:63)
	at org.itew.Dog$$EnhancerByCGLIB$$548ce077.bark(<generated>)
	at org.itew.Dog$$FastClassByCGLIB$$d8615e95.invoke(<generated>)
	at net.sf.cglib.proxy.MethodProxy.invoke(MethodProxy.java:204)
	at org.itew.CGlibTest.intercept(CGlibTest.java:63)
	at org.itew.Dog$$EnhancerByCGLIB$$548ce077.bark(<generated>)
	at org.itew.Dog$$FastClassByCGLIB$$d8615e95.invoke(<generated>)
	at net.sf.cglib.proxy.MethodProxy.invoke(MethodProxy.java:204)
	at org.itew.CGlibTest.intercept(CGlibTest.java:63)..............
（这里堆栈也会很长而且都是"at org.itew.CGlibTest.intercept("...............................）

上面我定义的 CGlibTest只是通过intercept方法打印出了一些被调用方法的名称和参数等信息，大家想想看如果我们使用反射打印出调用对象obj类的信息（使用getXXX();方法调用每个属性的值，或者使用toString()方法打印这个类的信息）会出现什么问题？应该怎么解决?