Java Agent原理及实现
Java Agent是Java SE 5.0版本引入的一个新特性,它可以在Java虚拟机(JVM)启动前或者在运行时动态地读取一些class文件,并在内存中修改后替换原始的class文件,从而在不改变原有代码的情况下增强或者监视应用程序的运行。
在Java Agent中,有两个主要的API:java.lang.instrument和java.lang.ClassFileTransformer。
java.lang.instrument API可以让代理程序注册到JVM中,而java.lang.ClassFileTransformer API允许代理程序使用ASM等字节码操作框架来修改类字节码。当类被加载到JVM时,代理程序就可以使用ClassFileTransformer API来检测并且修改这个类的字节码,使得这个类被加载到JVM后可以被代理程序所处理。
示例下面是一个使用Java Agent实现方法耗时监控的例子:
- 首先,在maven的pom.xml中加入以下依赖:
<dependency> <groupId>org.ow2.asm</groupId> <artifactId>asm</artifactId> <version>9.1</version></dependency>
- 新建一个类,实现Java Agent的premain方法,同时实现ClassFileTransformer接口来修改类的字节码:
package com.dc;import org.objectweb.asm.*;import java.lang.instrument.ClassFileTransformer;import java.lang.instrument.Instrumentation;import java.security.ProtectionDomain;/** * @author Dc.s * @version 1.0 * @description: * @date 2023/06/14/014 17:09:29 */public class TimeTracingAgentTest { public static void premain(String agentArgs, Instrumentation inst) { inst.addTransformer(new TimeTracingTransformer()); } private static class TimeTracingTransformer implements ClassFileTransformer { @Override public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) { // 指定类进行处理 if (className.startsWith("Test")) { ClassReader cr = new ClassReader(classfileBuffer); ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_MAXS); ClassVisitor cv = new TimeTracingClassVisitor(cw); cr.accept(cv, ClassReader.SKIP_FRAMES); return cw.toByteArray(); } return null; } } private static class TimeTracingClassVisitor extends ClassVisitor { public TimeTracingClassVisitor(ClassVisitor cv) { super(Opcodes.ASM5, cv); } @Override public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) { System.out.println(String.format("method name is :%s",name)); MethodVisitor mv = cv.visitMethod(access, name, desc, signature, exceptions); return new TimeTracingMethodVisitor(mv); } } private static class TimeTracingMethodVisitor extends MethodVisitor { public TimeTracingMethodVisitor(MethodVisitor mv) { super(Opcodes.ASM5, mv); } @Override public void visitCode() { /*此处可以加操作字节码文件的逻辑 mv.visitCode(); mv.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;"); mv.visitLdcInsn("Start: " + System.currentTimeMillis()); mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "java/io/", "println", "(Ljava/lang/String;)V", false);*/ System.out.println("Start: " + System.currentTimeMillis()); } @Override public void visitInsn(int opcode) { /* 此处可以加操作字节码文件的逻辑 mv.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;"); mv.visitLdcInsn("End: " + System.currentTimeMillis()); mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);*/ if (opcode >= Opcodes.IRETURN && opcode <= Opcodes.RETURN) { System.out.println("End: " + System.currentTimeMillis()); } mv.visitInsn(opcode); } }}
- 编写一个简单的测试类:
public class Test { public static void main(String[] args } public void test() { System.out.println("Test"); }}
在运行测试类之前,需要先将TimeTracingAgent打包成一个可执行的agent jar文件,在打包时需要注意:
需要把依赖一起打入jar包,我使用的是IDEA,需要在pom.xml中加入一下配置
<build> <plugins> <!-- Maven Assembly Plugin --> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-assembly-plugin</artifactId> <version>3.3.0</version> <configuration> <!-- get all project dependencies --> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> <!-- MainClass in mainfest make a executable jar --> <archive> <!--自动添加META-INF/MANIFEST.MF --> <manifest> <addClasspath>true</addClasspath> </manifest> <manifestEntries> <Premain-Class>com.dc.TimeTracingAgentTest</Premain-Class> <Agent-Class>com.dc.TimeTracingAgentTest</Agent-Class> <Can-Redefine-Classes>true</Can-Redefine-Classes> <Can-Retransform-Classes>true</Can-Retransform-Classes> </manifestEntries> </archive> </configuration> <executions> <execution> <id>make-assembly</id> <!-- bind to the packaging phase --> <phase>package</phase> <goals> <goal>single</goal> </goals> </execution> </executions> </plugin> </plugins> </build>
这样在打包后就会有两个jar包:
选择使用下面的带有依赖的jar,然后在启动程序时,加上以下参数:
-javaagent:/path/to/agent.jarcmd窗口操作
javac Test.javajava -javaagent:/path/to/agent.jar Test
这样就能在控制台输出程序中每个方法的执行时间了。
总结:在本文中,我们对Java Agent进行了简单的介绍,包括它的原理、运行机制以及如何使用ASM等字节码操作框架来修改类字节码。
Java Agent作为一个非常强大的工具,可以用于应用服务器的诊断和分析工具、AOP、调试器等多种应用场景,而开发者也可以根据自己的业务需求来实现各种各样的agent代码来实现扩展或者监控自己的应用程序。
资源分享关注【顶尖架构师栈】,回复 C01 获取超10G后端学习面试资源
本文由mdnice多平台发布
文章知识点与官方知识档案匹配,可进一步学习相关知识