快捷導(dǎo)航

Java Agent入門(mén)學(xué)習(xí)之動(dòng)態(tài)修改代碼

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

這篇文章主要給大家分享了Java Agent入門(mén)學(xué)習(xí)之動(dòng)態(tài)修改代碼的相關(guān)資料，文中介紹的非常詳細(xì)，對(duì)大家具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來(lái)一起看看吧。

前言

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

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

目標(biāo)：

為所有添加@ToString注解的類實(shí)現(xiàn)默認(rèn)的toString方法

需要兩個(gè)程序，一個(gè)是用來(lái)測(cè)試的程序，一個(gè)agent用于修改代碼。

1. 測(cè)試程序

被測(cè)試的程序包括：

- 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：很簡(jiǎn)單用于測(cè)試，使用了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ù)開(kāi)始前

- 程序運(yùn)行中

這里主要測(cè)試main函數(shù)開(kāi)始前的情況。類似于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庫(kù)，在ASM之上提供了更高級(jí)的抽象，便于使用。

具體代碼如下：

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，并且對(duì)于premain的方式需要在MANIFEST.MF中指定Premain-Class，用于指明包含premain函數(shù)的類。具體有兩種方式打包：

1）直接通過(guò)jar命令

編輯生成MANIFEST.MF后，執(zhí)行：

jar cvfm agent.jar MANIFEST.MF -C . com lib

上述命令打包成的jar包含：

- com：編譯生成的class文件

- lib：其依賴的庫(kù)

2）通過(guò)maven直接生成：

通過(guò)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>

主要通過(guò)manifestEntries標(biāo)簽生成自動(dòng)的屬性，這里指定了Premain-Class

3. 運(yùn)行

將生成的agent.jar、依賴的ByteBuddy的jar包和測(cè)試程序編譯生成的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)，如果將測(cè)試程序也打包成jar包的話，那么在通過(guò)-cp指定ByteBuddy庫(kù)時(shí)會(huì)失敗，找不到對(duì)應(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é)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來(lái)一定的幫助，如果有疑問(wèn)大家可以留言交流，謝謝大家對(duì)腳本之家的支持。

您可能感興趣的文章: