Java設計模式——代理模式
代理模式主要分為接口,委托類,代理類
接口:規定具體方法
委托類:實現接口,完成具體的業務邏輯
代理類:實現接口,在方法里面調用委托類的方法,自己不實現核心業務,在調用委托類的方法前后可以執行其他操作,也就是增強。
代理重要的特征就是: 委托類和代理類實現了相同的接口,由此對于調用者來說委托類和代理類沒有什么不同,而且代理類的定制性更強,這也是和適配器模式的重要區別。
靜態代理
靜態代理是在編譯時期就將接口,實現類,代理類全部編碼,也就是在運行之前所有的class文件已經存在。
接口:
public interface Service {
int increaseOne(int num);
String toUpperCase(String str);
}
接口實現類(委托類):
public class ServiceImpl implements Service {
@Override
public int increaseOne(int num) {
return ++num;
}
@Override
public String toUpperCase(String str) {
return str.toUpperCase();
}
}
代理類:
public class ServiceProxy implements Service{
private Service service;
public ServiceProxy(Service service) {
this.service = service;
}
@Override
public int increaseOne(int num) {
System.out.println("將要執行increaseOne");
int i = service.increaseOne(num);
System.out.println("increaseOne執行完畢");
return i;
}
@Override
public String toUpperCase(String str) {
return service.toUpperCase(str);
}
}
測試類:
public class MainTest {
public static void main(String[] args) {
Service service = new ServiceImpl();
ServiceProxy serviceProxy = new ServiceProxy(service);
/**
* 在執行真正 increaseOne方法之前或者之后可以執行一系列操作
* 這里用sout模擬
*/
System.out.println(serviceProxy.increaseOne(5));
/**
* 調用真正的 toUpperCase方法
*/
System.out.println(serviceProxy.toUpperCase("hello world"));
}
}
輸出:
將要執行increaseOne
increaseOne執行完畢
6
HELLO WORLD
JDK動態代理
JDK動態代理簡化了靜態代理的繁瑣操作,不需要人工硬編碼代理類實現接口。
實現InvocationHandler接口
:
public class DynamicProxyHandler implements InvocationHandler {
private Object target;
public DynamicProxyHandler(Object target) {
this.target = target;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
Object result;
if ("increaseOne".equals(method.getName())) {
System.out.println("將要執行increaseOne");
result = method.invoke(target, args);
System.out.println("increaseOne執行完畢");
} else {
result = method.invoke(target, args);
}
return result;
}
測試類:
public class MainTest {
public static void main(String[] args) {
Service service = new ServiceImpl();
DynamicProxyHandler dynamicProxyHandler = new DynamicProxyHandler(service);
Service serviceProxy = (Service) Proxy.newProxyInstance(
Thread.currentThread().getContextClassLoader(),
service.getClass().getInterfaces(), dynamicProxyHandler);
System.out.println(serviceProxy.increaseOne(5));
System.out.println(serviceProxy.toUpperCase("hello world"));
}
}
輸出:
將要執行increaseOne
increaseOne執行完畢
6
HELLO WORLD
比較分析
靜態代理的實現方式:
代理類實現接口,實例化代理類,代理類的成員變量引用委托類對象,代理類調用方法,方法內部委托類對象調用方法。
JDK動態代理的實現方式:
與靜態代理的過程是一樣的,但是代理類編碼是由JVM完成,我們只需要關注方法的實現細節。
-
實現
InvocationHandler
接口:
先看看InvocationHandler
接口:public interface InvocationHandler { public Object invoke(Object proxy, Method method, Object[] args) throws Throwable; }
只有
invoke
方法,三個參數:類型 參數 說明 Object proxy 自動生成的代理對象,后面詳細說 Method method 調用的方法 Object[] args 調用的方法的參數 實現:
method.invoke(target, args)
使用反射讓委托對象調用方法,target
就是委托對 象public class DynamicProxyHandler implements InvocationHandler { private Object target; public DynamicProxyHandler(Object target) { this.target = target; } @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { Object result; result = method.invoke(target, args); return result; } }
-
生成代理對象:通過
Proxy
類的靜態方法newProxyInstance
public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)
newProxyInstance
需要三個參數:類型 參數 說明 ClassLoader loadery 類加載器,使用類的或者當前線程的都可以 Class<?> interfaces 代理類代理的接口,相當于示例中的 Service
接口InvocationHandler h 回調對象,代理方法的具體實現細節在這里完成
-
具體過程:
-
調用
Proxy.newProxyInstance(ClassLoader, Class<?>[] , InvocationHandler)
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; } }); } 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); } }
重要的有倆步:
-
Class<?> cl = getProxyClass0(loader, intfs)
根據類加載器和接口參數會生成代理類的字節碼, -
return cons.newInstance(new Object[]{h})
返回生成代理類的實例
來看看生成的代理類(在內存中生成.class文件,需要先輸出保存,再反編譯):
public final class $ServiceProxy extends Proxy implements Service { private static Method m1; private static Method m2; private static Method m3; private static Method m4; private static Method m0; public $ServiceProxy(InvocationHandler var1) throws { super(var1); } public final boolean equals(Object var1) throws { try { return (Boolean)super.h.invoke(this, m1, new Object[]{var1}); } catch (RuntimeException | Error var3) { throw var3; } catch (Throwable var4) { throw new UndeclaredThrowableException(var4); } } public final String toString() throws { try { return (String)super.h.invoke(this, m2, (Object[])null); } catch (RuntimeException | Error var2) { throw var2; } catch (Throwable var3) { throw new UndeclaredThrowableException(var3); } } public final String toUpperCase(String var1) throws { try { return (String)super.h.invoke(this, m3, new Object[]{var1}); } catch (RuntimeException | Error var3) { throw var3; } catch (Throwable var4) { throw new UndeclaredThrowableException(var4); } } public final int increaseOne(int var1) throws { try { return (Integer)super.h.invoke(this, m4, new Object[]{var1}); } catch (RuntimeException | Error var3) { throw var3; } catch (Throwable var4) { throw new UndeclaredThrowableException(var4); } } public final int hashCode() throws { try { return (Integer)super.h.invoke(this, m0, (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")); m2 = Class.forName("java.lang.Object").getMethod("toString"); m3 = Class.forName("com.Service").getMethod("toUpperCase", Class.forName("java.lang.String")); m4 = Class.forName("com.Service").getMethod("increaseOne", Integer.TYPE); m0 = Class.forName("java.lang.Object").getMethod("hashCode"); } catch (NoSuchMethodException var2) { throw new NoSuchMethodError(var2.getMessage()); } catch (ClassNotFoundException var3) { throw new NoClassDefFoundError(var3.getMessage()); } } }
生成的代理類實現l了
Service
接口,這和靜態代理的代碼類似,但是這里還繼承了Proxy
類,構造函數接受InvocationHandler
實現類對象,然后調用Proxy
的構造函數,把對象傳給Proxy
的InvocationHandler
類型成員變量,示例中獲取代理對象后有個強制轉換類型,之前一直有疑問為什么不會報錯,直到反編譯代理類后看到實現了Service
接口才明白。 -
-
代理類對象調用接口方法:
繼續看代理類,例如調用increaseOne
方法public final int increaseOne(int var1) throws { try { return (Integer)super.h.invoke(this, m4, new Object[]{var1}); } catch (RuntimeException | Error var3) { throw var3; } catch (Throwable var4) { throw new UndeclaredThrowableException(var4); } }
其實最終調用的就是我們傳入的
InvocationHandler
對象的invoke
方法,this
和new Object[]{var1}
,可以理解,但是m4
什么時候生成的呢代理類有個
static
代碼塊:static { try { m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object")); m2 = Class.forName("java.lang.Object").getMethod("toString"); m3 = Class.forName("com.Service").getMethod("toUpperCase", Class.forName("java.lang.String")); m4 = Class.forName("com.Service").getMethod("increaseOne", Integer.TYPE); m0 = Class.forName("java.lang.Object").getMethod("hashCode"); } catch (NoSuchMethodException var2) { throw new NoSuchMethodError(var2.getMessage()); } catch (ClassNotFoundException var3) { throw new NoClassDefFoundError(var3.getMessage()); } }
可以看到
m3
和m4
是Service
接口方法的引用,其他的三個方法引用是Object
類的equals
,toString
以及hashCode
方法,而且這三個方法里面也調用了invoke
方法,所以不能在invoke
方法里面輸出proxy
對象,相當于循環調用方法。
-
CGLIB動態代理
CGLIB代理的是類,不同于JDK只能代理接口
委托類:
public class DelegateClass {
public int increaseOne(int num) {
return ++num;
}
public String toUpperCase(String str) {
return str.toUpperCase();
}
}
代理類:
public class CGLIBProxy implements MethodInterceptor {
private Object target;
public CGLIBProxy(Object target) {
this.target = target;
}
@Override
public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {
Object result;
if ("increaseOne".equals(method.getName())) {
System.out.println("將要執行increaseOne");
result = method.invoke(target, args);
System.out.println("increaseOne執行完畢");
} else {
result = method.invoke(target, args);
}
return result;
}
}
測試類:
public class MainTest {
public static void main(String[] args) {
DelegateClass delegateClass = new DelegateClass();
MethodInterceptor methodInterceptor = new CGLIBProxy(delegateClass);
Enhancer enhancer = new Enhancer();
enhancer.setSuperclass(DelegateClass.class);
enhancer.setCallback(methodInterceptor);
DelegateClass cglibProxy = (DelegateClass) enhancer.create();
System.out.println(cglibProxy.increaseOne(5));
System.out.println(cglibProxy.toUpperCase("hello world"));
}
}
分析:
-
自動生成的代理類:
public class DelegateClass$$EnhancerByCGLIB$$50d8bc59 extends DelegateClass implements Factory { private boolean CGLIB$BOUND; public static Object CGLIB$FACTORY_DATA; private static final ThreadLocal CGLIB$THREAD_CALLBACKS; private static final Callback[] CGLIB$STATIC_CALLBACKS; private MethodInterceptor CGLIB$CALLBACK_0; private static Object CGLIB$CALLBACK_FILTER; private static final Method CGLIB$toUpperCase$0$Method; private static final MethodProxy CGLIB$toUpperCase$0$Proxy; private static final Object[] CGLIB$emptyArgs; private static final Method CGLIB$increaseOne$1$Method; private static final MethodProxy CGLIB$increaseOne$1$Proxy; private static final Method CGLIB$equals$2$Method; private static final MethodProxy CGLIB$equals$2$Proxy; private static final Method CGLIB$toString$3$Method; private static final MethodProxy CGLIB$toString$3$Proxy; private static final Method CGLIB$hashCode$4$Method; private static final MethodProxy CGLIB$hashCode$4$Proxy; private static final Method CGLIB$clone$5$Method; private static final MethodProxy CGLIB$clone$5$Proxy; static void CGLIB$STATICHOOK1() { CGLIB$THREAD_CALLBACKS = new ThreadLocal(); CGLIB$emptyArgs = new Object[0]; Class var0 = Class.forName("com.cglibproxy.DelegateClass$$EnhancerByCGLIB$$50d8bc59"); Class var1; Method[] var10000 = ReflectUtils.findMethods(new String[]{"equals", "(Ljava/lang/Object;)Z", "toString", "()Ljava/lang/String;", "hashCode", "()I", "clone", "()Ljava/lang/Object;"}, (var1 = Class.forName("java.lang.Object")).getDeclaredMethods()); CGLIB$equals$2$Method = var10000[0]; CGLIB$equals$2$Proxy = MethodProxy.create(var1, var0, "(Ljava/lang/Object;)Z", "equals", "CGLIB$equals$2"); CGLIB$toString$3$Method = var10000[1]; CGLIB$toString$3$Proxy = MethodProxy.create(var1, var0, "()Ljava/lang/String;", "toString", "CGLIB$toString$3"); CGLIB$hashCode$4$Method = var10000[2]; CGLIB$hashCode$4$Proxy = MethodProxy.create(var1, var0, "()I", "hashCode", "CGLIB$hashCode$4"); CGLIB$clone$5$Method = var10000[3]; CGLIB$clone$5$Proxy = MethodProxy.create(var1, var0, "()Ljava/lang/Object;", "clone", "CGLIB$clone$5"); var10000 = ReflectUtils.findMethods(new String[]{"toUpperCase", "(Ljava/lang/String;)Ljava/lang/String;", "increaseOne", "(I)I"}, (var1 = Class.forName("com.cglibproxy.DelegateClass")).getDeclaredMethods()); CGLIB$toUpperCase$0$Method = var10000[0]; CGLIB$toUpperCase$0$Proxy = MethodProxy.create(var1, var0, "(Ljava/lang/String;)Ljava/lang/String;", "toUpperCase", "CGLIB$toUpperCase$0"); CGLIB$increaseOne$1$Method = var10000[1]; CGLIB$increaseOne$1$Proxy = MethodProxy.create(var1, var0, "(I)I", "increaseOne", "CGLIB$increaseOne$1"); } final String CGLIB$toUpperCase$0(String var1) { return super.toUpperCase(var1); } public final String toUpperCase(String var1) { MethodInterceptor var10000 = this.CGLIB$CALLBACK_0; if (this.CGLIB$CALLBACK_0 == null) { CGLIB$BIND_CALLBACKS(this); var10000 = this.CGLIB$CALLBACK_0; } return var10000 != null ? (String)var10000.intercept(this, CGLIB$toUpperCase$0$Method, new Object[]{var1}, CGLIB$toUpperCase$0$Proxy) : super.toUpperCase(var1); } final int CGLIB$increaseOne$1(int var1) { return super.increaseOne(var1); } public final int increaseOne(int var1) { MethodInterceptor var10000 = this.CGLIB$CALLBACK_0; if (this.CGLIB$CALLBACK_0 == null) { CGLIB$BIND_CALLBACKS(this); var10000 = this.CGLIB$CALLBACK_0; } if (var10000 != null) { Object var2 = var10000.intercept(this, CGLIB$increaseOne$1$Method, new Object[]{new Integer(var1)}, CGLIB$increaseOne$1$Proxy); return var2 == null ? 0 : ((Number)var2).intValue(); } else { return super.increaseOne(var1); } } final boolean CGLIB$equals$2(Object var1) { return super.equals(var1); } public final boolean equals(Object var1) { MethodInterceptor var10000 = this.CGLIB$CALLBACK_0; if (this.CGLIB$CALLBACK_0 == null) { CGLIB$BIND_CALLBACKS(this); var10000 = this.CGLIB$CALLBACK_0; } if (var10000 != null) { Object var2 = var10000.intercept(this, CGLIB$equals$2$Method, new Object[]{var1}, CGLIB$equals$2$Proxy); return var2 == null ? false : (Boolean)var2; } else { return super.equals(var1); } } final String CGLIB$toString$3() { return super.toString(); } public final String toString() { MethodInterceptor var10000 = this.CGLIB$CALLBACK_0; if (this.CGLIB$CALLBACK_0 == null) { CGLIB$BIND_CALLBACKS(this); var10000 = this.CGLIB$CALLBACK_0; } return var10000 != null ? (String)var10000.intercept(this, CGLIB$toString$3$Method, CGLIB$emptyArgs, CGLIB$toString$3$Proxy) : super.toString(); } final int CGLIB$hashCode$4() { return super.hashCode(); } public final int hashCode() { MethodInterceptor var10000 = this.CGLIB$CALLBACK_0; if (this.CGLIB$CALLBACK_0 == null) { CGLIB$BIND_CALLBACKS(this); var10000 = this.CGLIB$CALLBACK_0; } if (var10000 != null) { Object var1 = var10000.intercept(this, CGLIB$hashCode$4$Method, CGLIB$emptyArgs, CGLIB$hashCode$4$Proxy); return var1 == null ? 0 : ((Number)var1).intValue(); } else { return super.hashCode(); } } final Object CGLIB$clone$5() throws CloneNotSupportedException { return super.clone(); } protected final Object clone() throws CloneNotSupportedException { MethodInterceptor var10000 = this.CGLIB$CALLBACK_0; if (this.CGLIB$CALLBACK_0 == null) { CGLIB$BIND_CALLBACKS(this); var10000 = this.CGLIB$CALLBACK_0; } return var10000 != null ? var10000.intercept(this, CGLIB$clone$5$Method, CGLIB$emptyArgs, CGLIB$clone$5$Proxy) : super.clone(); } public static MethodProxy CGLIB$findMethodProxy(Signature var0) { String var10000 = var0.toString(); switch(var10000.hashCode()) { case -1961280283: if (var10000.equals("increaseOne(I)I")) { return CGLIB$increaseOne$1$Proxy; } break; case -508378822: if (var10000.equals("clone()Ljava/lang/Object;")) { return CGLIB$clone$5$Proxy; } break; case 893465080: if (var10000.equals("toUpperCase(Ljava/lang/String;)Ljava/lang/String;")) { return CGLIB$toUpperCase$0$Proxy; } break; case 1826985398: if (var10000.equals("equals(Ljava/lang/Object;)Z")) { return CGLIB$equals$2$Proxy; } break; case 1913648695: if (var10000.equals("toString()Ljava/lang/String;")) { return CGLIB$toString$3$Proxy; } break; case 1984935277: if (var10000.equals("hashCode()I")) { return CGLIB$hashCode$4$Proxy; } } return null; } public DelegateClass$$EnhancerByCGLIB$$50d8bc59() { CGLIB$BIND_CALLBACKS(this); } public static void CGLIB$SET_THREAD_CALLBACKS(Callback[] var0) { CGLIB$THREAD_CALLBACKS.set(var0); } public static void CGLIB$SET_STATIC_CALLBACKS(Callback[] var0) { CGLIB$STATIC_CALLBACKS = var0; } private static final void CGLIB$BIND_CALLBACKS(Object var0) { DelegateClass$$EnhancerByCGLIB$$50d8bc59 var1 = (DelegateClass$$EnhancerByCGLIB$$50d8bc59)var0; if (!var1.CGLIB$BOUND) { var1.CGLIB$BOUND = true; Object var10000 = CGLIB$THREAD_CALLBACKS.get(); if (var10000 == null) { var10000 = CGLIB$STATIC_CALLBACKS; if (CGLIB$STATIC_CALLBACKS == null) { return; } } var1.CGLIB$CALLBACK_0 = (MethodInterceptor)((Callback[])var10000)[0]; } } public Object newInstance(Callback[] var1) { CGLIB$SET_THREAD_CALLBACKS(var1); DelegateClass$$EnhancerByCGLIB$$50d8bc59 var10000 = new DelegateClass$$EnhancerByCGLIB$$50d8bc59(); CGLIB$SET_THREAD_CALLBACKS((Callback[])null); return var10000; } public Object newInstance(Callback var1) { CGLIB$SET_THREAD_CALLBACKS(new Callback[]{var1}); DelegateClass$$EnhancerByCGLIB$$50d8bc59 var10000 = new DelegateClass$$EnhancerByCGLIB$$50d8bc59(); CGLIB$SET_THREAD_CALLBACKS((Callback[])null); return var10000; } public Object newInstance(Class[] var1, Object[] var2, Callback[] var3) { CGLIB$SET_THREAD_CALLBACKS(var3); DelegateClass$$EnhancerByCGLIB$$50d8bc59 var10000 = new DelegateClass$$EnhancerByCGLIB$$50d8bc59; switch(var1.length) { case 0: var10000.<init>(); CGLIB$SET_THREAD_CALLBACKS((Callback[])null); return var10000; default: throw new IllegalArgumentException("Constructor not found"); } } public Callback getCallback(int var1) { CGLIB$BIND_CALLBACKS(this); MethodInterceptor var10000; switch(var1) { case 0: var10000 = this.CGLIB$CALLBACK_0; break; default: var10000 = null; } return var10000; } public void setCallback(int var1, Callback var2) { switch(var1) { case 0: this.CGLIB$CALLBACK_0 = (MethodInterceptor)var2; default: } } public Callback[] getCallbacks() { CGLIB$BIND_CALLBACKS(this); return new Callback[]{this.CGLIB$CALLBACK_0}; } public void setCallbacks(Callback[] var1) { this.CGLIB$CALLBACK_0 = (MethodInterceptor)var1[0]; } static { CGLIB$STATICHOOK1(); } }
類繼承了委托類
DelegateClass
,測試類代碼中一行代碼DelegateClass cglibProxy = (DelegateClass) enhancer.create();
cglibProxy
引用的就是DelegateClass$$EnhancerByCGLIB$$50d8bc59
的實例,屬于子類強制轉父類,除了代理increaseOne
和toUpperCase
方法外,還有toString
,equal
,hashCode
,clone
方法也被代理,代理類的方法會判斷是否有回調對象,也就是MethodInterceptor
的實例,有的話調用回調對象的intercept
方法,否則使用super.increaseOne(var1)
調用委托類的方法,沒有增強處理。