手写Java动态代理

博客内容来自笔者微信公众号。

动态代理又包括JDK代理和CGLIB代理。
MyBatis框架就用到了动态代理技术，我们只关心Dao接口，而无需关心实现类。

动态代理功能十分强大，今天记录一下本人手动实现动态代理的过程。

分析

要如何对一个类对象进行代理呢？

首先当然是要分析被代理对象，解析它的方法，然后动态的生成一个子类，对父类方法进行重写。
拦截方法，将方法的运行交给代理对象去完成，然后在代理对象中对方法进行增强。

设计到的知识点：反射、类加载器、动态生成类、编译类、加载类。

实现步骤

分析过后，有一个清晰的思路，接下来一步一步慢慢实现。

1、编写被代理类 Person

要想代理类，首先得有被代理的类。
简单写一个Person类，它会说“hello”。

/*** @Description: 被代理类 人类*/
public class Person {public void sayHello(){System.out.println("hello");}
}

2、代理接口 CustomProxy

要对类进行代理，必须创建代理对象。
但是代理对象必须满足一定的规范，所以必须编写代理接口，以对代理类的行为进行约束。

/*** @Description: 自定义代理接口*/
public interface CustomProxy {//对方法进行拦截、增强Object intercept(Object o, Method method, Object... objects);
}

3、代理类 PersonProxy

有了代理接口，接下来创建一个代理实现类。

/*** @Description: Person的代理实现类*/
public class PersonProxy implements CustomProxy {@Overridepublic Object intercept(Object o, Method method, Object... objects)  {System.out.println("前置增强");Object invoke = null;try {invoke = method.invoke(o, objects);} catch (Exception e) {e.printStackTrace();}System.out.println("后置增强");return invoke;}
}

4、类加载器 MyClassLoader

我们需要手动生成代理类，并将其加载到JVM中，所以需要编写自定义的类加载器。
根据生成的class文件路径来加载即可。

/*** @Description: 自定义类加载器*/
public class MyClassLoader extends ClassLoader {//路径目录private String dir;//包名private String packageName;public void setDir(String dir) {this.dir = dir;}public void setPackageName(String packageName) {this.packageName = packageName;}@Overrideprotected Class<?> findClass(String name) {File file = new File(dir, name + ".class");byte[] bytes = FileUtil.readBytes(file);return defineClass(packageName + "." + name, bytes, 0, bytes.length);}
}

5、重头戏 Proxy

所有的核心代码都在Proxy类中.
Proxy会手动生成代理类，并将其加载到JVM中，创建实例并与被代理对象关联。

/*** @Description: 核心类*/
public class Proxy {//目标类private Class target;//代理对象private CustomProxy customProxy;//生成的类的路径private final static String DIR = "/Users/panchanghe/temp/aa";//生成的类的包名private final static String PACKAGE_NAME = "com.ch.proxy";private final static String PROXY_FIELD = "proxy";private final static String PROXY_TARGET = "target";private final static String R = "\r";//生成的代理类private Class proxyClass;public void setTarget(Class target) {this.target = target;}public void setCustomProxy(CustomProxy customProxy) {this.customProxy = customProxy;}/*** 生成代理对象* @param loader* @return* @throws Exception*/public Object create(MyClassLoader loader) throws Exception {Object proxy;if (proxyClass != null) {//如果类已经加载到JVM就直接实例化proxy = proxyClass.newInstance();initProxy(proxy);return proxy;}//类还未加载，则构建类proxy = buildProxyClass(loader);initProxy(proxy);return proxy;}/*** 初始化代理对象* @param proxy* @throws Exception*/private void initProxy(Object proxy) throws Exception {proxy.getClass().getDeclaredField(PROXY_FIELD).set(proxy, customProxy);proxy.getClass().getDeclaredField(PROXY_TARGET).set(proxy, target.newInstance());}/*** 构建代理类* @param loader* @return* @throws IllegalAccessException* @throws InstantiationException*/private Object buildProxyClass(MyClassLoader loader) throws IllegalAccessException, InstantiationException {loader.setDir(DIR);loader.setPackageName(PACKAGE_NAME);//生成动态代理类名String cName = target.getSimpleName() + "Proxy$$" + Integer.toHexString(target.hashCode());StringBuffer sb = new StringBuffer();sb.append("package " + PACKAGE_NAME + ";").append("import " + target.getName() + ";").append("import " + customProxy.getClass().getName() + ";").append("import java.lang.reflect.Method;").append("public class " + cName + " extends " + target.getSimpleName() + "{").append("public " + customProxy.getClass().getSimpleName() + " proxy;").append("public Object target;");//解析被代理对象的方法Method[] methods = target.getMethods();for (Method method : methods) {//final修饰的无法被代理if (Modifier.isFinal(method.getModifiers())) {continue;}String returnTypeName = method.getReturnType().getSimpleName();sb.append("@Override" + R);sb.append("public "+returnTypeName+" "+method.getName()+"(");Class<?>[] parameterTypes = method.getParameterTypes();if (parameterTypes.length > 0) {for (Class<?> type : method.getParameterTypes()) {sb.append(type.getSimpleName() + " " + type.getSimpleName()+System.currentTimeMillis() + ",");}sb.setLength(sb.length() - 1);}sb.append("){");if (method.getReturnType() != void.class) {sb.append("return (" + returnTypeName + ") ");}sb.append("proxy.intercept(target,");sb.append( "getMethod(\""+method.getName()+"\",");for (Class<?> type : method.getParameterTypes()) {sb.append(type.getSimpleName() + ".class" + ",");}sb.setLength(sb.length() - 1);sb.append("));}");}sb.append("private Method getMethod(String name, Class... parameters) {try {return Person.class.getMethod(name, parameters);} catch (NoSuchMethodException e) {return null;}}}");String filePath = DIR+File.separator+cName+".java";File file = new File(filePath);//编译类compile(sb.toString(), file);//加载类到JVMproxyClass = loader.findClass(cName);return proxyClass.newInstance();}/*** 编译类* @param classContent* @param file*/private void compile(String classContent, File file) {FileUtil.writeString(classContent, file, Charset.defaultCharset());JavaCompiler javaCompiler = ToolProvider.getSystemJavaCompiler();StandardJavaFileManager standardFileManager = javaCompiler.getStandardFileManager(null, null, null);Iterable<? extends JavaFileObject> javaFileObjects = standardFileManager.getJavaFileObjects(file);JavaCompiler.CompilationTask task = javaCompiler.getTask(null, standardFileManager, null, null, null, javaFileObjects);task.call();try {standardFileManager.close();} catch (IOException e) {e.printStackTrace();}}
}

干货全在Proxy类中，理解了这个类就基本懂了。
动态代理到这里就算全部完成了。

6、客户端测试

测试一下代理是否生效。

/*** @Description: 客户端测试*/
public class Client {public static void main(String[] args) throws Exception {Proxy proxy = new Proxy();//设置要代理的类proxy.setTarget(Person.class);//设置自定义代理proxy.setCustomProxy(new PersonProxy());//生成代理对象Person person = (Person) proxy.create(new MyClassLoader());person.sayHello();System.out.println(person.getClass().getName());}
}输出如下：
前置增强
hello
后置增强
com.ch.proxy.PersonProxy$$66d3c617

可以看到，代理生效了。
通过打印类名可以看到，返回的不是item11.custom.Person类，
而是Proxy动态生成的com.ch.proxy.PersonProxy$$66d3c617类。

动态生成的代理类对于客户端来说是透明的，客户端无需关心实际的类是什么，只关心返回的对象可以在原有对象的基础上，对方法进行intercept()增强即可。

查看源文件

打开"/Users/panchanghe/temp/aa"，可以看到Proxy生成的类文件。
我们稍微看一下。

package com.ch.proxy;import item11.custom.Person;
import item11.custom.PersonProxy;
import java.lang.reflect.Method;public class PersonProxy$$66d3c617 extends Person {public PersonProxy proxy;public Object target;public PersonProxy$$66d3c617() {}public void sayHello() {this.proxy.intercept(this.target, this.getMethod("sayHello"), new Object[0]);}public boolean equals(Object var1) {return (Boolean)this.proxy.intercept(this.target, this.getMethod("equals", Object.class), new Object[0]);}public String toString() {return (String)this.proxy.intercept(this.target, this.getMethod("toString"), new Object[0]);}public int hashCode() {return (Integer)this.proxy.intercept(this.target, this.getMethod("hashCode"), new Object[0]);}private Method getMethod(String var1, Class... var2) {try {return Person.class.getMethod(var1, var2);} catch (NoSuchMethodException var4) {return null;}}
}

生成的类其实与普通的Java类无异，重要的是理解代理的思想，以及如何生成类并把它加载到JVM中。