从JDK1.3开始,Java就引入了动态代理的概念。动态代理(Dynamic Proxy)可以帮助你减少代码行数,真正提高代码的可复用度。例如,你不必为所有的类的方法里面都写上相同的Log代码行,取而代之的是实用类的动态代理类。当然,这种便利是有条件的。本文简单介绍Java动态代理的原理,并实现一个被代理的Servlet创建,和调用的过程。
1.代理模式(Proxy Pattern)
在JDK1.3以前,代理模式就已流行,所以得代理模式是生成一个和类相同接口的代理类,用户通过
使用代理类来封装某个实现类。如图1,其目的是加强实现类的某个方法的功能,而不必改变原有的源代
码。
2.动态代理(Dynamic Proxy)
随着Proxy的流行,Sun把它纳入到JDK1.3实现了Java的动态代理。动态代理和普通的代理模式的
区别,就是动态代理中的代理类是由java.lang.reflect.Proxy类在运行期时根据接口定义,采用Java反射
功能动态生成的。和java.lang.reflect.InvocationHandler结合,可以加强现有类的方法实现。如图2,
图中的自定义Handler实现InvocationHandler接口,自定义Handler实例化时,将实现类传入自定义
Handler对象。自定义Handler需要实现invoke方法,该方法可以使用Java反射调用实现类的实现的方
法,同时当然可以实现其他功能,例如在调用实现类方法前后加入Log。而Proxy类根据Handler和需要代
理的接口动态生成一个接口实现类的对象。当用户调用这个动态生成的实现类时,实际上是调用了自定义
Handler的invoke方法。
3.动态代理示例
package com.jdk.lang;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
/**
* JDK 动态代理类分析(java.lang.reflect.Proxy使用)
*
* @author 张明学
*
*/
public class ProxyStudy {
@SuppressWarnings("unchecked")
public static void main(String[] args) throws Exception {
// 动态代理类:通用指定类加载器,和接口产生一类
// getProxyClass()返回代理类的 java.lang.Class 对象,并向其提供类加载器和接口数组。
Class clazzProxy = Proxy.getProxyClass(Collection.class
.getClassLoader(), Collection.class);
System.out.println("动态产生的类名为:" + clazzProxy.getName());
System.out.println("----------获取动态产生的类的构造方法---------");
Constructor[] constructors = clazzProxy.getConstructors();
int i = 1;
for (Constructor constructor : constructors) {
System.out.println("第" + i + "个构造方法名:" + constructor.getName());
Class[] parameterClazz = constructor.getParameterTypes();
System.out.println("第" + i + "个构造方法参数:" + Arrays.asList(parameterClazz));
i++;
}
System.out.println("----------获取动态产生的类的普通方法---------");
Method[] methods = clazzProxy.getDeclaredMethods();
for (int j = 0; j < methods.length; j++) {
Method method = methods[j];
System.out.println("第" + (j + 1) + "个普通方法名:" + method.getName());
Class[] parameterClazz = method.getParameterTypes();
System.out.println("第" + (j + 1) + "个普通方法参数:"
+ Arrays.asList(parameterClazz));
}
System.out.println("---------获取动态代理对象的构造方法---------");
// 动态代理产生的对象的构造方法需要一个实现java.lang.reflect.InvocationHandler接口的对象,故不能通过
// clazzProxy.newInstance();产生一个对象,可以根据构造方法产生一个对象
// InvocationHandler 是代理实例的调用处理程序 实现的接口。
Constructor constructor = clazzProxy
.getConstructor(InvocationHandler.class);
// 代理产生的对象
Collection proxyBuildCollection = (Collection) constructor
.newInstance(new InvocationHandler() {
// 为什么这里选择ArrayList作为目标对象?
// 因为这里的constructor是clazzProxy这个动态类的构造方法,clazzProxy是通过Proxy.getProxyClass()方法产生的,
// 该方法有两个参数,一个是指定类加载器,一个是指定代理要实现的接口,这个接口我上面指定了Collection
// 而ArrayList实现了Collection接口,固可以为该动态类的目标对象
ArrayList target = new ArrayList();// 动态类的目标对象
public Object invoke(Object proxy, Method method,
Object[] args) throws Throwable {
System.out.println("执行目标" + method.getName() + "方法之前:"
+ System.currentTimeMillis());
Object result = method.invoke(target, args);// 其实代理对象的方法调用还是目标对象的方法
System.out.println("执行目标" + method.getName() + "方法之后:"
+ System.currentTimeMillis());
return result;
}
});
proxyBuildCollection.clear();
proxyBuildCollection.add("abc");
proxyBuildCollection.add("dbc");
System.out.println(proxyBuildCollection.size());
System.out.println(proxyBuildCollection.getClass().getName());
/**
* 动态代理:总结如下:
* 1,通过Proxy.getProxyClass(classLoader,interface)方法产生一个动态类的class字节码
* (clazz) 该getProxyClass()方法有两个参数:一个是指定该动态类的类加载器,一个是该动态类的要实现的接口(
* 从这里可以看现JDK的动态代理必须要实现一个接口)
*
* 2,通过第一步的获取的clazz对象可以获取它的构造方法constructor,
* 那么就可以通用constructor的newInstance()方法构造出一个动态实体对象
* 但constructor的newInstance
* ()方法需要指定一个实现了InvocationHandler接口的类handler,在该类中需要一个目标对象A和实现invoke方法
* 目标对象A要求能对第一步中的接口的实现,因为在invoke方法中将会去调用A中的方法并返回结果。
* 过程如下:调用动态代理对象ProxyObject的x方法 ————> 进入构造方法传进的handler的invoke方法 ————>
* invoke方法调用handler中的target对象
* 的x方法(所以要求target必须要实现构造动态代理类时指定的接口)并返回它的返回值
* 。(其实如果我们代理P类,那么target就可以选中P类,只是要求P必需实现一个接口)
*
* 那么上述中x方法有哪些呢?除了从Object继承过来的方法中除toString,hashCode,
* equals外的方法不交给handler外,其它的方法全部交给handler处理
* 如上面proxyBuildCollection.getClass
* ().getName()就没有调用handler的getClass方法,而是调用自己的
*
* 3,在handler的invoke方法中return
* method.invoke(target,args)就是将方法交给target去完成。
* 那么在这个方法执行之前,之后,异常时我们都可以做一些操作, 并且可以在执行之前检查方法的参数args,执行之后检查方法的结果
*/
System.out.println("-------------------下面的写法更简便--------------------");
// proxyBuildColl是对ArrayList进行代理
Collection proxyBuildCollection2 = (Collection) Proxy.newProxyInstance(
Collection.class.getClassLoader(),// 指定类加载器
new Class[] { Collection.class },// 指定目标对象实现的接口
// 指定handler
new InvocationHandler() {
ArrayList target = new ArrayList();
public Object invoke(Object proxy, Method method,
Object[] args) throws Throwable {
System.out.println(method.getName() + "执行之前...");
if (null != args) {
System.out.println("方法的参数:" + Arrays.asList(args));
} else {
System.out.println("方法的参数:" + null);
}
Object result = method.invoke(target, args);
System.out.println(method.getName() + "执行之后...");
return result;
}
});
proxyBuildCollection2.add("abc");
proxyBuildCollection2.size();
proxyBuildCollection2.clear();
proxyBuildCollection2.getClass().getName();
System.out
.println("-------------------对JDK动态代理的重构--------------------");
Set proxySet = (Set) buildProxy(new HashSet(), new MyAdvice());
proxySet.add("abc");
proxySet.size();
}
/**
* 构造一个目标对象的代理对象
*
* @param target
* 目标对象(需要实现某个接口)
* @return
*/
public static Object buildProxy(final Object target,
final AdviceInter advice) {
Object proxyObject = Proxy.newProxyInstance(target.getClass()
.getClassLoader(),// 指定类加载器
target.getClass().getInterfaces(), // 指定目标对象实现的接口
// handler
new InvocationHandler() {
public Object invoke(Object proxy, Method method,
Object[] args) throws Throwable {
advice.beforeMethod(target, method, args);
Object result = method.invoke(target, args);
advice.afterMethod(target, method, args);
return result;
}
});
return proxyObject;
}
}
/**
* 代理中执行目标方法之前之后的操作
*
* @author 张明学
*
*/
interface AdviceInter {
/**
* 目标方法执行之前 *
*
* @param target
* 目标对象
* @param method
* 方法
* @param args
* 参数
*/
public void beforeMethod(Object target, Method method, Object[] args);
/**
* 目标方法执行之后
*
* @param target
* 目标对象
* @param method
* 方法
* @param args
* 参数
*/
public void afterMethod(Object target, Method method, Object[] args);
}
/**
* 代理中执行目标方法之前之后的操作的一个实例
*
* @author 张明学
*
*/
class MyAdvice implements AdviceInter {
public void afterMethod(Object target, Method method, Object[] args) {
System.out.println("目标对象为:" + target.getClass().getName());
System.out.println(method.getName() + "执行完毕!");
}
public void beforeMethod(Object target, Method method, Object[] args) {
System.out.println(method.getName() + "开始执行");
if (null != args) {
System.out.println("参数为:" + Arrays.asList(args));
} else {
System.out.println("参数为:" + null);
}
}
}
4.动态代理的限制
JDK的动态代理并不能随心所欲的代理所有的类。Proxy.newProxyInstance方法的第二个参数只能是接口数组, 也就是Proxy只能代理接口。
代码示例来自:
http://zmx.iteye.com/blog/678416