Java Agent入門學習之動態(tài)修改代碼

更新時間：2017年07月06日 11:40:41 作者：chosen0ne

這篇文章主要給大家分享了Java Agent入門學習之動態(tài)修改代碼的相關資料，文中介紹的非常詳細，對大家具有一定的參考學習價值，需要的朋友們下面來一起看看吧。

前言

最近用了一下午總算把Java agent給跑通了，本篇文章記錄一下具體的操作步驟，以免遺忘。下面話不多說，來一起看看詳細的介紹：

通過java agent可以動態(tài)修改代碼（替換、修改類的定義），進行AOP。

目標：

為所有添加@ToString注解的類實現默認的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的默認實現。

2. Agent程序

java agent程序實際上類似于鉤子，有兩種方式：

- main函數開始前

- 程序運行中

這里主要測試main函數開始前的情況。類似于main函數，需要實現

public static void premain(String agentArgs, Instrumentation inst);

這個函數會在main函數之前被調用?？梢栽趐remain中，進行字節(jié)碼操作，替換或重新實現一些類。這里使用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函數的類。具體有兩種方式打包：

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運行即可

總結

以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作能帶來一定的幫助，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。

您可能感興趣的文章:

Java面試題沖刺第十天--MyBatis2
這篇文章主要為大家分享了最有價值的三道MyBatis框架面試題，涵蓋內容全面，包括數據結構和算法相關的題目、經典面試編程題等，感興趣的小伙伴們可以參考一下
2021-07-07
Java類的定義以及執(zhí)行順序學習教程
這篇文章主要介紹了Java類的定義以及執(zhí)行順序學習教程,包括對象的創(chuàng)建等面向對象編程的基礎知識,需要的朋友可以參考下
2015-09-09
使用session實現簡易購物車功能
這篇文章主要為大家詳細介紹了使用session實現簡易購物車功能，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2022-02-02
idea項目啟動報錯,日志包沖突slf4j和logback沖突問題
遇到SLF4J沖突時,可以嘗試移除沖突的綁定或調整項目依賴,具體方法包括刪除多余的Logger綁定庫,如Logback或Log4j,或在項目配置文件中明確指定使用的日志框架,若使用WebLogic服務器,需在weblogic.xml中進行特定配置,適當調整pom.xml文件中的依賴版本也可能解決問題
2024-09-09
SpringBoot中@ComponentScan的使用詳解
這篇文章主要介紹了SpringBoot中@ComponentScan的使用詳解，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2021-11-11
intellij idea配置外部dtd文件的方法
這篇文章主要介紹了intellij idea配置外部dtd文件的方法,非常不錯，具有一定的參考借鑒價值，需要的朋友可以參考下
2018-09-09
Easypoi 輕松實現復雜excel文件導出功能
這篇文章主要介紹了Easypoi 輕松實現復雜excel文件導出功能，本文通過示例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下
2021-11-11
springboot項目關閉swagger如何防止漏洞掃描
這篇文章主要介紹了springboot項目關閉swagger如何防止漏洞掃描,本文通過示例代碼給大家介紹的非常詳細,感興趣的朋友跟隨小編一起看看吧
2024-05-05
java9在interface中定義私有方法詳解
在本篇內容里小編給大家整理的是一篇關于java9在interface中定義私有方法，有興趣的朋友們可以學習下。
2020-10-10
idea導入maven工程的三種方法
這篇文章主要介紹了idea導入maven工程的三種方法，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2021-04-04