前言
最近用了一下午总算把Java agent给跑通了，本篇文章记录一下具体的操作步骤，以免遗忘。下面话不多说，来一起看看详细的介绍：
通过java agent可以动态修改代码（替换、修改类的定义），进行AOP。
目标：
为所有添加@ToString注解的类实现默认的toString方法
需要两个程序，一个是用来测试的程序，一个agent用于修改代码。
1. 测试程序
被测试的程序包括：
- ToString.Java
- Foo.java
- Main.java
具体代码如下：
ToString.java：定义ToString注解
|
1
2
3
4
5
6
7
8
|
package com.chosen0ne.agent.test; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @Retention(RetentionPolicy.RUNTIME) public @interface ToString { } |
Foo.java：很简单用于测试，使用了ToString注解
|
1
2
3
4
5
6
|
package com.chosen0ne.agent.test; @ToStringpublic class Foo { } |
Main.java：
|
1
2
3
4
5
6
7
8
|
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，结果如下：
|
1
|
com.chosen0ne.agent.test.Foo@7852e922 |
可以看到toString返回的是Object的默认实现。
2. Agent程序
java agent程序实际上类似于钩子，有两种方式：
- main函数开始前
- 程序运行中
这里主要测试main函数开始前的情况。类似于main函数，需要实现
|
1
|
public static void premain(String agentArgs, Instrumentation inst); |
这个函数会在main函数之前被调用。可以在premain中，进行字节码操作，替换或重新实现一些类。这里使用Byte Buddy库，在ASM之上提供了更高级的抽象，便于使用。
具体代码如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
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后，执行：
|
1
|
jar cvfm agent.jar MANIFEST.MF -C . com lib |
上述命令打包成的jar包含：
- com：编译生成的class文件
- lib：其依赖的库
2）通过maven直接生成：
通过maven-jar-plugin插件生成jar包，具体配置如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
<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文件放到一个路径下，目录布局如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
|
. ├── agent.jar ├── classes │ └── com │ └── chosen0ne │ └── agent │ └── test │ ├── Foo.class │ ├── Main.class │ └── ToString.class └── lib └── byte-buddy-1.2.3.jar |
在当前目录执行命令：
|
1
|
java -cp classes:lib/byte-buddy-1.2.3.jar -javaagent:agent.jar com.chosen0ne.agent.test.Main |
运行结果如下：
|
1
2
|
print pre main test |
这里需要注意一点，如果将测试程序也打包成jar包的话，那么在通过-cp指定ByteBuddy库时会失败，找不到对应的class，错误如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
> 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运行即可
总结
以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作能带来一定的帮助，如果有疑问大家可以留言交流，谢谢大家对服务器之家的支持。
原文链接：http://blog.csdn.net/chosen0ne/article/details/50790372
