Java agent 使用实例详解

Java agent 是 Java 虚拟机提供的一种高级功能，是实现 JVM 监控和动态修改字节码的重要手段。在本文中，我们将详细讲解 Java agent 的使用方法，帮助读者能够更好的理解和应用该技术。

什么是 Java agent

Java agent 实际上就是一个 Java 程序，在 JVM 启动时通过启动参数指定进程加载并运行，它可以对 Java 应用程序进行监控、管理和修改。

Java agent 的强大功能体现在它可以使用 Instrumentation API 访问 Java 虚拟机中的类信息，这包括了类结构信息及其字节码，因此 Java agent 主要应用在以下两个方向：

• 监控应用程序：Java agent 可以通过 Instrumentation API 来监控应用程序的生命周期和性能指标，例如方法执行时间、内存使用情况等。
• 修改字节码：Java agent 可以通过字节码修改技术，对类的定义进行动态修改，从而实现 AOP、代码注入、热部署等功能。

Java agent 的使用

步骤一：编写 Java agent

Java agent 是一个普通的 Java 程序，它需要实现 premain 方法，并被打包成 jar 包：

public class MyAgent {
    public static void premain(String agentArgs, Instrumentation inst) {
        // TODO: 在此添加 Java agent 代码逻辑
    }
}

步骤二：打包 Java agent

为了让 Java 虚拟机启动时自动加载 Java agent，我们需要将其打包成 jar 包，并在 MANIFEST.MF 文件中指定 premain 类：

Manifest-Version: 1.0
Premain-Class: MyAgent

步骤三：启动 Java agent

在启动 Java 应用程序时，通过加入 -javaagent 参数指定载入的 Java agent，例如：

java -javaagent:/path/to/MyAgent.jar -jar MyApp.jar

示例一：使用 Java agent 监控应用程序

以下示例展示如何使用 Java agent 监控应用程序的方法执行时间：

public class MyAgent {
    public static void premain(String agentArgs, Instrumentation inst) {
        inst.addTransformer(new MethodExecutionTimeTransformer());
    }

    static class MethodExecutionTimeTransformer implements ClassFileTransformer {
        @Override
        public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
                                ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
            ClassReader cr = new ClassReader(classfileBuffer);
            ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_MAXS | ClassWriter.COMPUTE_FRAMES);
            MethodVisitor mv = new MethodExecutionTimeVisitor(cw);

            ClassVisitor cv = new ClassVisitor(Opcodes.ASM9, mv) {};
            cr.accept(cv, ClassReader.SKIP_DEBUG);
            return cw.toByteArray();
        }
    }

    static class MethodExecutionTimeVisitor extends MethodVisitor {
        private final MethodVisitor originalMv;
        private final Label start = new Label();
        private final Label end = new Label();

        public MethodExecutionTimeVisitor(MethodVisitor mv) {
            super(Opcodes.ASM9, mv);
            this.originalMv = mv;
        }

        @Override
        public void visitCode() {
            originalMv.visitCode();
            originalMv.visitLabel(start);
        }

        @Override
        public void visitInsn(int opcode) {
            if ((opcode >= Opcodes.IRETURN && opcode <= Opcodes.RETURN) || opcode == Opcodes.ATHROW) {
                originalMv.visitLabel(end);
                originalMv.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
                originalMv.visitLdcInsn("Method execution time: ");
                originalMv.visitVarInsn(Opcodes.LLOAD, 1);
                originalMv.visitMethodInsn(Opcodes.INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false);
                originalMv.visitInsn(Opcodes.LLOAD);
                originalMv.visitInsn(Opcodes.LSUB);
                originalMv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "java/io/PrintStream", "println", "(J)V", false);
            }
            originalMv.visitInsn(opcode);
        }

        @Override
        public void visitMaxs(int maxStack, int maxLocals) {
            originalMv.visitMaxs(maxStack + 8, maxLocals);
        }

        @Override
        public void visitEnd() {
            originalMv.visitLabel(end);
            originalMv.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
            originalMv.visitLdcInsn("Method execution time: ");
            originalMv.visitInsn(Opcodes.LCONST_0);
            originalMv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "java/io/PrintStream", "println", "(J)V", false);
        }
    }
}

示例二：使用 Java agent 修改字节码

以下示例展示如何使用 Java agent 对类进行动态修改：

public class MyAgent {
    public static void premain(String agentArgs, Instrumentation inst) {
        inst.addTransformer(new HelloWorldTransformer());
    }

    static class HelloWorldTransformer implements ClassFileTransformer {
        @Override
        public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
                                ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
            if ("HelloWorld".equals(className)) {
                ClassReader cr = new ClassReader(classfileBuffer);
                ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_MAXS | ClassWriter.COMPUTE_FRAMES);

                // 修改类的代码
                ClassVisitor cv = new HelloWorldVisitor(cw);
                cr.accept(cv, ClassReader.SKIP_DEBUG);
                return cw.toByteArray();
            }
            return classfileBuffer;
        }
    }

    static class HelloWorldVisitor extends ClassVisitor {
        private final ClassWriter cw;

        public HelloWorldVisitor(ClassWriter cw) {
            super(Opcodes.ASM9, cw);
            this.cw = cw;
        }

        @Override
        public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
            if ("main".equals(name)) {
                MethodVisitor mv = cw.visitMethod(access, name, desc, signature, exceptions);
                return new HelloWorldMethodVisitor(mv);
            }
            return super.visitMethod(access, name, desc, signature, exceptions);
        }
    }

    static class HelloWorldMethodVisitor extends MethodVisitor {
        private final MethodVisitor originalMv;

        public HelloWorldMethodVisitor(MethodVisitor mv) {
            super(Opcodes.ASM9, mv);
            this.originalMv = mv;
        }

        @Override
        public void visitCode() {
            originalMv.visitCode();
            originalMv.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
            originalMv.visitLdcInsn("Hello, World!");
            originalMv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);
        }
    }
}

使用该 Java agent 对如下的 HelloWorld 类进行修改：

public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, ASM!");
    }
}

在运行时加入 -javaagent 参数，输出结果为：

Hello, World!

总结

Java agent 是一个非常强大的 Java 技术，可以用于 JVM 监控和动态修改字节码。掌握 Java agent 的使用方法，有助于我们更好的理解和应用该技术。在本文中，我们介绍了 Java agent 的基本原理和使用方法，并给出了两个实战示例，希望对读者有所帮助。