Java Agent入門學習之動態(tài)修改代碼
前言
最近用了一下午總算把Java agent給跑通了,本篇文章記錄一下具體的操作步驟,以免遺忘。下面話不多說,來一起看看詳細的介紹:
通過java agent可以動態(tài)修改代碼(替換、修改類的定義),進行AOP。
目標:
為所有添加@ToString注解的類實現(xiàn)默認的toString方法
需要兩個程序,一個是用來測試的程序,一個agent用于修改代碼。
1. 測試程序
被測試的程序包括:
- ToString.Java
- Foo.java
- Main.java
具體代碼如下:
ToString.java:定義ToString注解
package com.chosen0ne.agent.test; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @Retention(RetentionPolicy.RUNTIME) public @interface ToString { }
Foo.java:很簡單用于測試,使用了ToString注解
package com.chosen0ne.agent.test; @ToString public class Foo { }
Main.java:
package com.chosen0ne.agent.test; public class Main { public static void main(String[] args) { Foo foo = new Foo(); System.out.println(foo.toString()); } }
執(zhí)行Main.java,結果如下:
com.chosen0ne.agent.test.Foo@7852e922
可以看到toString返回的是Object的默認實現(xiàn)。
2. Agent程序
java agent程序實際上類似于鉤子,有兩種方式:
- main函數(shù)開始前
- 程序運行中
這里主要測試main函數(shù)開始前的情況。類似于main函數(shù),需要實現(xiàn)
public static void premain(String agentArgs, Instrumentation inst);
這個函數(shù)會在main函數(shù)之前被調(diào)用??梢栽趐remain中,進行字節(jié)碼操作,替換或重新實現(xiàn)一些類。這里使用Byte Buddy庫,在ASM之上提供了更高級的抽象,便于使用。
具體代碼如下:
package com.chosen0ne.ByteCode.agent; import java.lang.instrument.Instrumentation; import com.chosen0ne.agent.test.ToString; import net.bytebuddy.agent.builder.AgentBuilder; import net.bytebuddy.description.type.TypeDescription; import net.bytebuddy.dynamic.DynamicType.Builder; import net.bytebuddy.implementation.FixedValue; import net.bytebuddy.matcher.ElementMatchers; public class ToStringAgent { public static void premain(String args, Instrumentation instrumentation) { System.out.println("print pre main"); new AgentBuilder.Default() .type(ElementMatchers.isAnnotatedWith(ToString.class)) .transform(new AgentBuilder.Transformer() { @Override public Builder<?> transform(Builder<?> builder, TypeDescription typeDescription, ClassLoader classLoader) { return builder.method(ElementMatchers.named("toString")) .intercept(FixedValue.value("test")); } }).installOn(instrumentation); } }
agent需要打包成jar,并且對于premain的方式需要在MANIFEST.MF中指定Premain-Class,用于指明包含premain函數(shù)的類。具體有兩種方式打包:
1)直接通過jar命令
編輯生成MANIFEST.MF后,執(zhí)行:
jar cvfm agent.jar MANIFEST.MF -C . com lib
上述命令打包成的jar包含:
- com:編譯生成的class文件
- lib:其依賴的庫
2)通過maven直接生成:
通過maven-jar-plugin插件生成jar包,具體配置如下:
<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>2.1</version> <configuration> <archive> <manifest> <addClasspath>true</addClasspath> <classpathPrefix>lib/</classpathPrefix> <mainClass>com.chosen0ne.ByteCode.ByteBuddyTest</mainClass> </manifest> <manifestEntries> <Premain-Class>com.chosen0ne.ByteCode.agent.ToStringAgent</Premain-Class> </manifestEntries> </archive> </configuration> </plugin> </plugins> </build>
主要通過manifestEntries標簽生成自動的屬性,這里指定了Premain-Class
3. 運行
將生成的agent.jar、依賴的ByteBuddy的jar包和測試程序編譯生成的class文件放到一個路徑下,目錄布局如下:
. ├── agent.jar ├── classes │ └── com │ └── chosen0ne │ └── agent │ └── test │ ├── Foo.class │ ├── Main.class │ └── ToString.class └── lib └── byte-buddy-1.2.3.jar
在當前目錄執(zhí)行命令:
java -cp classes:lib/byte-buddy-1.2.3.jar -javaagent:agent.jar com.chosen0ne.agent.test.Main
運行結果如下:
print pre main test
這里需要注意一點,如果將測試程序也打包成jar包的話,那么在通過-cp指定ByteBuddy庫時會失敗,找不到對應的class,錯誤如下:
> java -cp classes:lib/byte-buddy-1.2.3.jar -javaagent:agent.jar -jar agent-test-case-0.0.1-SNAPSHOT.jar Exception in thread "main" java.lang.NoClassDefFoundError: net/bytebuddy/matcher/ElementMatcher at java.lang.Class.getDeclaredMethods0(Native Method) at java.lang.Class.privateGetDeclaredMethods(Class.java:2688) at java.lang.Class.getDeclaredMethod(Class.java:2115) at sun.instrument.InstrumentationImpl.loadClassAndStartAgent(InstrumentationImpl.java:327) at sun.instrument.InstrumentationImpl.loadClassAndCallPremain(InstrumentationImpl.java:401) Caused by: java.lang.ClassNotFoundException: net.bytebuddy.matcher.ElementMatcher at java.net.URLClassLoader$1.run(URLClassLoader.java:372) at java.net.URLClassLoader$1.run(URLClassLoader.java:361) at java.security.AccessController.doPrivileged(Native Method) at java.net.URLClassLoader.findClass(URLClassLoader.java:360) at java.lang.ClassLoader.loadClass(ClassLoader.java:424) at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:308) at java.lang.ClassLoader.loadClass(ClassLoader.java:357) ... 5 more FATAL ERROR in native method: processing of -javaagent failed
暫時不知道具體原因。。。所以直接以class運行即可
總結
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學習或者工作能帶來一定的幫助,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
相關文章
Java 實戰(zhàn)項目之畢業(yè)設計管理系統(tǒng)的實現(xiàn)流程
讀萬卷書不如行萬里路,只學書上的理論是遠遠不夠的,只有在實戰(zhàn)中才能獲得能力的提升,本篇文章手把手帶你用java+SSM+jsp+mysql+maven實現(xiàn)畢業(yè)設計管理系統(tǒng),大家可以在過程中查缺補漏,提升水平2021-11-11