作者 | 京東云開(kāi)發(fā)者-董子龍
一、SpringAop 與 Cglib
1.1、aop 重要概念
?
1.2、實(shí)現(xiàn)原理解析
Spring AOP 的實(shí)現(xiàn)原理是基于動(dòng)態(tài)織入的動(dòng)態(tài)代理技術(shù),而動(dòng)態(tài)代理技術(shù)又分為 Java JDK 動(dòng)態(tài)代理和 CGLIB 動(dòng)態(tài)代理。具體使用哪一種需要根據(jù) AopProxyFactory 接口的 createProxy 方法中的 AdvisedSupport 中的參數(shù)進(jìn)行確定,默認(rèn)情況下如果目標(biāo)類(lèi)是接口,則使用 jdk 動(dòng)態(tài)代理技術(shù),如果是非接口類(lèi),則使用 cglib 來(lái)生成代理。具體的源碼就不給大家一一貼出來(lái)了,大家可以去網(wǎng)上搜索一些資料進(jìn)行深入了解。這里只給大家貼一張生成代理對(duì)象的圖:
?
1.2.1、jdk 動(dòng)態(tài)代理
spring-aop 中 jdk 代理的實(shí)現(xiàn)和我們平時(shí)自己實(shí)現(xiàn)動(dòng)態(tài)代理開(kāi)發(fā)是一致的,所以此處不做詳細(xì)的介紹,只是簡(jiǎn)要給大家說(shuō)明一下。使用做 jdk 動(dòng)態(tài)代理時(shí),代理類(lèi)要實(shí)現(xiàn) InvocationHandler 接口,目標(biāo)類(lèi)要實(shí)現(xiàn)接口,因?yàn)?JDK 提供的 Proxy 類(lèi)將通過(guò)目標(biāo)對(duì)象的類(lèi)加載器 ClassLoader 和 Interface,以及句柄 (Callback) 創(chuàng)建與目標(biāo)類(lèi)擁有相同接口的代理對(duì)象 proxy,該代理對(duì)象將擁有目標(biāo)類(lèi)接口中的所有方法,同時(shí)代理類(lèi)必須實(shí)現(xiàn)一個(gè)類(lèi)似回調(diào)函數(shù)的 InvocationHandler 接口并重寫(xiě)該接口中的 invoke 方法,當(dāng)調(diào)用 proxy 的每個(gè)方法 (如案例中的 proxy#execute ()) 時(shí),invoke 方法將被調(diào)用,利用該特性,可以在 invoke 方法中對(duì)目標(biāo)對(duì)象方法執(zhí)行的前后動(dòng)態(tài)添加其他外圍業(yè)務(wù)操作,此時(shí)無(wú)需觸及目標(biāo)對(duì)象的任何代碼,也就實(shí)現(xiàn)了外圍業(yè)務(wù)的操作與目標(biāo)對(duì)象完全解耦合的目的。當(dāng)然缺點(diǎn)也很明顯需要擁有接口,這也就有了后來(lái)的 CGLIB 動(dòng)態(tài)代理了。
1.2.2、cglib 動(dòng)態(tài)代理
spring-aop 中 cglib 代理的實(shí)現(xiàn)給大家貼一下源碼的路徑 org.springframework.aop.framework.CglibAopProxy、org.springframework.aop.framework.CglibAopProxy#getProxy (java.lang.ClassLoader),感興趣的話大家可以自己去看一下源碼,接下來(lái)我會(huì)舉一個(gè)具體的示例,來(lái)看一下如何使用 cglib 創(chuàng)建代理對(duì)象。(注:cglibgithub 地址:https://github.com/cglib/cglib)
1.2.2.1、引入 jar 包
cglib cglib 3.2.5
1.2.2.2、示例代碼
/** * 創(chuàng)建目標(biāo)對(duì)象 */ public class Target { public void execute(){ System.out.println("執(zhí)行Target的execute方法..."); } } /** * 創(chuàng)建cglib代理類(lèi) */ public class CGLibProxy implements MethodInterceptor { /** * 被代理的目標(biāo)類(lèi) */ private Target target; public CGLibProxy(Target target) { super(); this.target = target; } /** * 創(chuàng)建代理對(duì)象 * @return */ public Target createProxy(){ // 使用CGLIB生成代理: // 1.聲明增強(qiáng)類(lèi)實(shí)例,用于生產(chǎn)代理類(lèi) Enhancer enhancer = new Enhancer(); // 2.設(shè)置被代理類(lèi)字節(jié)碼,CGLIB根據(jù)字節(jié)碼生成被代理類(lèi)的子類(lèi) enhancer.setSuperclass(target.getClass()); // 3.//設(shè)置回調(diào)函數(shù),即一個(gè)方法攔截 enhancer.setCallback(this); // 4.創(chuàng)建代理: return (Target) enhancer.create(); } @Override public Object intercept(Object proxy, Method method, Object[] args, MethodProxy methodProxy) throws Throwable { // 指定要執(zhí)行被代理的方法 if("execute".equals(method.getName())) { //調(diào)用前執(zhí)行方法 System.out.println("調(diào)用前執(zhí)行方法"); //調(diào)用目標(biāo)對(duì)象的方法(執(zhí)行A對(duì)象即被代理對(duì)象的execute方法) Object result = methodProxy.invokeSuper(proxy, args); //記錄日志數(shù)據(jù)(動(dòng)態(tài)添加其他要執(zhí)行業(yè)務(wù)) System.out.println("調(diào)用前執(zhí)行方法"); return result; } //如果不需要增強(qiáng)直接執(zhí)行原方法 return methodProxy.invokeSuper(proxy, args); } } /** * 創(chuàng)建測(cè)試類(lèi) */ public class CglibTest { public static void main(String[] args) { // 將cglib生成的代理類(lèi)寫(xiě)入到磁盤(pán) System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY,"D:\test\test"); CGLibProxy cgLibProxy = new CGLibProxy(new Target()); Target proxy = cgLibProxy.createProxy(); proxy.execute(); } }
執(zhí)行結(jié)果
從代碼看被代理的類(lèi)無(wú)需接口即可實(shí)現(xiàn)動(dòng)態(tài)代理,而 CGLibProxy 代理類(lèi)需要實(shí)現(xiàn)一個(gè)方法攔截器接口MethodInterceptor并重寫(xiě)intercept方法,類(lèi)似 JDK 動(dòng)態(tài)代理的 InvocationHandler 接口,也是理解為回調(diào)函數(shù),同理每次調(diào)用代理對(duì)象的方法時(shí),intercept 方法都會(huì)被調(diào)用,利用該方法便可以在運(yùn)行時(shí)對(duì)方法執(zhí)行前后進(jìn)行動(dòng)態(tài)增強(qiáng)。關(guān)于代理對(duì)象創(chuàng)建則通過(guò)Enhancer類(lèi)來(lái)設(shè)置的,Enhancer 是一個(gè)用于產(chǎn)生代理對(duì)象的類(lèi),作用類(lèi)似 JDK 的 Proxy 類(lèi),因?yàn)?CGLib 底層是通過(guò)繼承實(shí)現(xiàn)的動(dòng)態(tài)代理,因此需要傳遞目標(biāo)對(duì)象的 Class,同時(shí)需要設(shè)置一個(gè)回調(diào)函數(shù)對(duì)調(diào)用方法進(jìn)行攔截并進(jìn)行相應(yīng)處理,最后通過(guò) create () 創(chuàng)建目標(biāo)對(duì)象的代理對(duì)象。
1.2.2.3、原理解析
??
上圖是我們?cè)?CglibTest 的 main 方法中設(shè)置了將代理類(lèi)寫(xiě)入到磁盤(pán)之后生成的文件,一共有三個(gè)。我們這里重點(diǎn)看一下第二個(gè)文件,下面是該 class 文件的源碼,給大家貼一下,一些重要的地方我會(huì)加上注釋?zhuān)?/p>
// // Source code recreated from a .class file by IntelliJ IDEA // (powered by FernFlower decompiler) // package com.test.excel.cglib; import java.lang.reflect.Method; import net.sf.cglib.core.ReflectUtils; import net.sf.cglib.core.Signature; import net.sf.cglib.proxy.Callback; import net.sf.cglib.proxy.Factory; import net.sf.cglib.proxy.MethodInterceptor; import net.sf.cglib.proxy.MethodProxy; public class Target$$EnhancerByCGLIB$$e7b1b1b0 extends Target 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$execute$0$Method; // 代理方法 private static final MethodProxy CGLIB$execute$0$Proxy; private static final Object[] CGLIB$emptyArgs; private static final Method CGLIB$equals$1$Method; private static final MethodProxy CGLIB$equals$1$Proxy; private static final Method CGLIB$toString$2$Method; private static final MethodProxy CGLIB$toString$2$Proxy; private static final Method CGLIB$hashCode$3$Method; private static final MethodProxy CGLIB$hashCode$3$Proxy; private static final Method CGLIB$clone$4$Method; private static final MethodProxy CGLIB$clone$4$Proxy; static void CGLIB$STATICHOOK1() { CGLIB$THREAD_CALLBACKS = new ThreadLocal(); CGLIB$emptyArgs = new Object[0]; // 代理類(lèi) Class var0 = Class.forName("com.test.excel.cglib.Target$$EnhancerByCGLIB$$e7b1b1b0"); // 被代理類(lèi) Class var1; CGLIB$execute$0$Method = ReflectUtils.findMethods(new String[]{"execute", "()V"}, (var1 = Class.forName("com.test.excel.cglib.Target")).getDeclaredMethods())[0]; CGLIB$execute$0$Proxy = MethodProxy.create(var1, var0, "()V", "execute", "CGLIB$execute$0"); 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$1$Method = var10000[0]; CGLIB$equals$1$Proxy = MethodProxy.create(var1, var0, "(Ljava/lang/Object;)Z", "equals", "CGLIB$equals$1"); CGLIB$toString$2$Method = var10000[1]; CGLIB$toString$2$Proxy = MethodProxy.create(var1, var0, "()Ljava/lang/String;", "toString", "CGLIB$toString$2"); CGLIB$hashCode$3$Method = var10000[2]; CGLIB$hashCode$3$Proxy = MethodProxy.create(var1, var0, "()I", "hashCode", "CGLIB$hashCode$3"); CGLIB$clone$4$Method = var10000[3]; CGLIB$clone$4$Proxy = MethodProxy.create(var1, var0, "()Ljava/lang/Object;", "clone", "CGLIB$clone$4"); } final void CGLIB$execute$0() { super.execute(); } // 被代理的方法 public final void execute() { MethodInterceptor var10000 = this.CGLIB$CALLBACK_0; if (var10000 == null) { CGLIB$BIND_CALLBACKS(this); var10000 = this.CGLIB$CALLBACK_0; } if (var10000 != null) { // 調(diào)用攔截器 var10000.intercept(this, CGLIB$execute$0$Method, CGLIB$emptyArgs, CGLIB$execute$0$Proxy); } else { super.execute(); } } final boolean CGLIB$equals$1(Object var1) { return super.equals(var1); } public final boolean equals(Object var1) { MethodInterceptor var10000 = this.CGLIB$CALLBACK_0; if (var10000 == null) { CGLIB$BIND_CALLBACKS(this); var10000 = this.CGLIB$CALLBACK_0; } if (var10000 != null) { Object var2 = var10000.intercept(this, CGLIB$equals$1$Method, new Object[]{var1}, CGLIB$equals$1$Proxy); return var2 == null ? false : (Boolean)var2; } else { return super.equals(var1); } } final String CGLIB$toString$2() { return super.toString(); } public final String toString() { MethodInterceptor var10000 = this.CGLIB$CALLBACK_0; if (var10000 == null) { CGLIB$BIND_CALLBACKS(this); var10000 = this.CGLIB$CALLBACK_0; } return var10000 != null ? (String)var10000.intercept(this, CGLIB$toString$2$Method, CGLIB$emptyArgs, CGLIB$toString$2$Proxy) : super.toString(); } final int CGLIB$hashCode$3() { return super.hashCode(); } public final int hashCode() { MethodInterceptor var10000 = this.CGLIB$CALLBACK_0; if (var10000 == null) { CGLIB$BIND_CALLBACKS(this); var10000 = this.CGLIB$CALLBACK_0; } if (var10000 != null) { Object var1 = var10000.intercept(this, CGLIB$hashCode$3$Method, CGLIB$emptyArgs, CGLIB$hashCode$3$Proxy); return var1 == null ? 0 : ((Number)var1).intValue(); } else { return super.hashCode(); } } final Object CGLIB$clone$4() throws CloneNotSupportedException { return super.clone(); } protected final Object clone() throws CloneNotSupportedException { MethodInterceptor var10000 = this.CGLIB$CALLBACK_0; if (var10000 == null) { CGLIB$BIND_CALLBACKS(this); var10000 = this.CGLIB$CALLBACK_0; } return var10000 != null ? var10000.intercept(this, CGLIB$clone$4$Method, CGLIB$emptyArgs, CGLIB$clone$4$Proxy) : super.clone(); } public static MethodProxy CGLIB$findMethodProxy(Signature var0) { String var10000 = var0.toString(); switch(var10000.hashCode()) { case -508378822: if (var10000.equals("clone()Ljava/lang/Object;")) { return CGLIB$clone$4$Proxy; } break; case 539325408: if (var10000.equals("execute()V")) { return CGLIB$execute$0$Proxy; } break; case 1826985398: if (var10000.equals("equals(Ljava/lang/Object;)Z")) { return CGLIB$equals$1$Proxy; } break; case 1913648695: if (var10000.equals("toString()Ljava/lang/String;")) { return CGLIB$toString$2$Proxy; } break; case 1984935277: if (var10000.equals("hashCode()I")) { return CGLIB$hashCode$3$Proxy; } } return null; } public Target$$EnhancerByCGLIB$$e7b1b1b0() { 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) { Target$$EnhancerByCGLIB$$e7b1b1b0 var1 = (Target$$EnhancerByCGLIB$$e7b1b1b0)var0; if (!var1.CGLIB$BOUND) { var1.CGLIB$BOUND = true; Object var10000 = CGLIB$THREAD_CALLBACKS.get(); if (var10000 == null) { var10000 = CGLIB$STATIC_CALLBACKS; if (var10000 == null) { return; } } var1.CGLIB$CALLBACK_0 = (MethodInterceptor)((Callback[])var10000)[0]; } } public Object newInstance(Callback[] var1) { CGLIB$SET_THREAD_CALLBACKS(var1); Target$$EnhancerByCGLIB$$e7b1b1b0 var10000 = new Target$$EnhancerByCGLIB$$e7b1b1b0(); CGLIB$SET_THREAD_CALLBACKS((Callback[])null); return var10000; } public Object newInstance(Callback var1) { CGLIB$SET_THREAD_CALLBACKS(new Callback[]{var1}); Target$$EnhancerByCGLIB$$e7b1b1b0 var10000 = new Target$$EnhancerByCGLIB$$e7b1b1b0(); CGLIB$SET_THREAD_CALLBACKS((Callback[])null); return var10000; } public Object newInstance(Class[] var1, Object[] var2, Callback[] var3) { CGLIB$SET_THREAD_CALLBACKS(var3); Target$$EnhancerByCGLIB$$e7b1b1b0 var10000 = new Target$$EnhancerByCGLIB$$e7b1b1b0; switch(var1.length) { case 0: var10000.從代理對(duì)象反編譯源碼可以知道,代理對(duì)象繼承于 Target,攔截器調(diào)用 intercept () 方法,intercept () 方法由自定義 CGLibProxy 實(shí)現(xiàn),所以,最后調(diào)用 CGLibProxy 中的 intercept () 方法,從而完成了由代理對(duì)象訪問(wèn)到目標(biāo)對(duì)象的動(dòng)態(tài)代理實(shí)現(xiàn)。(); 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(); } }
1.2.3、jdk 代理和 cglib 代理的總結(jié)
JDK 動(dòng)態(tài)代理:
.需要目標(biāo)類(lèi)實(shí)現(xiàn)接口
.生成的代理類(lèi)是與目標(biāo)類(lèi)平級(jí),實(shí)現(xiàn)了共同的接口
.使用反射的方式進(jìn)行最終方法的調(diào)用,性能較低
CGLIB 動(dòng)態(tài)代理:
.不要求目標(biāo)類(lèi)實(shí)現(xiàn)接口
.生成的代理類(lèi)是目標(biāo)類(lèi)的子類(lèi)
.final 方法不會(huì)出現(xiàn)在代理類(lèi)中
.使用空間換時(shí)間的思想對(duì)最終的方法調(diào)用進(jìn)行了優(yōu)化,提升了運(yùn)行時(shí)性能。
看到這里,大佬們此時(shí)是不是心里會(huì)產(chǎn)生個(gè)疑問(wèn):你的標(biāo)題不是 asm 與 cglib 嗎,前面說(shuō)了這么多 cglib 代理和 jdk 代理,和 asm 有關(guān)系嗎?哈哈,其實(shí)雖然我們沒(méi)有再前面的內(nèi)容中介紹 asm 的相關(guān)知識(shí),但是其實(shí)字里行間都透漏著 asm,整體總結(jié)一句就是CGLIB 包的底層是通過(guò)使用一個(gè)小而快的字節(jié)碼處理框架 ASM,來(lái)轉(zhuǎn)換字節(jié)碼并生成新的類(lèi)。
二、深入 ASM
2.1、簡(jiǎn)介
ASM 是一個(gè) Java字節(jié)碼操控框架。它能被用來(lái)動(dòng)態(tài)生成類(lèi)或者增強(qiáng)既有類(lèi)的功能。ASM 可以直接產(chǎn)生二進(jìn)制 class 文件,也可以在類(lèi)被加載入 Java 虛擬機(jī)之前動(dòng)態(tài)改變類(lèi)行為。Java class 被存儲(chǔ)在嚴(yán)格格式定義的 .class 文件里,這些類(lèi)文件擁有足夠的元數(shù)據(jù)來(lái)解析類(lèi)中的所有元素:類(lèi)名稱(chēng)、方法、屬性以及 Java 字節(jié)碼(指令)。ASM 從類(lèi)文件中讀入信息后,能夠改變類(lèi)行為,分析類(lèi)信息,甚至能夠根據(jù)用戶(hù)要求生成新類(lèi)。 與 BCEL 和 SERL 不同,ASM 提供了更為現(xiàn)代的編程模型。對(duì)于 ASM 來(lái)說(shuō),Java class 被描述為一棵樹(shù);使用 “Visitor” 模式遍歷整個(gè)二進(jìn)制結(jié)構(gòu);事件驅(qū)動(dòng)的處理方式使得用戶(hù)只需要關(guān)注于對(duì)其編程有意義的部分,而不必了解 Java 類(lèi)文件格式的所有細(xì)節(jié):ASM 框架提供了默認(rèn)的 "response taker" 處理這一切。
??
流程圖
2.2、核心 api 介紹
ASM 框架中的核心類(lèi)有以下幾個(gè): ① ClassReader: 該類(lèi)用來(lái)解析編譯過(guò)的 class 字節(jié)碼文件。 ② ClassWriter: 該類(lèi)用來(lái)重新構(gòu)建編譯后的類(lèi),比如說(shuō)修改類(lèi)名、屬性以及方法,甚至可以生成新的類(lèi)的字節(jié)碼文件。 ③ ClassAdapter: 該類(lèi)也實(shí)現(xiàn)了 ClassVisitor 接口,它將對(duì)它的方法調(diào)用委托給另一個(gè) ClassVisitor 對(duì)象。 下面會(huì)列舉每個(gè)核心類(lèi)的幾個(gè)核心 api 供大家參考,后面如果想了解更多的內(nèi)容,可以直接查看 asm 的官方文檔。
2.2.1、ClassReader
構(gòu)造方法 作用:獲取 Class 文件,輸入源很多種,包括字節(jié)流,IO 流或者直接加載 Class。 示例:public ClassReader(final InputStream inputStream) accept 方法 作用:解析字節(jié)碼中常量池之后的所有元素 示例:public void accept(final ClassVisitor classVisitor, final int parsingOptions) 重要參數(shù)解析:parsingOptions(用于跳過(guò)讀取字節(jié)碼時(shí)的一些信息選項(xiàng),有以下四種選擇可以選擇)
SKIP_CODE | 表示跳過(guò)代碼掃描,如果你只需要只是類(lèi)的結(jié)構(gòu),就可以使用這個(gè)。 |
SKIP_DEBUG | 跳過(guò)調(diào)試信息,ClassReader 不會(huì)去訪問(wèn)調(diào)試信息。如果設(shè)置了這個(gè)標(biāo)志,這些屬性既不會(huì)被解析也不會(huì)被訪問(wèn) (例如 ClassVisitor.visitSource,MethodVisitor.visitLocalVariable, MethodVisitor.visitLineNumber MethodVisitor.visitParameter)。這個(gè)會(huì)比較常用,當(dāng)你不需要上面這些方法時(shí)候。 |
SKIP_FRAMES | 跳過(guò)堆棧映射幀。如果設(shè)置了這個(gè)標(biāo)志,這些屬性既不會(huì)被解析也不會(huì)被訪問(wèn)(例如:MethodVisitor.visitFrame). 這個(gè)標(biāo)志當(dāng) ClassWriter.COMPUTE_FRAME 選項(xiàng)被使用時(shí),它會(huì)避免訪問(wèn)將被忽略并從頭重新計(jì)算的幀。 |
EXPAND_FRAMES | 用來(lái)展開(kāi)堆棧映射幀的標(biāo)志,會(huì)降低性能。 |
2.2.2、ClassWriter
構(gòu)造方法 作用:用來(lái)定義類(lèi)的屬性 示例:public ClassWriter(final int flags) 重要參數(shù)解析:
flag == 0 | 自己計(jì)算棧幀和局部變量以及操作數(shù)堆棧的大小 ,也就是你要自己調(diào)用 visitmax 和 visitFrame 方法。 |
flag ==ClassWriter. COMPUTE_MAXS | 局部變量和操作數(shù)堆棧部分的大小會(huì)為你計(jì)算,還需要調(diào)用 visitFrame 方法設(shè)置棧幀。 |
flag ==ClassWriter.COMPUTE_FRAMES | 所有的內(nèi)容都是自動(dòng)計(jì)算的。你不必調(diào)用 visitFrame 和 visitmax |
visit 方法 作用:用來(lái)定義類(lèi)的屬性 示例:public final void visit(int version, int access, String name, String signature, String superName, String[] interfaces) 重要參數(shù)解析:
version | Java 版本號(hào),例如V1_8代表Java 8 |
access | Class 訪問(wèn)權(quán)限,一般默認(rèn)都是ACC_PUBLIC | ACC_SUPER |
name | Class 文件名,例如:asm/User,包名加類(lèi)名 |
signature | 類(lèi)的簽名,除非你是泛型類(lèi)或者實(shí)現(xiàn)泛型接口,一般默認(rèn) null。 |
superName | 繼承的類(lèi),很明顯所有類(lèi)默認(rèn)繼承 Object。例如:java/lang/Object ,如果是繼承自己寫(xiě)的類(lèi) Animal,那就是 asm/Animal |
interfaces | 實(shí)現(xiàn)的接口,例如實(shí)現(xiàn)自己寫(xiě)的接口IPrint,那就是new String[]{"asm/IPrint"} |
visitMethod 方法 作用:用來(lái)定義類(lèi)的方法 示例:public final MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions) 重要參數(shù)解析:
access | 方法的訪問(wèn)權(quán)限,也就是 public,private 等 |
name |
方法名:在 Class 中,有兩個(gè)特殊方法名。 |
descriptor | 方法的描述符,就是字節(jié)碼對(duì)代碼中方法的形參和返回值的一個(gè)描述。其實(shí)就是一個(gè)一一對(duì)應(yīng)的模板 |
signature | 方法簽名,除非方法的參數(shù)、返回類(lèi)型和異常使用了泛型,否則一般為 null。 |
exceptions | 方法上的異常 |
visitField 方法
作用:用來(lái)定義一個(gè)變量
示例:public final FieldVisitor visitField(int access, String name, String descriptor, String signature, Object value)
重要參數(shù)解析:
access | 變量的訪問(wèn)權(quán)限,,也就是 public,private 等 |
name | 變量名 |
descriptor | 變量的描述符 |
signature | 變量的簽名,如果沒(méi)有使用泛型則為 null |
value | 變量的初始值。這個(gè)字段僅作用于被 final 修飾的字段,或者接口中聲明的變量。其他默認(rèn)為 null,變量的賦值是通過(guò)MethodVisitor的visitFieldInsn 方法。 |
visitEnd 方法 作用:用來(lái)通知 Class 已經(jīng)使用完 示例:public final void visitEnd() toByteArray 方法 作用:返回一個(gè)字節(jié)數(shù)組 示例:public byte[] toByteArray()
2.2.3、ClassVisiter
看名字就能看出來(lái),這是一個(gè)對(duì) Class 文件進(jìn)行觀察(掃描)的工具類(lèi)。因?yàn)樗且粋€(gè)抽象類(lèi),所以我們只能對(duì)其進(jìn)行繼承重寫(xiě)。并且 ClassVisitor 所有的調(diào)用都是由 ClassReader 來(lái)進(jìn)行回調(diào),就是我們前面 accept 方法。而這個(gè)方法里,執(zhí)行了對(duì) ClassVisitor 源碼掃描的回調(diào)。如下圖:
??
構(gòu)造方法 示例:protected ClassVisitor(final int api, final ClassVisitor classVisitor) 參數(shù)解釋?zhuān)?api:代表是 ASM API 的版本 ,默認(rèn)填最新(ASM9)即可。編寫(xiě)代碼和代碼讀取的版本號(hào)最好保持一致,不然可能會(huì)有一些兼容性的錯(cuò)誤。 由于 ClassVisitor 所有的調(diào)用都是由 ClassReader 來(lái)進(jìn)行回調(diào),所以其他 api 咱們不做過(guò)多介紹。
2.3、ASM 實(shí)踐
上面給大家介紹了 asm 的 api,還有一些其他的 api 例如MethodVisitor、FieldVisitor 等就不過(guò)多介紹了,還是那句話,想深入了解,就看一下官方文檔。但是光說(shuō)不練假把式,接下來(lái)我們就對(duì) asm 做一番實(shí)踐,由此來(lái)體會(huì)他的功能之強(qiáng)大。
2.3.1、引入 jar
org.ow2.asm asm 9.4
2.3.2、生成類(lèi)
我們自定義生成一個(gè) People 的類(lèi)
package com.test.excel.asm; import org.objectweb.asm.ClassWriter; import org.objectweb.asm.FieldVisitor; import org.objectweb.asm.MethodVisitor; import java.io.FileOutputStream; import static jdk.internal.org.objectweb.asm.ClassWriter.COMPUTE_FRAMES; import static jdk.internal.org.objectweb.asm.ClassWriter.COMPUTE_MAXS; import static jdk.internal.org.objectweb.asm.Opcodes.*; /** * 文件描述 * * @author dzl * @date 2022-11-27 18:49 */ public class AsmTest { public static void main(String[] args) throws Exception { testCreateAClass(); } public static void testCreateAClass()throws Exception{ //新建一個(gè)類(lèi)生成器,COMPUTE_FRAMES,COMPUTE_MAXS這2個(gè)參數(shù)能夠讓asm自動(dòng)更新操作數(shù)棧 ClassWriter cw = new ClassWriter(COMPUTE_FRAMES|COMPUTE_MAXS); //生成一個(gè)public的類(lèi),類(lèi)路徑是com.study.Human cw.visit(V1_8, ACC_PUBLIC,"com/test/excel/asm/People",null,"java/lang/Object",null); //生成默認(rèn)的構(gòu)造方法:public People() MethodVisitor mv = cw.visitMethod(ACC_PUBLIC,"運(yùn)行結(jié)果:","()V",null,null); mv.visitVarInsn(ALOAD,0); mv.visitMethodInsn(INVOKESPECIAL,"java/lang/Object"," ","()V",false); mv.visitInsn(RETURN); mv.visitMaxs(0,0);//更新操作數(shù)棧 mv.visitEnd();//一定要有visitEnd //生成成員變量 //1.生成String類(lèi)型的成員變量:private String name; FieldVisitor fv= cw.visitField(ACC_PRIVATE,"name","Ljava/lang/String;",null,null); fv.visitEnd();//不要忘記end //2.生成Long類(lèi)型成員:private long age fv=cw.visitField(ACC_PRIVATE,"age","J",null,null); fv.visitEnd(); //3.生成Int類(lèi)型成員:protected int no fv=cw.visitField(ACC_PROTECTED,"no","I",null,null); fv.visitEnd(); //4.生成靜態(tài)成員變量:public static long score fv=cw.visitField(ACC_PUBLIC + ACC_STATIC,"score","J",null,null); //5.生成常量:public static final String real_name = "Sand哥" fv=cw.visitField(ACC_PUBLIC+ACC_STATIC+ACC_FINAL,"real_name","Ljava/lang/String;",null,"Sand哥"); fv.visitEnd(); //6.生成成員方法greet mv=cw.visitMethod(ACC_PUBLIC,"greet","(Ljava/lang/String;)I",null,null); mv.visitCode(); mv.visitIntInsn(ALOAD,0); mv.visitIntInsn(ALOAD,1); //6.1 調(diào)用靜態(tài)方法 System.out.println("Hello"); mv.visitFieldInsn(GETSTATIC,"java/lang/System","out","Ljava/io/PrintStream;"); // mv.visitLdcInsn("Hello");//加載字符常量 mv.visitIntInsn(ALOAD,1);//加載形參 mv.visitMethodInsn(INVOKEVIRTUAL,"java/io/PrintStream","println","(Ljava/lang/String;)V",false);//打印形參 //獲取類(lèi)的byte數(shù)組 byte[] classByteData=cw.toByteArray(); //把類(lèi)數(shù)據(jù)寫(xiě)入到class文件,這樣你就可以把這個(gè)類(lèi)文件打包供其他的人使用 FileOutputStream out = new FileOutputStream(AsmTest.class.getResource("/com/test/excel/asm/").getPath() + "People.class"); out.write(classByteData); out.close(); } }
?
2.3.3、修改已存在的類(lèi)
假如我們現(xiàn)在有如下類(lèi),我們用 asm 做如下幾個(gè)修改:1. 增加了一個(gè) phone 字段 2. 刪除 testA 方法 3. 將 testC 方法改成 protected 4. 新增一個(gè) getPhone 方法。
/** * 文件描述 * * @author dzl * @date 2022-11-27 19:14 */ public class ModifyFunction { private int a; public void testA(){ System.out.println("I am A"); } public void testB(){ System.err.println("===>I am B"); } public int testC(){ return a; } }
利用 asm 修改該類(lèi)
package com.test.excel.asm; import org.objectweb.asm.*; import java.io.FileOutputStream; import static jdk.internal.org.objectweb.asm.Opcodes.*; import static org.objectweb.asm.Opcodes.ASM9; /** * 文件描述 * * @author dzl * @date 2022-11-27 18:49 */ public class AsmTest { public static void main(String[] args) throws Exception { testModifyCalss(); } private static void testModifyCalss()throws Exception{ ClassReader cr = new ClassReader("com.test.excel.asm.ModifyFunction"); final ClassWriter cw=new ClassWriter(cr,0); // cr.accept(cw, 0);//可以直接接受一個(gè)writer,實(shí)現(xiàn)復(fù)制 cr.accept(new ClassVisitor(ASM9,cw) {//接受一個(gè)帶classWriter的visitor,實(shí)現(xiàn)定制化方法拷貝或者屬性刪除字段 @Override public MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions) { System.out.println("visit method:"+name+"====> "+descriptor); if("testA".equals(name)){//拷貝的過(guò)程中刪除一個(gè)方法 return null; } if("testC".equals(name)){//將testC public方法變成protect access=ACC_PROTECTED; } return super.visitMethod(access, name, descriptor, signature, exceptions); } @Override public void visitEnd() { //特別注意的是:要為類(lèi)增加屬性和方法,放到visitEnd中,避免破壞之前已經(jīng)排列好的類(lèi)結(jié)構(gòu),在結(jié)尾添加新結(jié)構(gòu) //增加一個(gè)字段(注意不能重復(fù)),注意最后都要visitEnd FieldVisitor fv = cv.visitField(ACC_PUBLIC, "phone", "Ljava/lang/String;", null, null); fv.visitEnd();//不能缺少visitEnd //增加一個(gè)方法 MethodVisitor mv=cv.visitMethod(ACC_PUBLIC,"getPhone","()Ljava/lang/String;",null,null); mv.visitCode(); mv.visitVarInsn(ALOAD, 0); mv.visitFieldInsn(GETFIELD,"com/test/excel/asm/ModifyFunction","phone","Ljava/lang/String;"); mv.visitInsn(IRETURN); mv.visitMaxs(1, 1); mv.visitEnd();//不能缺少visitEnd super.visitEnd();//注意原本的visiEnd不能少 } },0); //指定新生成的class路徑的生成位置,這個(gè)路徑你可以隨便指定 FileOutputStream out = new FileOutputStream(AsmTest.class.getResource("/com/test/excel/asm/").getPath() + "ModifyFunction.class"); out.write(cw.toByteArray()); out.close(); } }運(yùn)行結(jié)果:
?
2.3.4、實(shí)現(xiàn)方法注入
實(shí)現(xiàn)方法注入類(lèi)似于我們的 aop 功能,本篇就不做過(guò)多介紹了,感興趣的大佬可以參考上一篇文章的 demo。
三、總結(jié)
每次寫(xiě)到這里,心里都感覺(jué)如釋重負(fù)了一下,因?yàn)檎目偹闶菍?xiě)完了。寫(xiě)本文時(shí)查了很多資料,看了很多文章,再寫(xiě)分享的同時(shí),自身也學(xué)到了很多東西。同時(shí),如果文章中有不足或者描述不準(zhǔn)確的內(nèi)容,希望及時(shí)批評(píng)指正,萬(wàn)分感謝。
審核編輯:湯梓紅
-
JAVA
+關(guān)注
關(guān)注
19文章
2952瀏覽量
104482 -
AOP
+關(guān)注
關(guān)注
0文章
40瀏覽量
11084 -
字節(jié)碼
+關(guān)注
關(guān)注
0文章
5瀏覽量
7401
原文標(biāo)題:淺談字節(jié)碼增強(qiáng)技術(shù)系列2-Asm與Cglib
文章出處:【微信號(hào):OSC開(kāi)源社區(qū),微信公眾號(hào):OSC開(kāi)源社區(qū)】歡迎添加關(guān)注!文章轉(zhuǎn)載請(qǐng)注明出處。
發(fā)布評(píng)論請(qǐng)先 登錄
相關(guān)推薦
評(píng)論