JDK 1.3版本后,Java提供了动态代理技术,允许应用在运行期创建接口的代理对象。
JDK 提供的代理只能针对接口做代理。也有更强大的代理库 cglib
,可以实现对类的代理。
在Java中java.lang.reflect
包下提供了一个Proxy
类和一个InvocationHandler
接口,Proxy
类利用InvocationHandler
动态创建一个符合某一接口的实例,生成(运行时)目标类的代理对象。
在普通编程过程中,无须使用动态代理,但在编写框架或底层基础代码时,动态代理的作用就非常大。
代理
代理:Proxy Pattern(即:代理模式),23种常用的面向对象软件的设计模式之一。
代理模式定义:通过代理对象访问目标对象,这样做的目的可以在目标对象实现的基础上,增强额外的功能操作,即扩展目标对象的功能,代理对象可以在客户端和目标对象之间起到中介的作用。
代理模式的关键有两个角色,代理对象和目标对象,代理对象是对目标对象的扩展,并调用目标对象。
理解举例:
代理对象可以形象的理解为经纪人角色,艺人则是目标对象,涉及市场的一些商演或活动的琐碎事项交给经纪人来处理,而主办方是通过经纪人找艺人演出(不能直接 new 艺人);经纪人可以负责多个艺人(动态)。
动态代理
Proxy
Proxy
类提供了static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)
方法来获取代理对象。
- ClassLoader loader:指定代理对象使用的类加载器。
- Class<?>[] interfaces:指代里对象需要实现的接口,是个
Class
数组,也就目标类可能实现多个接口。 - InvocationHandler:编织器对象,执行目标对象方法时会触发该处理器的
invoke
方法,会把当前执行目标对象的方法作为参数传入。
InvocationHandler
InvocationHandler
的invoke(Object proxy, Method method, Object[] args)
方法通过反射机制间接调用目标对象的方法,InvocationHandler
可以更好的理解为编织器,这个特性是非常适用于AOP思想的实现的,可以将横切逻辑代码和目标业务类方法的业务逻辑编织在一起。
- Object proxy:最终生成的代理实例,一般用不到。
- Method method:被代理的目标对象的方法。
- Object[] args:方法需要的参数。
使用动态代理步骤:
- 一个接口。
- 一个接口实现类。
- 一个实现了
InvocationHandler
接口的类,将目标对象做为该类的构造方法的参数传入。重写invoke
方法,在该方法里添加目标类的扩展功能。 - 使用
Proxy
类调用newProxyInstance()
,传入InvocationHandler
对象来生成一个代理对象。 - 通过代理对象调用接口(目标对象实现的接口)里的方法,需要的话给接口里的方法传入参数。
示例代码一
- 一个接口
/**
* 接口
*
*/
public interface UserDao {
void update(int id, String name);
}
- 一个接口实现类
/**
* 目标对象
*
*/
public class UserDaoImpl implements UserDao {
@Override
public void update(int id, String name) {
System.out.println("根据ID更新名称,id = " + id + "; name = " + name );
}
}
- 一个获取代理对象的类
newProxyInstance()
方法的InvocationHandler
对象参数传入一个匿名的InvocationHandler对象。
package com.proxy.dynamic1;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
public class ProxyObjectFactory {
//目标对象,即实现接口的目标类
private Object obj;
//将目标对象做为参数传入构造方法
public ProxyObjectFactory(Object obj) {
this.obj = obj;
}
/**
* 获取代理对象
* 传入InvocationHandler,重写invoke方法
* 扩展功能在invoke方法里执行
* @return
*/
public Object getProxyInstance() {
return Proxy.newProxyInstance(obj.getClass().getClassLoader(),
obj.getClass().getInterfaces(),
new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//给目标对象方法传入的参数
for (Object param : args) {
System.out.println(param);
}
System.out.println("开始事务。。。。。");
//执行目标对象方法
Object methodValue = method.invoke(obj, args);
System.out.println("结束事务。。。。。");
return methodValue;
}
});
}
}
- 调用代理对象执行目标方法
public class ProxyMain {
public static void main(String[] args) {
UserDao userDao = new UserDaoImpl();
UserDao proxy = (UserDao) new ProxyObjectFactory(userDao).getProxyInstance();
System.out.println(proxy.getClass());
proxy.update(100,"root");
}
}
示例代码二
- 自定义
CustomizeInvocationHandler
类,实现InvocationHandler
接口,重写invoke
方法,在该方法里做目标对象的功能扩展。
public class CustomizeInvocationHandler implements InvocationHandler {
private Object target;
public CustomizeInvocationHandler(Object target) {
this.target = target;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("transaction begin....");
Object object = method.invoke(target, args);
System.out.println("transaction end....");
return object;
}
}
- 调用代理对象类创建代理对象,通过代理对象执行目标对象的方法
public class ProxyMain {
public static void main(String[] args) {
UserDao userDao = (UserDao) Proxy.newProxyInstance(UserDao.class.getClassLoader(),
new Class[] {UserDao.class},
new CustomizeInvocationHandler(new UserDaoImpl()));
userDao.save();
}
}
原理分析
JDK的动态代理需要依赖接口,Proxy.newProxyInstance()
需要传入目标对象实现的接口作为参数;也就是说如果目标对象没有实现接口,则无法使用JDK动态代理。查看该方法的原码,进行了验证、优化、缓存、同步、生成字节码,显示加载类等操作。
原码
- newProxyInstance()
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
Objects.requireNonNull(h);
final Class<?>[] intfs = interfaces.clone();
final SecurityManager sm = System.getSecurityManager();
if (sm != null) {
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
}
/*
* Look up or generate the designated proxy class.
* 根据接口查找或生成目标代理类的class
*/
Class<?> cl = getProxyClass0(loader, intfs);
/*
* Invoke its constructor with the designated invocation handler.
*/
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
//调用代理对象的构造方法
final Constructor<?> cons = cl.getConstructor(constructorParams);
final InvocationHandler ih = h;
if (!Modifier.isPublic(cl.getModifiers())) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
cons.setAccessible(true);
return null;
}
});
}
//通过构造器来创建对象
return cons.newInstance(new Object[]{h});
} catch (IllegalAccessException|InstantiationException e) {
throw new InternalError(e.toString(), e);
} catch (InvocationTargetException e) {
Throwable t = e.getCause();
if (t instanceof RuntimeException) {
throw (RuntimeException) t;
} else {
throw new InternalError(t.toString(), t);
}
} catch (NoSuchMethodException e) {
throw new InternalError(e.toString(), e);
}
}
- getProxyClass0()
//获取代理类
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
//对实现接口个数进行限制
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
//缓存了代理类
return proxyClassCache.get(loader, interfaces);
}
注意:本文归作者所有,未经作者允许,不得转载