Java 动态代理详解
今天我们聊聊java动态代理
目录
动态代理
静态代理
在日常生活中有这么一个场景,周末我一般都喜欢去看场电影.那么看电影之前肯定要先买电影票.传统的方式是去电影院买.于是乎就有了Cinema接口:
/**
* 电影院
*/
public interface Cinema {
void buy();
}
电影院可以买票. 一般看大片,尤其是像《复联3》这种巨制,我都会选择去万达:
/**
* 万达电影院
*/
public class WdCinema implements Cinema {
public void buy() {
System.out.println("这里是万达影城,欢迎购票");
}
}
于是乎我就可以到万达影院购票了.但是有个麻烦的事就是我需要去电影院买票.但是现在互联网时代还有谁去电影院买呢？我一般都是用淘票票:
/**
* 代理商
*/
public class CinemaStaticProxy implements Cinema {
private Cinema cinema;
public CinemaStaticProxy(Cinema cinema) {
this.cinema = cinema;
}
public void buy() {
System.out.println("这里是淘票票,现在帮你在电影院买票");
cinema.buy();
}
}
淘票票其实就是中间代理商.也就是proxy.我只打开淘票票,然后选择想去哪家电影院,然后选择购票就可以了:
public class CinemaStaticProxyTest {
@Test
public void buy() {
WdCinema wdCinema = new WdCinema();
CinemaStaticProxy cinemaStaticProxy = new CinemaStaticProxy(wdCinema);
cinemaStaticProxy.buy();
}
}
结果如下:
这里是淘票票,现在帮你在电影院买票
这里是万达影城,欢迎购票
以上这个例子就是一个简单的静态代理.静态代理是在编译器确定实现类的.静态代理的代表作就是AspectJ.
动态代理
那么动态代理是怎么实现呢？首先动态代理有两种实现方式:jdk的动态代理,以及cglib(Code Generation Library,字面意思是代码生成库)
jdk动态代理
在jdk 1.3开始支持动态代理.那如果想要用jdk动态代理怎么实现上面的例子呢？需要实现一个InvocationHandler接口:
public class CinemaProxy implements InvocationHandler {
private Cinema cinema;
public CinemaProxy(Cinema cinema) {
this.cinema = cinema;
}
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
if ("buy".equals(method.getName())) {
System.out.println("这里是动态的淘票票,现在帮你购买电影票");
return method.invoke(cinema, args);
}
return null;
}
}
那么买票现在需要这样买了:
public class CinemaInvocationHandlerTest {
@Test
public void setInvoke() {
DdCinema ddCinema = new DdCinema();
Cinema cinema = (Cinema) Proxy.newProxyInstance(getClass().getClassLoader(),
new Class<?>[]{Cinema.class},
new CinemaInvocationHandler(ddCinema));
cinema.buy();
}
}
输出结果:
这里是动态的淘票票,现在帮你购买电影票
这里是大地影城,欢迎购票
那么他内部是怎么实现的呢？让我们看下关键步骤.
首先看下Proxy.newProxyInstance的参数:
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
loader: 这个无需多解释,就是用来加载proxy的
interfaces: 是我们需要代理的”电影院”接口,可以是多个接口
h:就是实现了InvocationHandler接口的类(本例中的CinemaInvocationHandler)
然后让我们细看newProxyInstance的实现.
- 校验
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
首先,它需要校验接口以及classLoader.如果接口是非public的,那么proxy就必须由define接口的classLoader来定义.否则如果调用者的类加载器与接口的定义加载器不同，当通过defineClass0方法定义生成的代理类时，VM将抛出IllegalAccessError
- 查找或生成
/*
* 查找或生成指定的代理类.
*/
Class<?> cl = getProxyClass0(loader, intfs);
继续深入进去看:
/**
* Generate a proxy class. Must call the checkProxyAccess method
* to perform permission checks before calling this.
*/
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// If the proxy class defined by the given loader implementing
// the given interfaces exists, this will simply return the cached copy;
// otherwise, it will create the proxy class via the ProxyClassFactory
return proxyClassCache.get(loader, interfaces);
}
proxyClassCache的实现类是WeakCache,弱引用会在内存空间不足时进行GC.这里不细讲
由代码可知,它首先会在缓存中查找,如果查到了就直接返回,否则应该就是要去生成代理类.由于接下来的代码太多.这里我找出了关键步骤(ProxyClassFactory的public Class<?> apply(ClassLoader loader, Class<?>[] interfaces)方法):
/*
* Verify that the class loader resolves the name of this
* interface to the same Class object.
*/
Class<?> interfaceClass = null;
try {
//加载目标类实现的接口到内存中
interfaceClass = Class.forName(intf.getName(), false, loader);
} catch (ClassNotFoundException e) {
}
if (interfaceClass != intf) {
throw new IllegalArgumentException(
intf + " is not visible from class loader");
}
/*
* Verify that the Class object actually represents an
* interface.
*/
if (!interfaceClass.isInterface()) {
throw new IllegalArgumentException(
interfaceClass.getName() + " is not an interface");
}
/*
* Verify that this interface is not a duplicate.
*/
if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
throw new IllegalArgumentException(
"repeated interface: " + interfaceClass.getName());
}
它会进行一系列的校验：
- 验证classloader是否将此接口的name解析为同一个Class对象
- 验证对象是不是接口
- 验证该接口是否重复
验证通过之后会生成一个代理类Class返回:
/*
* Choose a name for the proxy class to generate.
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
/*
* 生成指定的proxy class的二进制文件
*/
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
try {
//定义一个proxy class并返回
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
/*
* A ClassFormatError here means that (barring bugs in the
* proxy class generation code) there was some other
* invalid aspect of the arguments supplied to the proxy
* class creation (such as virtual machine limitations
* exceeded).
*/
throw new IllegalArgumentException(e.toString());
}
请注意这里返回的是class而不是object。至于class和object的区别可以查看这里
然后我们继续看它是怎么生成二进制文件的(由于我本地没有源码包,大家凑合看):
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
//动态生成代理内的字节码,里面的内容太复杂就不再深入了
final byte[] var4 = var3.generateClassFile();
//如果需要保存生成的文件,就将上面生成的字节码刷到硬盘上
if (saveGeneratedFiles) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
try {
int var1 = var0.lastIndexOf(46);
Path var2;
if (var1 > 0) {
Path var3 = Paths.get(var0.substring(0, var1).replace('.', File.separatorChar));
Files.createDirectories(var3);
var2 = var3.resolve(var0.substring(var1 + 1, var0.length()) + ".class");
} else {
var2 = Paths.get(var0 + ".class");
}
//刷硬盘
Files.write(var2, var4, new OpenOption[0]);
return null;
} catch (IOException var4x) {
throw new InternalError("I/O exception saving generated file: " + var4x);
}
}
});
}
return var4;
}
返回之后我细看Proxy.newProxyInstance接口:
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
....省略部分代码
//生成一个Proxy Class
Class<?> cl = getProxyClass0(loader, intfs);
/*
* 使用指定的调用处理程序调用其构造函数
*/
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
//根据构造参数获取proxy class的构造函数
final Constructor<?> cons = cl.getConstructor(constructorParams);
final InvocationHandler ih = h;
if (!Modifier.isPublic(cl.getModifiers())) {
//假如proxy class的构造函数是private的，就使用反射来set accessible
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
cons.setAccessible(true);
return null;
}
});
}
//通过proxy class的构造行数生成一个代理对象object返回
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);
}
至此它就生成了一个可以使用的代理对象.可以看出jdk的动态代理中使用了大量的反射。
简单总结下,jdk动态代理会通过你所指定的接口(interfaces),InvocationHandler接口的实现类.动态的为你生成一个proxy对象。 有不少rpc,底层也是用了动态代理的.
#### aop
现在我们将CinemaInvocationHandler稍微改造一下:
public class CinemaProxy implements InvocationHandler {
private Cinema cinema;
public CinemaProxy(Cinema cinema) {
this.cinema = cinema;
}
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
if ("buy".equals(method.getName())) {
System.out.println("before");
System.out.println("这里是动态的淘票票,现在帮你购买电影票");
Object invoke = method.invoke(cinema, args);
System.out.println("after");
return invoke;
}
return null;
}
}
输出的结果:
before
这里是动态的淘票票,现在帮你购买电影票
这里是大地影城,欢迎购票
after
这个就是aop就基本的原理.当然spring aop的实现肯定不是这么简单的.而且spring aop不仅适用了jdk的动态代理.还使用了cglib.是因为jdk的动态代理是需要被代理的类实现接口(Cinema).如果没有实现这个Cinema接口jdk自带的动态代理就束手无策了.那怎么办呢？ 这时候就需要用到CGLIB.
CGLIB
(这里只是简单介绍下,源码级的今天实在没时间，有空补上)
首先,同样是有一个万达影城,但是它没有实现Cinema接口:
public class WdCGLIBCinema {
public void buy() {
System.out.println("这里是万达影城,欢迎购票");
}
}
那这种情况jdk的动态代理就束手无策了.这时候就需要用到cglib. cglib是使用ASM框架直接对字节码修改的.需要注意的是它是使用继承方式来实现.也就是说被代理的类不能是final的.
ASM 是一个 Java 字节码操控框架。它能够以二进制形式修改已有类或者动态生成类。ASM 可以直接产生二进制 class 文件，也可以在类被加载入 Java 虚拟机之前动态改变类行为。ASM 从类文件中读入信息后，能够改变类行为，分析类信息，甚至能够根据用户要求生成新类。
它实现代理的方式是实现一个MethodInterceptor接口:
public class CglibProxy implements MethodInterceptor {
public Object intercept(Object obj, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
System.out.println("这里是淘票票,现在帮你在电影院买票");
return methodProxy.invokeSuper(obj, objects);
}
}
所以现在代理的使用方式又换了:
public class WdCGLIBCinemaTest {
@Test
public void setBuy() {
Enhancer enhancer = new Enhancer();
enhancer.setSuperclass(WdCGLIBCinema.class);
enhancer.setCallback(new CglibProxy());
WdCGLIBCinema cinema= (WdCGLIBCinema)enhancer.create();
cinema.buy();
}
}
Enhancer可以指定代理类.以及回调类.然后调用create()方法代理对象.并将所有非final的方法传递给MethodInterceptor.intercept()方法.然后我们就可以在intercept()方法中加入任何我想要的逻辑了.比如日志.修改参数等。
