開心一刻html
週末,帶着老婆兒子一塊兒逛公園。兒子一我的跑在前面,吧唧一下不當心摔了一跤,腦殼瓜子摔了個包,稀里嘩啦的哭道:「爸爸,我會不會摔成傻子!」java
我指了指我頭上的傷痕安慰道:「不會的,你看,這是爸爸小時候摔的。」git
話尚未說話,小傢伙哭的更厲害了:「那就是說我長大後就會和你同樣傻了,我不要,我不要!」github
老婆忍不住發飆:「別哭了,你怎麼會變傻呢?你看你爸,你爸傻嗎?」web
我趕忙迴應道:「是啊,你看我多聰明!」spring
兒子:「真的,不騙我?」數據庫
老婆:「固然!」編程
兒子:「但是若是老爸不是傻子,當年怎麼會娶你這個母老虎呢?」設計模式
我、老婆:……數組
所謂代理,就是一我的或者一個機構表明另外一我的或者另外一個機構採起行動。在一些狀況下,一個客戶不想或者不能直接引用一個對象,而代理對象能夠在客戶端和目標對象之間起到中介的左右。
代理模式:給某一個對象提供一個代理或佔位符,並由代理對象來控制對原對象的訪問,經過代理對象訪問目標對象,這樣能夠在不修改原目標對象的前提下,提供額外的功能操做,擴展目標對象的功能。說簡單點,代理模式就是設置一箇中間代理來控制訪問原目標對象,以達到加強原對象的功能和簡化訪問方式。通常而言會分三種:靜態代理、動態代理和CGLIB代理
代理模式結構以下:
靜態代理須要代理對象和被代理對象實現同樣的接口,咱們來看個例子就清楚了
示例代理:static-proxy
代理類:UserDaoProxy.java
/** * 代理邏輯在代理類中,而不是由用戶自定義 */ public class UserDaoProxy implements IUserDao { private IUserDao target; // 被代理對象 public UserDaoProxy(IUserDao target) { this.target = target; } /** * 前置/後置 處理一旦寫完,就固定死了,後續想修改的話須要改此代理類 * @param id * @return */ public int delete(int id) { // 前置處理,例如開啓事務 System.out.println("前置處理..."); // 調用目標對象方法 int count = target.delete(id); // 後置處理,例如提交事務或事務回滾 System.out.println("前置處理..."); return count; } }
UserDaoProxy代理IUserDao類型,此時也只能代理IUserDao類型的被代理對象。測試結果就不展現了,相信你們看了代碼也知道了
優勢:能夠在不修改目標對象的前提下擴展目標對象的功能
缺點:若是須要代理多個類,每一個類都會有一個代理類,會致使代理類無限制擴展;若是類中有多個方法,一樣的代理邏輯須要反覆實現、應用到每一個方法上,一旦接口增長方法,目標對象與代理對象都要進行修改
一個靜態代理只能代理一個類,那麼有沒有什麼方式能夠實現同一個代理類來代理任意對象呢?確定有的,也就是下面講到的:動態代理
代理類在程序運行時建立的代理方式被成爲動態代理。 也就是說,這種狀況下,代理類並非在Java代碼中定義的,而是在運行時根據咱們在Java代碼中的「指示」動態生成的。下面咱們一步一步手動來實現動態代理。下面的示例都是直接針對接口的,就不是針對接口的具體實現類了,靜態代理示例中,UserDaoProxy代理的是IUserDao的實現類:UserDaoImpl,那麼動態代理示例就直接針對接口了,下面示例針對的都是UserMapper接口,模擬的mybatis,但不侷限於UserMapper接口
一、先利用反射動態生成代理類,並持久化代理類到磁盤(也就是生成代理類的java源文件),generateJavaFile方法以下
/** * 生成接口實現類的源代碼, 並持久化到java文件 * @param interface_ * @param proxyJavaFileDir * @throws Exception */ private static void generateJavaFile(Class<?> interface_, String proxyJavaFileDir) throws Exception { StringBuilder proxyJava = new StringBuilder(); proxyJava.append("package ").append(interface_.getPackage().getName()).append(";").append(ENTER).append(ENTER) .append("public class ").append(PROXY_CLASS_NAME).append(" implements ").append(interface_.getName()).append(" {"); Method[] methods = interface_.getMethods(); for(Method method : methods) { Type returnType = method.getGenericReturnType(); Type[] paramTypes = method.getGenericParameterTypes(); proxyJava.append(ENTER).append(ENTER).append(TAB_STR).append("@Override").append(ENTER) .append(TAB_STR).append("public ").append(returnType.getTypeName()).append(" ").append(method.getName()).append("("); for(int i=0; i<paramTypes.length; i++) { if (i != 0) { proxyJava.append(", "); } proxyJava.append(paramTypes[i].getTypeName()).append(" param").append(i); } proxyJava.append(") {").append(ENTER) .append(TAB_STR).append(TAB_STR) .append("System.out.println(\"數據庫操做, 並獲取執行結果...\");").append(ENTER); // 真正數據庫操做,會有返回值,下面的return返回應該是此返回值 if (!"void".equals(returnType.getTypeName())) { proxyJava.append(TAB_STR).append(TAB_STR).append("return null;").append(ENTER); // 這裏的"null"應該是上述中操做數據庫後的返回值,爲了演示寫成了null } proxyJava.append(TAB_STR).append("}").append(ENTER); } proxyJava .append("}"); // 寫入文件 File f = new File(proxyJavaFileDir + PROXY_CLASS_NAME + ".java"); FileWriter fw = new FileWriter(f); fw.write(proxyJava.toString()); fw.flush(); fw.close(); }
生成的代理類:$Proxy0.java 以下
package com.lee.mapper; public class $Proxy0 implements com.lee.mapper.UserMapper { @Override public java.lang.Integer save(com.lee.model.User param0) { System.out.println("數據庫操做, 並獲取執行結果..."); return null; } @Override public com.lee.model.User getUserById(java.lang.Integer param0) { System.out.println("數據庫操做, 並獲取執行結果..."); return null; } }
這個代理類的生成過程是咱們本身實現的,實現不難,但排版太繁瑣,咱們能夠用javapoet來生成代理類源代碼,generateJavaFileByJavaPoet方法以下
/** * 用JavaPoet生成接口實現類的源代碼,並持久化到java文件 * @param interface_ 目標接口類 * @return */ public static void generateJavaFileByJavaPoet(Class<?> interface_) throws Exception { // 類名、實現的接口,以及類訪問限定符 TypeSpec.Builder typeSpecBuilder = TypeSpec.classBuilder("JavaPoet$Proxy0") .addSuperinterface(interface_) .addModifiers(Modifier.PUBLIC); Method[] methods = interface_.getDeclaredMethods(); for (Method method : methods) { // 方法參數列表 List<ParameterSpec> paramList = new ArrayList<>(); Type[] paramTypes = method.getGenericParameterTypes(); int count = 1 ; for (Type param : paramTypes) { ParameterSpec paramSpec = ParameterSpec.builder(Class.forName(param.getTypeName()), "param" + count) .build(); count ++; paramList.add(paramSpec); } // 方法名、方法訪問限定符、參數列表、返回值、方法體等 Class<?> returnType = method.getReturnType(); MethodSpec.Builder builder = MethodSpec.methodBuilder(method.getName()) .addModifiers(Modifier.PUBLIC) .addParameters(paramList) .addAnnotation(Override.class) .returns(returnType) .addCode("\n") .addStatement("$T.out.println(\"數據庫操做, 並獲取執行結果...\")", System.class) // 真正數據庫操做,會有返回值,下面的return返回應該是此返回值 .addCode("\n"); if (!"void".equals(returnType.getName())) { builder.addStatement("return null"); // 這裏的"null"應該是上述中操做數據庫後的返回值,爲了演示寫成了null } MethodSpec methodSpec = builder.build(); typeSpecBuilder.addMethod(methodSpec); } JavaFile javaFile = JavaFile.builder(interface_.getPackage().getName(), typeSpecBuilder.build()).build(); javaFile.writeTo(new File(SRC_JAVA_PATH)); }
生成的代理類:JavaPoet$Proxy0.java 以下
package com.lee.mapper; import com.lee.model.User; import java.lang.Integer; import java.lang.Override; import java.lang.System; public class JavaPoet$Proxy0 implements UserMapper { @Override public Integer save(User param1) { System.out.println("數據庫操做, 並獲取執行結果..."); return null; } @Override public User getUserById(Integer param1) { System.out.println("數據庫操做, 並獲取執行結果..."); return null; } }
利用javapoet生成的代理類更接近咱們平時手動實現的類,排版更符合咱們的編碼習慣,看上去更天然一些;二者的實現過程是同樣的,只是javapoet排版更好
二、既然代理類的源代碼已經有了,那麼須要對其編譯了,compileJavaFile方法以下
/** * 編譯代理類源代碼生成代理類class * @param proxyJavaFileDir */ private static void compileJavaFile(String proxyJavaFileDir) throws Exception { JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); //得到文件管理者 StandardJavaFileManager manager = compiler.getStandardFileManager(null, null, null); Iterable<? extends JavaFileObject> fileObjects = manager.getJavaFileObjects(proxyJavaFileDir + PROXY_CLASS_NAME + ".java"); //編譯任務 JavaCompiler.CompilationTask task = compiler.getTask(null, manager, null, null, null, fileObjects); //開始編譯,執行完可在指定目錄下看到.class文件 task.call(); //關閉文件管理者 manager.close(); }
會在指定目錄下看到:$Proxy0.class
三、加載$Proxy0.class,並建立其實例對象(代理實例對象)
public static <T> T newInstance(Class<T> interface_) throws Exception{ String proxyJavaFileDir = SRC_JAVA_PATH + interface_.getPackage().getName().replace(".", File.separator) + File.separator; // 一、生成interface_接口的實現類,並持久化到磁盤:$Proxy0.java generateJavaFile(interface_, proxyJavaFileDir); // 二、編譯$Proxy0.java,生成$Proxy0.class到磁盤 compileJavaFile(proxyJavaFileDir); // 三、加載$Proxy0.class,並建立其實例對象(代理實例對象) MyClassLoader loader = new MyClassLoader(proxyJavaFileDir, interface_); Class<?> $Proxy0 = loader.findClass(PROXY_CLASS_NAME); return (T)$Proxy0.newInstance(); } private static class MyClassLoader<T> extends ClassLoader { private String proxyJavaFileDir; private Class<T> interface_; public MyClassLoader(String proxyJavaFileDir, Class<T> interface_) { this.proxyJavaFileDir = proxyJavaFileDir; this.interface_ = interface_; } @Override protected Class<?> findClass(String name) throws ClassNotFoundException { File clazzFile = new File(proxyJavaFileDir, name + ".class"); //若是字節碼文件存在 if (clazzFile.exists()) { //把字節碼文件加載到VM try { //文件流對接class文件 FileInputStream inputStream = new FileInputStream(clazzFile); ByteArrayOutputStream baos = new ByteArrayOutputStream(); byte[] buffer = new byte[1024]; int len; while ((len = inputStream.read(buffer)) != -1) { baos.write(buffer, 0, len); // 將buffer中的內容讀取到baos中的buffer } //將buffer中的字節讀到內存加載爲class return defineClass(interface_.getPackage().getName() + "." + name, baos.toByteArray(), 0, baos.size()); } catch (Exception e) { e.printStackTrace(); } } return super.findClass(name); } }
有了代理實例對象,咱們就能夠利用它進行操做了,演示結果以下
完整工程地址:proxy-java-file,完整流程圖以下
此時的Proxy類能建立任何接口的實例,解決了靜態代理存在的代理類氾濫、多個方法中代理邏輯反覆實現的問題;但有個問題不知道你們注意到:$Proxy0.java有必要持久化到磁盤嗎,咱們能不能直接編譯內存中的代理類的字符串源代碼,獲得$Proxy0.class呢?
$Proxy0.java和$Proxy0.class是不必生成到磁盤的,咱們直接編譯內存中的代理類的字符串源代碼,同時直接在內存中加載$Proxy0.class,不用寫、讀磁盤,能夠提高很多性能
完整工程地址:proxy-none-java-file,此時的流程圖以下
Proxy.java源代碼以下
package com.lee.proxy; import com.itranswarp.compiler.JavaStringCompiler; import java.lang.reflect.Method; import java.lang.reflect.Type; import java.util.Map; public class Proxy { private static final String ENTER = "\r\n"; private static final String TAB_STR = " "; private static final String PROXY_FILE_NAME = "$Proxy0"; /** * 生成接口實現類的源代碼, 並持久化到java文件 * @param interface_ * @throws Exception */ private static String generateJavaFile(Class<?> interface_) throws Exception { StringBuilder proxyJava = new StringBuilder(); proxyJava.append("package ").append(interface_.getPackage().getName()).append(";").append(ENTER).append(ENTER) .append("public class ").append(PROXY_FILE_NAME).append(" implements ").append(interface_.getName()).append(" {"); Method[] methods = interface_.getMethods(); for(Method method : methods) { Type returnType = method.getGenericReturnType(); Type[] paramTypes = method.getGenericParameterTypes(); proxyJava.append(ENTER).append(ENTER).append(TAB_STR).append("@Override").append(ENTER) .append(TAB_STR).append("public ").append(returnType.getTypeName()).append(" ").append(method.getName()).append("("); for(int i=0; i<paramTypes.length; i++) { if (i != 0) { proxyJava.append(", "); } proxyJava.append(paramTypes[i].getTypeName()).append(" param").append(i); } proxyJava.append(") {").append(ENTER) .append(TAB_STR).append(TAB_STR) .append("System.out.println(\"數據庫操做, 並獲取執行結果...\");").append(ENTER); // 真正數據庫操做,會有返回值,下面的return返回應該是此返回值 if (!"void".equals(returnType.getTypeName())) { proxyJava.append(TAB_STR).append(TAB_STR).append("return null;").append(ENTER); // 這裏的"null"應該是上述中操做數據庫後的返回值,爲了演示寫成了null } proxyJava.append(TAB_STR).append("}").append(ENTER); } proxyJava .append("}"); return proxyJava.toString(); } private final static Class<?> compile(String className, String content) throws Exception { JavaStringCompiler compiler = new JavaStringCompiler(); Map<String, byte[]> byteMap = compiler.compile(PROXY_FILE_NAME + ".java", content); Class<?> clazz = compiler.loadClass(className, byteMap); return clazz; } public static <T> T newInstance(Class<T> interface_) throws Exception{ // 一、生成源代碼字符串 String proxyCodeStr = generateJavaFile(interface_); // 二、字符串編譯成Class對象 Class<?> clz = compile(interface_.getPackage().getName() + "." + PROXY_FILE_NAME, proxyCodeStr); return (T)clz.newInstance(); } }
相比有代理類源代碼持久化,核心的動態代理生成過程不變,只是減小了.java和.class文件的持久化;其中用到了第三方工具:com.itranswarp.compile(咱們也能夠拓展jdk,實現內存中操做),完成了字符串在內存中的編譯、class在內存中的加載,直接用jdk的編譯工具,會在磁盤生成$Proxy0.class
測試結果以下
能夠看到,沒有.java和.class的持久化
此時就完美了嗎?若是如今有另一個接口ISendMessage,代理邏輯不是
System.out.println("數據庫操做, 並獲取執行結果...")
咱們該怎麼辦? 針對ISendMessage又從新寫一個Proxy?顯然還不夠靈活,說的簡單點:此種代理能夠代理任何接口,可是代理邏輯確是固定死的,不能自定義,這樣會形成一種代理邏輯會有一個代理工廠(Proxy),會形成代理工廠的泛濫
既然無代理類源代碼持久化中的代理邏輯不能自定義,那麼咱們就將它抽出來,提供代理邏輯接口
完整工程地址:proxy-none-java-file-plus,流程圖與無代理類源代碼持久化中同樣,此時代理類的生成過程複雜了很多,涉及到代理邏輯接口:InvacationHandler的處理
generateJavaFile(...)方法
/** * 生成接口實現類的源代碼 * @param interface_ * @throws Exception */ private static String generateJavaFile(Class<?> interface_, InvocationHandler handler) throws Exception { StringBuilder proxyJava = new StringBuilder(); proxyJava.append("package ").append(PROXY_PACKAGE_NAME).append(";").append(ENTER).append(ENTER) .append("import java.lang.reflect.Method;").append(ENTER).append(ENTER) .append("public class ").append(PROXY_FILE_NAME).append(" implements ").append(interface_.getName()).append(" {").append(ENTER) .append(ENTER).append(TAB_STR).append("private InvocationHandler handler;").append(ENTER).append(ENTER); // 代理對象構造方法 proxyJava.append(TAB_STR).append("public ").append(PROXY_FILE_NAME).append("(InvocationHandler handler) {").append(ENTER) .append(TAB_STR).append(TAB_STR).append("this.handler = handler;").append(ENTER) .append(TAB_STR).append("}").append(ENTER); // 接口方法 Method[] methods = interface_.getMethods(); for(Method method : methods) { String returnTypeName = method.getGenericReturnType().getTypeName(); Type[] paramTypes = method.getGenericParameterTypes(); proxyJava.append(ENTER).append(TAB_STR).append("@Override").append(ENTER) .append(TAB_STR).append("public ").append(returnTypeName).append(" ").append(method.getName()).append("("); List<String> paramList = new ArrayList<>(); // 方法參數值 List<String> paramTypeList = new ArrayList<>(); // 方法參數類型 for(int i=0; i<paramTypes.length; i++) { if (i != 0) { proxyJava.append(", "); } String typeName = paramTypes[i].getTypeName(); proxyJava.append(typeName).append(" param").append(i); paramList.add("param" + i); paramTypeList.add(typeName+".class"); } proxyJava.append(") {").append(ENTER) .append(TAB_STR).append(TAB_STR).append("try {").append(ENTER) .append(TAB_STR).append(TAB_STR).append(TAB_STR) .append("Method method = ").append(interface_.getName()).append(".class.getDeclaredMethod(\"") .append(method.getName()).append("\",").append(String.join(",", paramTypeList)).append(");") .append(ENTER).append(TAB_STR).append(TAB_STR).append(TAB_STR); if (!"void".equals(returnTypeName)) { proxyJava.append("return (").append(returnTypeName).append(")"); } proxyJava.append("handler.invoke(this, method, new Object[]{") .append(String.join(",", paramList)).append("});").append(ENTER) .append(TAB_STR).append(TAB_STR).append("} catch(Exception e) {").append(ENTER) .append(TAB_STR).append(TAB_STR).append(TAB_STR).append("e.printStackTrace();").append(ENTER) .append(TAB_STR).append(TAB_STR).append("}").append(ENTER); if (!"void".equals(returnTypeName)) { proxyJava.append(TAB_STR).append(TAB_STR).append("return null;").append(ENTER); } proxyJava.append(TAB_STR).append("}").append(ENTER); } proxyJava .append("}"); // 這裏能夠將字符串生成java文件,看看源代碼對不對 /*String proxyJavaFileDir = System.getProperty("user.dir") + File.separator + "proxy-none-java-file-plus" + String.join(File.separator, new String[]{"","src","main","java",""}) + PROXY_PACKAGE_NAME.replace(".", File.separator) + File.separator; File f = new File(proxyJavaFileDir + PROXY_FILE_NAME + ".java"); FileWriter fw = new FileWriter(f); fw.write(proxyJava.toString()); fw.flush(); fw.close();*/ return proxyJava.toString(); }
測試結果以下
此時各組件之間關係、調用狀況以下
此時Proxy就能夠徹底通用了,能夠生成任何接口的代理對象了,也能夠實現任意的代理邏輯;至此,咱們完成了一個簡易的仿JDK實現的動態代理
咱們來看看JDK下動態代理的實現,示例工程:proxy-jdk,測試結果就不展現了,咱們來看看JDK下Proxy.newInstance方法,有三個參數
一、Classloader:類加載器,咱們可使用自定義的類加載器;上述手動實現示例中,直接在Proxy寫死了;
二、Class<?>[]:接口類數組,這個其實很容易理解,咱們應該容許咱們本身實現的代理類同時實現多個接口。咱們上述手動實現中只傳入一個接口,是爲了簡化實現;
三、InvocationHandler:這個沒什麼好說的,與咱們的實現一致,用於自定義代理邏輯
咱們來追下源碼,看看JDK的動態代理是否與咱們的手動實現是否一致
與咱們的自定義實現差很少,利用反射,逐個接口、逐個方法進行處理;ProxyClassFactory負責生成代理類的Class對象,主要有apply方法負責,調用了
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(proxyName, interfaces, accessFlags);
來生成代理類的Class;ProxyGenerator中有個是有靜態常量:saveGeneratedFiles,標識是否持久化代理類的class文件,默認值是false,也就是不持久化,咱們能夠經過設置jdk系統參數,實現JDK的動態代理持久化代理類的class文件
對cglib不作深刻研究了,只舉個使用案例:proxy-cglib,使用方式與JDK的動態代理相似,實現的效果也基本一致,可是實現原理上仍是有差異的
JDK的動態代理有一個限制,就是使用動態代理的對象必須實現一個或多個接口,而CGLIB沒有這個限制,具體區別不是本文範疇了,你們自行去查閱資料
長篇大論講了那麼多,咱們卻一直沒有講動態代理的做用,使用動態代理咱們能夠在不改變源碼的狀況下,對目標對象的目標方法進行前置或後置加強處理。這有點不太符合咱們的一條線走到底的編程邏輯,這種編程模型有一個專業名稱叫AOP,面向切面編程,具體案例有以下:
一、spring的事務,事務的開啓能夠做爲前置加強,事務的提交或回滾做爲後置加強,數據庫的操做處在二者以前;
二、日誌記錄,咱們能夠在不改變原有實現的基礎上,對目標對象進行日誌的輸出,能夠前置處理,記錄參數狀況,也能夠後置處理,記錄返回的結果;
三、web編程,傳入參數的校驗;
四、web編程,權限的控制也能夠用aop來實現;
只要明白了AOP,那麼哪些場景能使用動態代理也就比較明瞭了
一、示例代碼中的Proxy是代理工廠,負責生產代理對象的,不是代理對象類
二、手動實現動態代理,咱們分了三版
初版:代理類源代碼持久化,爲了便於理解,咱們將代理類的java文件和class文件持久化到了磁盤,此時解決了靜態代理中代理類氾濫的問題,咱們的代理類工廠(Proxy)能代理任何接口;
第二版:代理類源代碼不持久化,代理類的java文件和和class文件原本就只是臨時文件,將其去掉,不用讀寫磁盤,能夠提升效率;但此時有個問題,咱們的代理邏輯卻寫死了,也就說一個代理類工廠只能生產一種代理邏輯的代理類對象,若是咱們有多種代理邏輯,那麼就須要有多個代理類工廠,顯然靈活性不夠高,還有優化空間;
第三版:代理邏輯接口化,供用戶自定義,此時代理類工廠就能夠代理任何接口、任何代理邏輯了,反正代理邏輯是用戶自定義傳入,用戶想怎麼定義就怎麼定義;
三、示例參考的是mybatis中mapper的生成過程,雖然只是簡單的模擬,但流程倒是一致的,有興趣的能夠看看我前兩篇博客,結合起來看更好理解
《java與模式》