Java Agent入門學(xué)習(xí)之動(dòng)態(tài)修改代碼
前言
最近用了一下午總算把Java agent給跑通了，本篇文章記錄一下具體的操作步驟，以免遺忘。下面話不多說，來一起看看詳細(xì)的介紹：
通過java agent可以動(dòng)態(tài)修改代碼（替換、修改類的定義），進(jìn)行AOP。
目標(biāo)：
為所有添加@ToString注解的類實(shí)現(xiàn)默認(rèn)的toString方法
需要兩個(gè)程序，一個(gè)是用來測試的程序，一個(gè)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，結(jié)果如下：
com.chosen0ne.agent.test.Foo@7852e922
可以看到toString返回的是Object的默認(rèn)實(shí)現(xiàn)。
2. Agent程序
java agent程序?qū)嶋H上類似于鉤子，有兩種方式：
- main函數(shù)開始前
- 程序運(yùn)行中
這里主要測試main函數(shù)開始前的情況。類似于main函數(shù)，需要實(shí)現(xiàn)
public static void premain(String agentArgs, Instrumentation inst);
這個(gè)函數(shù)會(huì)在main函數(shù)之前被調(diào)用?？梢栽趐remain中，進(jìn)行字節(jié)碼操作，替換或重新實(shí)現(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標(biāo)簽生成自動(dòng)的屬性，這里指定了Premain-Class
3. 運(yùn)行
將生成的agent.jar、依賴的ByteBuddy的jar包和測試程序編譯生成的class文件放到一個(gè)路徑下，目錄布局如下：
. ├── agent.jar ├── classes │ └── com │ └── chosen0ne │ └── agent │ └── test │ ├── Foo.class │ ├── Main.class │ └── ToString.class └── lib └── byte-buddy-1.2.3.jar
在當(dāng)前目錄執(zhí)行命令：
java -cp classes:lib/byte-buddy-1.2.3.jar -javaagent:agent.jar com.chosen0ne.agent.test.Main
運(yùn)行結(jié)果如下：
print pre main test
這里需要注意一點(diǎn)，如果將測試程序也打包成jar包的話，那么在通過-cp指定ByteBuddy庫時(shí)會(huì)失敗，找不到對應(yīng)的class，錯(cuò)誤如下：
> 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
暫時(shí)不知道具體原因。。。所以直接以class運(yùn)行即可
總結(jié)
以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作能帶來一定的幫助，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。
相關(guān)文章
這篇文章主要為大家分享了最有價(jià)值的三道MyBatis框架面試題，涵蓋內(nèi)容全面，包括數(shù)據(jù)結(jié)構(gòu)和算法相關(guān)的題目、經(jīng)典面試編程題等，感興趣的小伙伴們可以參考一下2021-07-07
Java類的定義以及執(zhí)行順序?qū)W習(xí)教程
這篇文章主要介紹了Java類的定義以及執(zhí)行順序?qū)W習(xí)教程,包括對象的創(chuàng)建等面向?qū)ο缶幊痰幕A(chǔ)知識(shí),需要的朋友可以參考下2015-09-09
這篇文章主要為大家詳細(xì)介紹了使用session實(shí)現(xiàn)簡易購物車功能，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-02-02
idea項(xiàng)目啟動(dòng)報(bào)錯(cuò),日志包沖突slf4j和logback沖突問題
遇到SLF4J沖突時(shí),可以嘗試移除沖突的綁定或調(diào)整項(xiàng)目依賴,具體方法包括刪除多余的Logger綁定庫,如Logback或Log4j,或在項(xiàng)目配置文件中明確指定使用的日志框架,若使用WebLogic服務(wù)器,需在weblogic.xml中進(jìn)行特定配置,適當(dāng)調(diào)整pom.xml文件中的依賴版本也可能解決問題2024-09-09
SpringBoot中@ComponentScan的使用詳解
這篇文章主要介紹了SpringBoot中@ComponentScan的使用詳解，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-11-11
這篇文章主要介紹了intellij idea配置外部dtd文件的方法,非常不錯(cuò)，具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2018-09-09
Easypoi 輕松實(shí)現(xiàn)復(fù)雜excel文件導(dǎo)出功能
這篇文章主要介紹了Easypoi 輕松實(shí)現(xiàn)復(fù)雜excel文件導(dǎo)出功能，本文通過示例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-11-11
springboot項(xiàng)目關(guān)閉swagger如何防止漏洞掃描
這篇文章主要介紹了springboot項(xiàng)目關(guān)閉swagger如何防止漏洞掃描,本文通過示例代碼給大家介紹的非常詳細(xì),感興趣的朋友跟隨小編一起看看吧2024-05-05
在本篇內(nèi)容里小編給大家整理的是一篇關(guān)于java9在interface中定義私有方法，有興趣的朋友們可以學(xué)習(xí)下。2020-10-10
這篇文章主要介紹了idea導(dǎo)入maven工程的三種方法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04