Java Agent原理及实现

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开发的程序的初始指令，比较常见的如IDEA，Python，WebStrom，DataGrip等

示例

下面是一个使用Java Agent实现方法耗时监控的例子：

1. 首先，在maven的pom.xml中加入以下依赖：

<dependency>
    <groupId>org.ow2.asm</groupId>
    <artifactId>asm</artifactId>
    <version>9.1</version>
</dependency>

2. 新建一个类，实现Java Agent的premain方法，同时实现ClassFileTransformer接口来修改类的字节码：

public class TimeTracingAgent {

    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("com/example")) {
                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 {

        private final String CLASS_NAME = "com/example/Test";

        public TimeTracingClassVisitor(ClassVisitor cv) {
            super(Opcodes.ASM5, cv);
        }

        @Override
        public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
            if (!CLASS_NAME.equals(name)) {
                return super.visitMethod(access, name, desc, signature, exceptions);
            }
            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);
        }

        @Override
        public void visitInsn(int opcode) {
            if (opcode >= Opcodes.IRETURN && opcode <= Opcodes.RETURN) {
                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);
            }
            mv.visitInsn(opcode);
        }
    }
}

3. 编写一个简单的测试类：

public class Test {

    public static void main(String[] args    }

    public void test() {
        System.out.println("Test");
    }
}

在运行测试类之前，需要先将TimeTracingAgent打包成一个可执行的agent jar文件，然后在启动程序时，加上以下参数：

-javaagent:/path/to/agent.jar

这样就能在控制台输出程序中每个方法的执行时间了。

总结：

在本文中，我们对Java Agent进行了深入地介绍，包括它的原理、运行机制以及如何使用ASM等字节码操作框架来修改类字节码。Java Agent作为一个非常强大的工具，可以用于应用服务器的诊断和分析工具、AOP、调试器等多种应用场景，而开发者也可以根据自己的业务需求来实现各种各样的agent代码来实现扩展或者监控自己的应用程序。

资源分享

关注【顶尖架构师栈】，回复 C01 获取超10G后端学习面试资源

本文由mdnice多平台发布