Java Agent入门学习之动态修改代码

前言

最近用了一下午总算把java agent给跑通了，本篇文章记录一下具体的操作步骤，以免遗忘。下面话不多说，来一起看看详细的介绍：

通过java agent可以动态修改代码（替换、修改类的定义），进行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()); 
 } 
} 

执行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函数之前被调用。可以在premain中，进行字节码操作，替换或重新实现一些类。这里使用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后，执行：

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 

在当前目录执行命令：

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

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作能带来一定的帮助，如果有疑问大家可以留言交流，谢谢大家对的支持。