上一篇学习了静态代理与动态代理的实现及业务场景应用,对代理模式有了初步认识,本篇将从源码的角度对代理模式进行深度剖析,加深对动态代理的理解,做到知其然,知其所以然。
手写 JDK 动态代理实现原理
既然知道了动态代理的强大,那么我们来研究一下原理,看看它是如何实现的?并模仿 JDK动态代理手写一个属于自己的动态代理。
我们都知道JDK 动态代理采用字节重组,重新生成对象来替代原始对象,以达到动态代理的目的。JDK 动态代理生成对象的步骤如下:
- 获取被代理对象的引用,并且获取它的所有接口,反射获取;
- JDK 动态代理类重新生成一个新的类,同时新的类要实现被代理类实现的所有接口;
- 动态生成 Java 代码,新加的业务逻辑方法由一定的逻辑代码调用(在代码中体现);
- 编译新生成的 Java 代码 .class 文件;
- 重新加载到 JVM 中运行;
以上过程就叫字节码重组。JDK 中有一个规范,在 ClassPath 下只要是$开头的.class 文件,一般都是自动生成的。那么我们有没有办法看到代替后的对象的“真容”呢?来做一个这样的测试,将内存中的对象字节码通过文件流输出到一个新的.class 文件,然后利用反编译工具进行查看源代码。
public static void main(String[] args) {
byte[] b = ProxyGenerator.generateProxyClass("$Proxy0", new Class[]{IPerson.class});
FileOutputStream os = null;
try {
os = new FileOutputStream("$Proxy0.class");
os.write(b);
os.close();
} catch (Exception e) {
e.printStackTrace();
}
}
运行代码,并找到$Proxy0.class文件,进行反编译查看,如下:
我们发现,新生成的代理对象,继承了 Proxy类,同时还实现了 IPerson接口,而且重写的了 findLove()方法。在静态块中利用反射查找到了目标对象的所有方法,而且保存了所有方法的引用,重写的方法利用反射调用目标方法对象。此时,小伙伴们肯定好奇,这些代码是哪里来的,其实是JDK 自动帮我们生成的。现在我们不依赖 JDK,自己来动态生成源代码、动态完成编译,然后替代目标对象并执行。
首先创建MyInvocationHandler接口:
public interface MyInvocationHandler {
Object invoke(Object proxy, Method method, Object[] args) throws Throwable;
}
创建自己的 MyClassLoader 类:
public class MyClassLoader extends ClassLoader {
private File classPathFile;
public MyClassLoader(){
String classPath = MyClassLoader.class.getResource("").getPath();
this.classPathFile = new File(classPath);
}
@Override
protected Class<?> findClass(String name) throws ClassNotFoundException {
String className = MyClassLoader.class.getPackage().getName() + "." + name;
if(classPathFile != null){
File classFile = new File(classPathFile,name.replaceAll("\\.","/") + ".class");
if(classFile.exists()){
FileInputStream in = null;
ByteArrayOutputStream out = null;
try{
in = new FileInputStream(classFile);
out = new ByteArrayOutputStream();
byte [] buff = new byte[1024];
int len;
while ((len = in.read(buff)) != -1){
out.write(buff,0,len);
}
return defineClass(className,out.toByteArray(),0,out.size());
}catch (Exception e){
e.printStackTrace();
}
}
}
return null;
}
}
创建生成代理类的工具类 MyProxy 类:
public class MyProxy {
public static final String ln = "\r\n";
public static Object newProxyInstance(MyClassLoader classLoader, Class<?>[] interfaces, MyInvocationHandler h) {
try {
//1、动态生成源代码.java文件
String src = generateSrc(interfaces);
//2、Java文件输出磁盘
String filePath = MyProxy.class.getResource("").getPath();
File f = new File(filePath + "$Proxy0.java");
FileWriter fw = new FileWriter(f);
fw.write(src);
fw.flush();
fw.close();
//3、把生成的.java文件编译成.class文件
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
StandardJavaFileManager manage = compiler.getStandardFileManager(null, null, null);
Iterable iterable = manage.getJavaFileObjects(f);
JavaCompiler.CompilationTask task = compiler.getTask(null, manage, null, null, null, iterable);
task.call();
manage.close();
//4、编译生成的.class文件加载到JVM中来
Class proxyClass = classLoader.findClass("$Proxy0");
Constructor c = proxyClass.getConstructor(MyInvocationHandler.class);
f.delete();
//5、返回字节码重组以后的新的代理对象
return c.newInstance(h);
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
/**
* 根据需要代理的接口,动态生成源文件
* @param interfaces
* @return
*/
private static String generateSrc(Class<?>[] interfaces) {
StringBuffer sb = new StringBuffer();
sb.append(MyProxy.class.getPackage() + ";" + ln);
sb.append("import " + interfaces[0].getName() + ";" + ln);
sb.append("import java.lang.reflect.*;" + ln);
//自定义生成的文件名字,暂且先叫它 $Proxy0
sb.append("public class $Proxy0 implements " + interfaces[0].getName() + "{" + ln);
sb.append("MyInvocationHandler h;" + ln);
sb.append("public $Proxy0(MyInvocationHandler h) { " + ln);
sb.append("this.h = h;");
sb.append("}" + ln);
for (Method m : interfaces[0].getMethods()) {
Class<?>[] params = m.getParameterTypes();
StringBuffer paramNames = new StringBuffer();
StringBuffer paramValues = new StringBuffer();
StringBuffer paramClasses = new StringBuffer();
for (int i = 0; i < params.length; i++) {
Class clazz = params[i];
String type = clazz.getName();
String paramName = toLowerFirstCase(clazz.getSimpleName());
paramNames.append(type + " " + paramName);
paramValues.append(paramName);
paramClasses.append(clazz.getName() + ".class");
if (i > 0 && i < params.length - 1) {
paramNames.append(",");
paramClasses.append(",");
paramValues.append(",");
}
}
sb.append("public " + m.getReturnType().getName() + " " + m.getName() + "(" + paramNames.toString() + ") {" + ln);
sb.append("try{" + ln);
sb.append("Method m = " + interfaces[0].getName() + ".class.getMethod(\"" + m.getName() + "\",new Class[]{" + paramClasses.toString() + "});" + ln);
sb.append((hasReturnValue(m.getReturnType()) ? "return " : "") + getCaseCode("this.h.invoke(this,m,new Object[]{" + paramValues + "})", m.getReturnType()) + ";" + ln);
sb.append("}catch(Error _ex) { }");
sb.append("catch(Throwable e){" + ln);
sb.append("throw new UndeclaredThrowableException(e);" + ln);
sb.append("}");
sb.append(getReturnEmptyCode(m.getReturnType()));
sb.append("}");
}
sb.append("}" + ln);
return sb.toString();
}
private static Map<Class, Class> mappings = new HashMap<Class, Class>();
static {
mappings.put(int.class, Integer.class);
}
private static String getReturnEmptyCode(Class<?> returnClass) {
if (mappings.containsKey(returnClass)) {
return "return 0;";
} else if (returnClass == void.class) {
return "";
} else {
return "return null;";
}
}
private static String getCaseCode(String code, Class<?> returnClass) {
if (mappings.containsKey(returnClass)) {
return "((" + mappings.get(returnClass).getName() + ")" + code + ")." + returnClass.getSimpleName() + "Value()";
}
return code;
}
private static boolean hasReturnValue(Class<?> clazz) {
return clazz != void.class;
}
/**
* 首字母小写
* @param src
* @return
*/
private static String toLowerFirstCase(String src) {
char[] chars = src.toCharArray();
chars[0] += 32;
return String.valueOf(chars);
}
}
创建 MyMeipo 类,实现自己刚才写的MyInvocationHandler接口:
public class MyMeipo implements MyInvocationHandler {
private IPerson target;
public IPerson getInstance(IPerson target){
this.target = target;
Class<?> clazz = target.getClass();
return (IPerson) MyProxy.newProxyInstance(new MyClassLoader(),clazz.getInterfaces(),this);
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
before();
Object result = method.invoke(this.target,args);
after();
return result;
}
private void after() {
System.out.println("双方同意,开始交往");
}
private void before() {
System.out.println("我是媒婆,已经收集到你的需求,开始物色");
}
}
测试代码:
public static void main(String[] args) {
MyMeipo myProxyMeipo = new MyMeipo();
IPerson zhangsan = myProxyMeipo.getInstance(new Zhangsan());
zhangsan.findLove();
}
至此,完成了我们自己定义的仿 JDK 动态代理源码。
CGLib代理调用API 及原理分析
简单看一下CGLib代理的使用,还是以媒婆为例,创建CglibMeipo 类:
public class CGlibMeipo implements MethodInterceptor {
public Object getInstance(Class<?> clazz) throws Exception {
//相当于Proxy,代理的工具类
Enhancer enhancer = new Enhancer();
enhancer.setSuperclass(clazz);
enhancer.setCallback(this);
return enhancer.create();
}
@Override
public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
before();
Object obj = methodProxy.invokeSuper(o, objects);
after();
return obj;
}
private void before() {
System.out.println("我是媒婆,我要给你找对象,现在已经确认你的需求");
System.out.println("开始物色");
}
private void after() {
System.out.println("OK的话,准备办事");
}
}
创建单身客户类:
public class Customer {
public void findLove(){
System.out.println("肤白貌美大长腿");
}
}
有个小细节,不知道小伙伴们有没有发现,CGLib代理的对象不需要实现任何接口,它是通过继承目标对象实现动态代理的。下面来看测试代码:
public static void main(String[] args) {
try {
Customer obj = (Customer) new CGlibMeipo().getInstance(Customer.class);
System.out.println(obj);
obj.findLove();
} catch (Exception e) {
e.printStackTrace();
}
}
CGLib代理的实现原理又是怎样的呢?我们依然采用将代理后的.class 文件输出,进行反编译查看,一探究竟:
public static void main(String[] args) {
//利用CGLib的代理类可以将内存中的.class 文件写入本地磁盘
System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY,"cglib_proxy_classes");
}
执行后发现,在cglib_proxy_classes 文件夹下多了三个.class 文件:
经过调试跟踪发现,CustomerEnhancerByCGLIB$$dce8aedb就是 CGLib代理生成的代理类,继承了Customer类。
CGLib代理执行代理方法的效率之所以比 JDK 高,是因为CGLib采用了FastClass机制,它的原理简单来说就是:为代理类和被代理类各生成一个类,这个类会为代理类或被代理类的方法分配一个index(int 类型);这个 index当做一个入参,FastClass就可以直接定位到要调用的的方法并直接进行调用,省去了反射调用,所以调用效率比JDK 代理通过反射调用高。
CGLib 和 JDK 动态代理对比
- JDK 代理实现了被代理类对象的接口,CGLib 代理继承了被代理类;
- JDK动态代理和 CGLib代理都在运行期生成字节码,JDK 动态代理直接写Class字节码,CGLib代理使用 ASM框架写Class字节码,CGLib 代理实现更复杂,生成代理类比 JDK动态代理效率低;
- JDK 动态代理调用代理方法是通过反射机制调用,CGLib 代理是通过 FastClass机制直接调用方法,CGLib 代理的执行效率更高
代理模式于 Spring 生态
代理模式在 Spring 中的应用
Spring 利用动态代理实现的AOP时有两个非常重要的类:JdkDynamicAopProxy和CglibAopProxy,看一下类图:
Spring 中的代理选择原则
- 当 Bean 有实现接口时,Spring 会选择 JDK 动态代理;
- 当 Bean 没有接口时,Spring 会选择 CGLib 动态代理;
- Spring 可以通过配置强制使用 CGLib动态代理,只需要在Spring 的配置文件中加入如下代码:
<aop:aspectj-autoproxy proxy-target-class="true"/>
静态代理和动态代理的本质区别
- 静态代理只能通过手动完成代理操作,如果被代理类增加了新的方法,代理类需要同步修改,违背开闭原则;
- 动态代理采用在运行时动态生成代码的方法,取消了被代理类的扩展限制,遵循开闭原则;
- 若动态代理要对目标类的增强逻辑进行扩展,结合策略模式,只需要新增策略类便可完成,无须修改代理类的代码。
代理模式的优缺点
代理模式具有以下优点:
- 代理模式能将代理对象与真实被调用目标对象分离;
- 在一定程度上降低了系统的耦合性,扩展性好;
- 可以起到保护目标对象的作用;
- 可以增强目标对象的功能;
当然也有其缺点:
- 代理模式会造成系统设计中类的数量增加;
- 在客户端和目标对象中增加一个代理对象,会导致请求处理速度变慢;
- 增加了系统的复杂度。
上一篇: 代理模式-上篇 https://blog.csdn.net/qq_20315217/article/details/114294246
下一篇: 门面模式