代理模式
為其他對象提供一個代理以控制對某個對象的通路。代理類主要負責為委托了(真實對象)預處理消息、過濾消息、傳遞消息給委托類,代理類不現實具體服務,而是利用委托類來完成服務,并将執行結果封裝處理。
其實就是代理類為被代理類預處理消息、過濾消息并在此之後将消息轉發給被代理類,之後還能進行消息的後置處理。代理類和被代理類通常會存在關聯關系(即上面提到的持有的被帶離對象的引用),代理類本身不實作服務,而是通過調用被代理類中的方法來提供服務。
靜态代理
建立一個接口,然後建立被代理的類實作該接口并且實作該接口中的抽象方法。之後再建立一個代理類,同時使其也實作這個接口。在代理類中持有一個被代理對象的引用,而後在代理類方法中調用該對象的方法。
接口:
public interface HelloInterface {
void sayHello();
}
被代理類:
public class Hello implements HelloInterface{
@Override
public void sayHello() {
System.out.println("Hello zhanghao!");
}
}
代理類:
public class HelloProxy implements HelloInterface{
private HelloInterface helloInterface = new Hello();
@Override
public void sayHello() {
System.out.println("Before invoke sayHello" );
helloInterface.sayHello();
System.out.println("After invoke sayHello");
}
}
代理類調用:
被代理類被傳遞給了代理類HelloProxy,代理類在執行具體方法時通過所持用的被代理類完成調用。
public static void main(String[] args) {
HelloProxy helloProxy = new HelloProxy();
helloProxy.sayHello();
}
輸出:
Before invoke sayHello
Hello zhanghao!
After invoke sayHello
使用靜态代理很容易就完成了對一個類的代理操作。但是靜态代理的缺點也暴露了出來:由于代理隻能為一個類服務,如果需要代理的類很多,那麼就需要編寫大量的代理類,比較繁瑣。
動态代理
利用反射機制在運作時建立代理類。
接口、被代理類不變,我們建構一個handler類來實作InvocationHandler接口。
public class ProxyHandler implements InvocationHandler{
private Object object;
public ProxyHandler(Object object){
this.object = object;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("Before invoke " + method.getName());
method.invoke(object, args);
System.out.println("After invoke " + method.getName());
return null;
}
}
執行動态代理:
public static void main(String[] args) {
System.getProperties().setProperty("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
HelloInterface hello = new Hello();
InvocationHandler handler = new ProxyHandler(hello);
HelloInterface proxyHello = (HelloInterface) Proxy.newProxyInstance(hello.getClass().getClassLoader(), hello.getClass().getInterfaces(), handler);
proxyHello.sayHello();
}
輸出:
Before invoke sayHello
Hello zhanghao!
After invoke sayHello
通過Proxy類的靜态方法newProxyInstance傳回一個接口的代理執行個體。針對不同的代理類,傳入相應的代理程式控制器InvocationHandler。
如果新來一個被代理類Bye,如:
public interface ByeInterface {
void sayBye();
}
public class Bye implements ByeInterface {
@Override
public void sayBye() {
System.out.println("Bye zhanghao!");
}
}
那麼執行過程:
public static void main(String[] args) {
System.getProperties().setProperty("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
HelloInterface hello = new Hello();
ByeInterface bye = new Bye();
InvocationHandler handler = new ProxyHandler(hello);
InvocationHandler handler1 = new ProxyHandler(bye);
HelloInterface proxyHello = (HelloInterface) Proxy.newProxyInstance(hello.getClass().getClassLoader(), hello.getClass().getInterfaces(), handler);
ByeInterface proxyBye = (ByeInterface) Proxy.newProxyInstance(bye.getClass().getClassLoader(), bye.getClass().getInterfaces(), handler1);
proxyHello.sayHello();
proxyBye.sayBye();
}
輸出:
Before invoke sayHello
Hello zhanghao!
After invoke sayHello
Before invoke sayBye
Bye zhanghao!
After invoke sayBye
動态代理底層實作
動态代理具體步驟:
- 通過實作 InvocationHandler 接口建立自己的調用處理器;
- 通過為 Proxy 類指定 ClassLoader 對象和一組 interface 來建立動态代理類;
- 通過反射機制獲得動态代理類的構造函數,其唯一參數類型是調用處理器接口類型;
- 通過構造函數建立動态代理類執行個體,構造時調用處理器對象作為參數被傳入。
既然生成代理對象是用的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);
}
//生成代理類對象
Class<?> cl = getProxyClass0(loader, intfs);
//使用指定的調用處理程式擷取代理類的構造函數對象
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
final Constructor<?> cons = cl.getConstructor(constructorParams);
final InvocationHandler ih = h;
//如果Class作用域為私有,通過 setAccessible 支援通路
if (!Modifier.isPublic(cl.getModifiers())) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
cons.setAccessible(true);
return null;
}
});
}
//擷取Proxy Class構造函數,建立Proxy代理執行個體。
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);
}
}
利用getProxyClass0(loader, intfs)生成代理類Proxy的Class對象。
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
//如果接口數量大于65535,抛出非法參數錯誤
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
//如果指定接口的代理類已經存在與緩存中,則不用新建立,直接從緩存中取即可;
//如果緩存中沒有指定代理對象,則通過ProxyClassFactory來建立一個代理對象。
return proxyClassCache.get(loader, interfaces);
}
ProxyClassFactory内部類建立、定義代理類,傳回給定ClassLoader 和interfaces的代理類。
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>>{
// 代理類的名字的字首統一為“$Proxy”
private static final String proxyClassNamePrefix = "$Proxy";
// 每個代理類字首後面都會跟着一個唯一的編号,如$Proxy0、$Proxy1、$Proxy2
private static final AtomicLong nextUniqueNumber = new AtomicLong();
@Override
public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
for (Class<?> intf : interfaces) {
//驗證類加載器加載接口得到對象是否與由apply函數參數傳入的對象相同
Class<?> interfaceClass = null;
try {
interfaceClass = Class.forName(intf.getName(), false, loader);
} catch (ClassNotFoundException e) {
}
if (interfaceClass != intf) {
throw new IllegalArgumentException(
intf + " is not visible from class loader");
}
//驗證這個Class對象是不是接口
if (!interfaceClass.isInterface()) {
throw new IllegalArgumentException(
interfaceClass.getName() + " is not an interface");
}
if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
throw new IllegalArgumentException(
"repeated interface: " + interfaceClass.getName());
}
}
String proxyPkg = null; // package to define proxy class in
int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
/*
* Record the package of a non-public proxy interface so that the
* proxy class will be defined in the same package. Verify that
* all non-public proxy interfaces are in the same package.
*/
for (Class<?> intf : interfaces) {
int flags = intf.getModifiers();
if (!Modifier.isPublic(flags)) {
accessFlags = Modifier.FINAL;
String name = intf.getName();
int n = name.lastIndexOf('.');
String pkg = ((n == -1) ? "" : name.substring(0, n + 1));
if (proxyPkg == null) {
proxyPkg = pkg;
} else if (!pkg.equals(proxyPkg)) {
throw new IllegalArgumentException(
"non-public interfaces from different packages");
}
}
}
if (proxyPkg == null) {
// if no non-public proxy interfaces, use com.sun.proxy package
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
/*
* Choose a name for the proxy class to generate.
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
/*
*
* 生成指定代理類的位元組碼檔案
*/
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
try {
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
/*
* A ClassFormatError here means that (barring bugs in the
* proxy class generation code) there was some other
* invalid aspect of the arguments supplied to the proxy
* class creation (such as virtual machine limitations
* exceeded).
*/
throw new IllegalArgumentException(e.toString());
}
}
}
一系列檢查後,調用ProxyGenerator.generateProxyClass來生成位元組碼檔案。
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
// 真正用來生成代理類位元組碼檔案的方法在這裡
final byte[] var4 = var3.generateClassFile();
// 儲存代理類的位元組碼檔案
if(saveGeneratedFiles) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
try {
int var1 = var0.lastIndexOf(46);
Path var2;
if(var1 > 0) {
Path var3 = Paths.get(var0.substring(0, var1).replace('.', File.separatorChar), new String[0]);
Files.createDirectories(var3, new FileAttribute[0]);
var2 = var3.resolve(var0.substring(var1 + 1, var0.length()) + ".class");
} else {
var2 = Paths.get(var0 + ".class", new String[0]);
}
Files.write(var2, var4, new OpenOption[0]);
return null;
} catch (IOException var4x) {
throw new InternalError("I/O exception saving generated file: " + var4x);
}
}
});
}
return var4;
}
生成代理類位元組碼檔案的generateClassFile方法:
private byte[] generateClassFile() {
//下面一系列的addProxyMethod方法是将接口中的方法和Object中的方法添加到代理方法中(proxyMethod)
this.addProxyMethod(hashCodeMethod, Object.class);
this.addProxyMethod(equalsMethod, Object.class);
this.addProxyMethod(toStringMethod, Object.class);
Class[] var1 = this.interfaces;
int var2 = var1.length;
int var3;
Class var4;
//獲得接口中所有方法并添加到代理方法中
for(var3 = 0; var3 < var2; ++var3) {
var4 = var1[var3];
Method[] var5 = var4.getMethods();
int var6 = var5.length;
for(int var7 = 0; var7 < var6; ++var7) {
Method var8 = var5[var7];
this.addProxyMethod(var8, var4);
}
}
Iterator var11 = this.proxyMethods.values().iterator();
List var12;
while(var11.hasNext()) {
var12 = (List)var11.next();
checkReturnTypes(var12);
}
Iterator var15;
try {
//生成代理類的構造函數
this.methods.add(this.generateConstructor());
var11 = this.proxyMethods.values().iterator();
while(var11.hasNext()) {
var12 = (List)var11.next();
var15 = var12.iterator();
while(var15.hasNext()) {
ProxyGenerator.ProxyMethod var16 = (ProxyGenerator.ProxyMethod)var15.next();
this.fields.add(new ProxyGenerator.FieldInfo(var16.methodFieldName, "Ljava/lang/reflect/Method;", 10));
this.methods.add(var16.generateMethod());
}
}
this.methods.add(this.generateStaticInitializer());
} catch (IOException var10) {
throw new InternalError("unexpected I/O Exception", var10);
}
if(this.methods.size() > '\uffff') {
throw new IllegalArgumentException("method limit exceeded");
} else if(this.fields.size() > '\uffff') {
throw new IllegalArgumentException("field limit exceeded");
} else {
this.cp.getClass(dotToSlash(this.className));
this.cp.getClass("java/lang/reflect/Proxy");
var1 = this.interfaces;
var2 = var1.length;
for(var3 = 0; var3 < var2; ++var3) {
var4 = var1[var3];
this.cp.getClass(dotToSlash(var4.getName()));
}
this.cp.setReadOnly();
ByteArrayOutputStream var13 = new ByteArrayOutputStream();
DataOutputStream var14 = new DataOutputStream(var13);
try {
var14.writeInt(-889275714);
var14.writeShort(0);
var14.writeShort(49);
this.cp.write(var14);
var14.writeShort(this.accessFlags);
var14.writeShort(this.cp.getClass(dotToSlash(this.className)));
var14.writeShort(this.cp.getClass("java/lang/reflect/Proxy"));
var14.writeShort(this.interfaces.length);
Class[] var17 = this.interfaces;
int var18 = var17.length;
for(int var19 = 0; var19 < var18; ++var19) {
Class var22 = var17[var19];
var14.writeShort(this.cp.getClass(dotToSlash(var22.getName())));
}
var14.writeShort(this.fields.size());
var15 = this.fields.iterator();
while(var15.hasNext()) {
ProxyGenerator.FieldInfo var20 = (ProxyGenerator.FieldInfo)var15.next();
var20.write(var14);
}
var14.writeShort(this.methods.size());
var15 = this.methods.iterator();
while(var15.hasNext()) {
ProxyGenerator.MethodInfo var21 = (ProxyGenerator.MethodInfo)var15.next();
var21.write(var14);
}
var14.writeShort(0);
return var13.toByteArray();
} catch (IOException var9) {
throw new InternalError("unexpected I/O Exception", var9);
}
}
}
位元組碼生成後,調用defineClass0來解析位元組碼,生成了Proxy的Class對象。在了解完代理類動态生成過程後,生産的代理類是怎樣的,誰來執行這個代理類。
其中,在ProxyGenerator.generateProxyClass函數中 saveGeneratedFiles定義如下,其指代是否儲存生成的代理類class檔案,預設false不儲存。
在前面的示例中,我們修改了此系統變量:
System.getProperties().setProperty("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
cglib動态代理
我們了解到,“代理”的目的是構造一個和被代理的對象有同樣行為的對象,一個對象的行為是在類中定義的,對象隻是類的執行個體。是以構造代理,不一定非得通過持有、包裝對象這一種方式。
通過“繼承”可以繼承父類所有的公開方法,然後可以重寫這些方法,在重寫時對這些方法增強,這就是cglib的思想。根據裡氏代換原則(LSP),父類需要出現的地方,子類可以出現,是以cglib實作的代理也是可以被正常使用的。
先看下代碼
package proxy;
import java.lang.reflect.Method;
import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
public class CglibProxy implements MethodInterceptor
{
// 根據一個類型産生代理類,此方法不要求一定放在MethodInterceptor中
public Object CreatProxyedObj(Class<?> clazz)
{
Enhancer enhancer = new Enhancer();
enhancer.setSuperclass(clazz);
enhancer.setCallback(this);
return enhancer.create();
}
@Override
public Object intercept(Object arg0, Method arg1, Object[] arg2, MethodProxy arg3) throws Throwable
{
// 這裡增強
System.out.println("收錢");
return arg3.invokeSuper(arg0, arg2);
}
}
從代碼可以看出,它和jdk動态代理有所不同,對外表現上看CreatProxyedObj,它隻需要一個類型clazz就可以産生一個代理對象, 是以說是“類的代理”,且創造的對象通過列印類型發現也是一個新的類型。不同于jdk動态代理,jdk動态代理要求對象必須實作接口(三個參數的第二個參數),cglib對此沒有要求。
cglib的原理是這樣,它生成一個繼承B的類型C(代理類),這個代理類持有一個MethodInterceptor,我們setCallback時傳入的。 C重寫所有B中的方法(方法名一緻),然後在C中,建構名叫“CGLIB”+“$父類方法名$”的方法(下面叫cglib方法,所有非private的方法都會被建構),方法體裡隻有一句話super.方法名(),可以簡單的認為保持了對父類方法的一個引用,友善調用。
這樣的話,C中就有了重寫方法、cglib方法、父類方法(不可見),還有一個統一的攔截方法(增強方法intercept)。其中重寫方法和cglib方法肯定是有映射關系的。
C的重寫方法是外界調用的入口(LSP原則),它調用MethodInterceptor的intercept方法,調用時會傳遞四個參數,第一個參數傳遞的是this,代表代理類本身,第二個參數标示攔截的方法,第三個參數是入參,第四個參數是cglib方法,intercept方法完成增強後,我們調用cglib方法間接調用父類方法完成整個方法鍊的調用。
這裡有個疑問就是intercept的四個參數,為什麼我們使用的是arg3而不是arg1?
@Override
public Object intercept(Object arg0, Method arg1, Object[] arg2, MethodProxy arg3) throws Throwable
{
System.out.println("收錢");
return arg3.invokeSuper(arg0, arg2);
}
因為如果我們通過反射 arg1.invoke(arg0, ...)這種方式是無法調用到父類的方法的,子類有方法重寫,隐藏了父類的方法,父類的方法已經不可見,如果硬調arg1.invoke(arg0, ...)很明顯會死循環。
是以調用的是cglib開頭的方法,但是,我們使用arg3也不是簡單的invoke,而是用的invokeSuper方法,這是因為cglib采用了fastclass機制,不僅巧妙的避開了調不到父類方法的問題,還加速了方法的調用。
fastclass基本原理是,給每個方法編号,通過編号找到方法執行避免了通過反射調用。
對比JDK動态代理,cglib依然需要一個第三者分發請求,隻不過jdk動态代理分發給了目标對象,cglib最終分發給了自己,通過給method編号完成調用。cglib是繼承的極緻發揮,本身還是很簡單的,隻是fastclass需要另行了解。
測試
public static void main(String[] args)
{
int times = 1000000;
Star ldh = new LiuDeHua();
StarProxy proxy = new StarProxy();
proxy.setTarget(ldh);
long time1 = System.currentTimeMillis();
Star star = (Star)proxy.CreatProxyedObj();
long time2 = System.currentTimeMillis();
System.out.println("jdk建立時間:" + (time2 - time1));
CglibProxy proxy2 = new CglibProxy();
long time5 = System.currentTimeMillis();
Star star2 = (Star)proxy2.CreatProxyedObj(LiuDeHua.class);
long time6 = System.currentTimeMillis();
System.out.println("cglib建立時間:" + (time6 - time5));
long time3 = System.currentTimeMillis();
for (int i = 1; i <= times; i++)
{
star.sing("ss");
star.dance("ss");
}
long time4 = System.currentTimeMillis();
System.out.println("jdk執行時間" + (time4 - time3));
long time7 = System.currentTimeMillis();
for (int i = 1; i <= times; i++)
{
star2.sing("ss");
star2.dance("ss");
}
long time8 = System.currentTimeMillis();
System.out.println("cglib執行時間" + (time8 - time7));
}
經測試,jdk建立對象的速度遠大于cglib,這是由于cglib建立對象時需要操作位元組碼。cglib執行速度略大于jdk,是以比較适合單例模式。另外由于CGLIB的大部分類是直接對Java位元組碼進行操作,這樣生成的類會在Java的永久堆中。如果動态代理操作過多,容易造成永久堆滿,觸發OutOfMemory異常。spring預設使用jdk動态代理,如果類沒有接口,則使用cglib。
————————————————
版權聲明:本文為CSDN部落客「趙舉飛」的原創文章,遵循CC 4.0 BY-SA版權協定,轉載請附上原文出處連結及本聲明。
原文連結:https://blog.csdn.net/flyfeifei66/article/details/81481222
作者:隻是腫态度
連結:https://www.jianshu.com/p/9bcac608c714
來源:簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權,非商業轉載請注明出處。
參考
https://blog.csdn.net/jiankunking/article/details/52143504
http://www.php.cn/java-article-407212.html
https://www.cnblogs.com/chinajava/p/5880887.html
https://rejoy.iteye.com/blog/1627405
微信公衆号【程式員書單】
一個為程式員推薦好書的公衆号。每周為你pick精品書單,技術好文,優質學習資源和工具軟體。關注Java、Python、大資料、AI等技術與行業資訊,更關注你的自我提升。人生苦短,要把時間浪費在美好的事物上~回複“book”即可領取java後端學習必備20+本電子書。更多電子書下載下傳,請移步至程式員書單官網:coderbooklist.com
微信公衆号【Java技術江湖】
一位阿裡 Java 工程師的技術小站,專注于 Java 相關技術:SSM、SpringBoot、MySQL、分布式、中間件、叢集、Linux、網絡、多線程,偶爾講點Docker、ELK,同時也分享技術幹貨和學習經驗,緻力于Java全棧開發!關注公衆号後回複“PDF”即可領取200+頁的《Java工程師面試指南》強烈推薦,幾乎涵蓋所有Java工程師必知必會的知識點。