動態代理
代理模式是設計模式中非常重要的一種型別，而設計模式又是程式設計中非常重要的知識點，特別是在業務系統的重構中，更是有舉足輕重的地位。代理模式從型別上來說，可以分為靜態代理和動態代理兩種型別。
在解釋動態代理之前我們先理解一下靜態代理：
首先你要明白靜態代理的作用
我們有一個字型提供類，有多種實現（從磁碟，從網路，從系統）
public interface FontProvider {
Font getFont(String name);
}
public abstract class ProviderFactory {
public static FontProvider getFontProvider() {
return new FontProviderFromDisk();
}
}
public class Main() {
public static void main(String[] args) {
FontProvider fontProvider = ProviderFactory.getFontProvider();
Font font = fontProvider.getFont("微軟雅黑");
......
}
}
複製程式碼現在我們希望給他加上一個快取功能，我們可以用靜態代理來完成
public class CachedFontProvider implements FontProvider {
private FontProvider fontProvider;
private Map<String, Font> cached;
public CachedFontProvider(FontProvider fontProvider) {
this.fontProvider = fontProvider;
}
public Font getFont(String name) {
Font font = cached.get(name);
if (font == null) {
font = fontProvider.getFont(name);
cached.put(name, font);
}
return font;
}
}
/* 對工廠類進行相應修改，程式碼使用處不必進行任何修改。
這也是面向介面程式設計以及工廠模式的一個好處 */
public abstract class ProviderFactory {
public static FontProvider getFontProvider() {
return new CachedFontProvider(new FontProviderFromDisk());
}
}
複製程式碼當然，我們直接修改FontProviderFromDisk類也可以實現目的，但是我們還有FontProviderFromNet, FontProviderFromSystem等多種實現類，一一修改太過繁瑣且易出錯。況且將來還可能新增日誌，許可權檢查，異常處理等功能顯然用代理類更好一點。
然而今天的重點是：我們都知道牛逼轟轟的Spring AOP的實現的一種方式是使用JDK的動態代理（另一種是cglib），大部分人也會用jdk的動態代理，不過沒有研究過jdk的動態代理到底是怎麼實現的。今天就來揭開他的神祕面紗；
1. 原理原始碼剖析
首先我們先來講一下JDK動態代理的實現原理
1.拿到被代理物件的引用，然後獲取他的介面
2.JDK代理重新生成一個類，同時實現我們給的代理物件所實現的介面
3.把被代理物件的引用拿到了
4.重新動態生成一個class位元組碼
5.然後編譯
然後先實現一個動態代理，程式碼很簡單了，就是實現java.lang.reflect.InvocationHandler介面，並使用java.lang.reflect.Proxy.newProxyInstance()方法生成代理物件
/**
* @author mark
* @date 2018/3/30
*/
public class JdkInvocationHandler implements InvocationHandler {
private ProductService target;
public Object getInstance(ProductService target){
this.target = target;
Class clazz = this.target.getClass();
// 引數1：被代理類的類載入器 引數2:被代理類的介面 引數3
return Proxy.newProxyInstance(clazz.getClassLoader(),
clazz.getInterfaces(),
this);
}
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd");
String currentDate = simpleDateFormat.format(new Date());
System.out.println("日期【"+currentDate + "】新增了一款產品");
return method.invoke(this.target,args);
}
}
複製程式碼被代理介面和實現
/**
* 模仿產品Service
* @author mark
* @date 2018-03-30
*/
public interface ProductService {
/**
* 新增產品
* @param productName
*/
void addProduct(String productName);
}
/**
* @author mark
* @date 2018/3/30
*/
public class ProductServiceImpl implements ProductService{
public void addProduct(String productName) {
System.out.println("正在新增"+productName);
}
}
複製程式碼測試類
public class Test {
public static void main(String[] args) throws Exception {
ProductService productService = new ProductServiceImpl();
ProductService proxy = (ProductService) new JdkInvocationHandler().getInstance(productService);
proxy.addProduct("iphone");
// 這裡我們將jdk生成的代理類輸出了出來，方便後面分析使用
byte[] bytes = ProxyGenerator.generateProxyClass("$Proxy0",new Class[]{productService.getClass()});
FileOutputStream os = new FileOutputStream("Proxy0.class");
os.write(bytes);
os.close();
}
}
複製程式碼結果輸出
日期【2018-03-30】新增了一款產品
正在新增iphone
Process finished with exit code 0
複製程式碼上面我們實現動態動態代理的時候輸出了代理類的位元組碼檔案，現在來看一下位元組碼檔案反編譯過後的內容
import com.gwf.jdkproxy.ProductServiceImpl;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
// 繼承了Proxy類
public final class $Proxy0 extends Proxy implements ProductServiceImpl {
private static Method m1;
private static Method m8;
private static Method m2;
private static Method m3;
private static Method m5;
private static Method m4;
private static Method m7;
private static Method m9;
private static Method m0;
private static Method m6;
public $Proxy0(InvocationHandler var1) throws {
super(var1);
}
....
....
/**
* 這裡是代理類實現的被代理物件的介面的相同方法
*/
public final void addProduct(String var1) throws {
try {
// super.h 對應的是父類的h變數，他就是Proxy.nexInstance方法中的InvocationHandler引數
// 所以這裡實際上就是使用了我們自己寫的InvocationHandler實現類的invoke方法
super.h.invoke(this, m3, new Object[]{var1});
} catch (RuntimeException | Error var3) {
throw var3;
} catch (Throwable var4) {
throw new UndeclaredThrowableException(var4);
}
}
public final Class getClass() throws {
try {
return (Class)super.h.invoke(this, m7, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
....
....
// 在靜態構造塊中，代理類通過反射獲取了被代理類的詳細資訊，比如各種方法
static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
m8 = Class.forName("com.gwf.jdkproxy.ProductServiceImpl").getMethod("notify");
m2 = Class.forName("java.lang.Object").getMethod("toString");
m3 = Class.forName("com.gwf.jdkproxy.ProductServiceImpl").getMethod("addProduct", Class.forName("java.lang.String"));
m5 = Class.forName("com.gwf.jdkproxy.ProductServiceImpl").getMethod("wait", Long.TYPE);
m4 = Class.forName("com.gwf.jdkproxy.ProductServiceImpl").getMethod("wait", Long.TYPE, Integer.TYPE);
m7 = Class.forName("com.gwf.jdkproxy.ProductServiceImpl").getMethod("getClass");
m9 = Class.forName("com.gwf.jdkproxy.ProductServiceImpl").getMethod("notifyAll");
m0 = Class.forName("java.lang.Object").getMethod("hashCode");
m6 = Class.forName("com.gwf.jdkproxy.ProductServiceImpl").getMethod("wait");
} catch (NoSuchMethodException var2) {
throw new NoSuchMethodError(var2.getMessage());
} catch (ClassNotFoundException var3) {
throw new NoClassDefFoundError(var3.getMessage());
}
}
}
複製程式碼補充一下上面代母註釋中的super.h
protected InvocationHandler h;
protected Proxy(InvocationHandler h) {
Objects.requireNonNull(h);
this.h = h;
}
// 這個方法是Proxy的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<?> 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;
}
});
}
// 重點看這裡，將我們傳來的InvocationHandler引數穿給了建構函式
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動態代理的內部實現過程，最後再次將上面的原理宣告一遍，強化記憶
1.拿到被代理物件的引用，然後獲取他的介面 (Proxy.getInstance方法)
2.JDK代理重新生成一個類，同時實現我們給的代理物件所實現的介面 （上面的反編譯檔案中實現了同樣的介面）
3.把被代理物件的引用拿到了（上面被代理物件中在靜態程式碼塊中通過反射獲取到的資訊，以及我們實現的JdkInvocationHandler中的target）
4.重新動態生成一個class位元組碼
5.然後編譯
2.自己手寫一個動態代理
（宣告：本程式碼只用作例項，很多細節沒有考慮進去，比如，多介面的代理類，Object類的其他預設方法的代理，為確保原汁原味，一些模板引擎和commons工具類也沒有使用；覺得不足的老鐵們可以隨意完善，記得評論區留言完善方法哦）
我們使用jdk代理的類名和方法名定義，已經執行思路，但是所有的實現都自己來寫；
首先先定義出類結構
/**
* 自定義類載入器
* @author gaowenfeng
* @date 2018/3/30
*/
public class MyClassLoader extends ClassLoader {
/**
* 通過類名稱載入類位元組碼檔案到JVM中
* @param name 類名
* @return 類的Class獨享
* @throws ClassNotFoundException
*/
@Override
protected Class<?> findClass(String name) throws ClassNotFoundException {
return super.findClass(name);
}
}
複製程式碼/**
* @desc 自己實現的代理類，用來生成位元組碼檔案，並動態載入到JVM中
* @author gaowenfeng
* @date 2018/3/30
*/
public class MyProxy {
/**
* 生成代理物件
* @param loader 類載入器，用於載入被代理類的類檔案
* @param interfaces 被代理類的介面
* @param h 自定義的InvocationHandler介面,用於具體代理方法的執行
* @return 返回被代理後的代理物件
* @throws IllegalArgumentException
*/
public static Object newProxyInstance(MyClassLoader loader,
Class<?>[] interfaces,
MyInvocationHandler h)
throws IllegalArgumentException{
/**
* 1.生成代理類的原始碼
* 2.將生成的原始碼輸出到磁碟，儲存為.java檔案
* 3.編譯原始碼，並生成.java檔案
* 4.將class檔案中的內容，動態載入到JVM中
* 5.返回被代理後的代理物件
*/
return null;
}
}
複製程式碼/**
* 自定義類載入器
* @author gaowenfeng
* @date 2018/3/30
*/
public class MyClassLoader extends ClassLoader {
/**
* 通過類名稱載入類位元組碼檔案到JVM中
* @param name 類名
* @return 類的Class獨享
* @throws ClassNotFoundException
*/
@Override
protected Class<?> findClass(String name) throws ClassNotFoundException {
return super.findClass(name);
}
}
複製程式碼/**
* @author gaowenfeng
* @date 2018/3/30
*/
public class CustomInvocationHandler implements MyInvocationHandler {
private ProductService target;
public Object getInstance(ProductService target){
this.target = target;
Class clazz = this.target.getClass();
// 引數1：被代理類的類載入器 引數2:被代理類的介面 引數3
// 這裡的MyClassLoader先用new的方式保證編譯不報錯，後面會修改
return MyProxy.newProxyInstance(new MyClassLoader(),
clazz.getInterfaces(),
this);
}
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd");
String currentDate = simpleDateFormat.format(new Date());
System.out.println("日期【"+currentDate + "】新增了一款產品");
return method.invoke(this.target,args);
}
}
複製程式碼接下來我們來按照步驟一步一步的完善我們的類
生成代理類的原始檔
/**
* 生成代理類的原始碼
* @return
*/
private static String genSesource(Class<?> interfaces){
StringBuilder src = new StringBuilder();
src.append("package com.gwf.custom;").append(ln)
.append("import java.lang.reflect.Method;").append(ln)
.append("public class $Proxy0 implements ").append(interfaces.getName()).append("{").append(ln)
.append("private MyInvocationHandler h;").append(ln)
.append("public $Proxy0(MyInvocationHandler h){").append(ln)
.append("this.h=h;").append(ln)
.append("}").append(ln);
for(Method method:interfaces.getMethods()){
src.append("public ").append(method.getReturnType()).append(" ").append(method.getName()).append("() {").append(ln)
.append("try {").append(ln)
.append("Method m = ").append(interfaces.getName()).append(".class.getMethod(\"").append(method.getName()).append("\");").append(ln)
.append("this.h.invoke(this, m, new Object[]{});").append(ln)
.append("}catch (Throwable e){").append(ln)
.append("e.printStackTrace();").append(ln)
.append("}").append(ln)
.append("}").append(ln);
}
src.append("}");
return src.toString();
}
複製程式碼2.將原始檔儲存到本地
// 1.生成代理類的原始碼
String src = genSesource(interfaces);
// 2.將生成的原始碼輸出到磁碟，儲存為.java檔案
String path = MyProxy.class.getResource("").getPath();
File file = new File(path+"$Proxy0.java");
FileWriter fw = new FileWriter(file);
fw.write(src);
fw.close();
複製程式碼3.編譯原始碼，並生成.java檔案
// 3.編譯原始碼，並生成.java檔案
// 獲取java編譯器
JavaCompiler javaCompiler = ToolProvider.getSystemJavaCompiler();
// 標註java檔案管理器，用來獲取java位元組碼檔案
StandardJavaFileManager manager = javaCompiler.getStandardFileManager(null,null,null);
Iterable iterable = manager.getJavaFileObjects(file);
// 建立task，通過java位元組碼檔案將類資訊載入到JVM中
JavaCompiler.CompilationTask task = javaCompiler.getTask(null,manager,null,null,null,iterable);
// 開始執行task
task.call();
// 關閉管理器
manager.close();
複製程式碼4.將class檔案中的內容，動態載入到JVM中
public class MyClassLoader extends ClassLoader {
private String baseDir;
public MyClassLoader(){
this.baseDir = MyClassLoader.class.getResource("").getPath();
}
/**
* 通過類名稱載入類位元組碼檔案到JVM中
* @param name 類名
* @return 類的Class獨享
* @throws ClassNotFoundException
*/
@Override
protected Class<?> findClass(String name) throws ClassNotFoundException {
// 獲取類名
String className = MyClassLoader.class.getPackage().getName()+"."+name;
if(null == baseDir) {
throw new ClassNotFoundException();
}
// 獲取類檔案
File file = new File(baseDir,name+".class");
if(!file.exists()){
throw new ClassNotFoundException();
}
// 將類檔案轉換為位元組陣列
try(
FileInputStream in = new FileInputStream(file);
ByteArrayOutputStream out = new ByteArrayOutputStream();
){
byte[] buffer = new byte[1024];
int len;
while ((len = in.read(buffer))!=-1){
out.write(buffer,0,len);
}
// 呼叫父類方法生成class例項
return defineClass(className,out.toByteArray(),0,out.size());
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
return null;
}
複製程式碼5.返回被代理後的代理物件
Constructor c = proxyClass.getConstructor(MyInvocationHandler.class);
return c.newInstance(h);
複製程式碼最後看一下總體的MyProxy類 的 newProxyInstance方法
public static Object newProxyInstance(MyClassLoader loader,
Class<?> interfaces,
MyInvocationHandler h)
throws IllegalArgumentException{
/**
* 1.生成代理類的原始碼
* 2.將生成的原始碼輸出到磁碟，儲存為.java檔案
* 3.編譯原始碼，並生成.java檔案
* 4.將class檔案中的內容，動態載入到JVM中
* 5.返回被代理後的代理物件
*/
try {
// 1.生成代理類的原始碼
String src = genSesource(interfaces);
// 2.將生成的原始碼輸出到磁碟，儲存為.java檔案
String path = MyProxy.class.getResource("").getPath();
File file = new File(path+"$Proxy0.java");
FileWriter fw = new FileWriter(file);
fw.write(src);
fw.close();
// 3.編譯原始碼，並生成.java檔案
JavaCompiler javaCompiler = ToolProvider.getSystemJavaCompiler();
StandardJavaFileManager manager = javaCompiler.getStandardFileManager(null,null,null);
Iterable iterable = manager.getJavaFileObjects(file);
JavaCompiler.CompilationTask task = javaCompiler.getTask(null,manager,null,null,null,iterable);
task.call();
manager.close();
// 4.將class檔案中的內容，動態載入到JVM中
Class proxyClass = loader.findClass("$Proxy0");
// 5.返回被代理後的代理物件
Constructor c = proxyClass.getConstructor(MyInvocationHandler.class);
return c.newInstance(h);
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
複製程式碼激動人心的時刻：測試執行
public class CustomClient {
public static void main(String[] args){
ProductService productService = new ProductServiceImpl();
ProductService proxy = (ProductService) new CustomInvocationHandler().getInstance(productService);
proxy.addProduct();
}
}
複製程式碼執行結果
日期【2018-03-30】新增了一款產品
正在新增iphone
Process finished with exit code 0
複製程式碼總結：以上通過理解jdk動態代理的原理，自己手寫了一個動態代理，裡面涉及到的重點主要是代理類位元組碼的生成（這裡採用通過反射強行生成原始檔並編譯的方法，其實應該可以直接生成位元組碼檔案的，有興趣的同學可以嘗試）和將生成的類動態載入到JVM中（本次試驗由於測試，比較簡單，直接將類名硬編碼到了系統裡，正常應該是自動載入），雖然還不完善，但是對於理解原理應該是有很多幫助了，歡迎同學們評論區留言評論給出更好的建議
在網際網路公司面試中，架構的底層一定是面試官會問問的問題，針對面試官一般會提到的問題，我錄製了一些分散式，微服務，效能優化等技術點底層原理的錄影視訊，加群895244712可以免費獲取這些錄影，裡面還有些分散式，微服務，效能優化，spring，MyBatis的等原始碼知識點的錄影視訊。
