如何使用ASM获取类方法内的局部变量名与值？

嘿，我来帮你搞定这个问题！首先得明确两个核心点：局部变量名称是存在字节码的LocalVariableTable属性里的（前提是编译类时保留了调试信息），而局部变量的值是方法运行时的动态状态，静态分析拿不到，得靠字节码注入来捕获。下面分两种场景给你详细讲：

一、静态提取局部变量名称（不需要运行代码） #

如果只是想拿到方法定义里的局部变量名，用ASM静态解析字节码就可以，步骤如下：

1. 确保目标类带调试信息编译 #

编译Java类时一定要加-g参数（比如javac -g TargetClass.java），否则字节码里不会包含LocalVariableTable，ASM只能拿到变量的索引和类型，拿不到名称。

2. 编写ASM解析代码 #

核心是自定义MethodVisitor，重写visitLocalVariable方法——ASM会在解析到局部变量时回调这个方法，直接就能拿到变量名：

import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;

public class LocalVarNameExtractor {
    public static void extractVarNames(String targetClassName) throws Exception {
        ClassReader classReader = new ClassReader(targetClassName);
        classReader.accept(new ClassVisitor(Opcodes.ASM9) {
            @Override
            public MethodVisitor visitMethod(int access, String methodName, String methodDesc, String signature, String[] exceptions) {
                MethodVisitor mv = super.visitMethod(access, methodName, methodDesc, signature, exceptions);
                // 给每个方法绑定自定义的MethodVisitor，处理局部变量
                return new MethodVisitor(Opcodes.ASM9, mv) {
                    @Override
                    public void visitLocalVariable(String varName, String varTypeDesc, String signature, org.objectweb.asm.Label start, org.objectweb.asm.Label end, int index) {
                        super.visitLocalVariable(varName, varTypeDesc, signature, start, end, index);
                        // 这里可以把变量信息存起来或者直接输出
                        System.out.printf("方法[%s]中的局部变量：名称=%s，类型描述符=%s，局部表索引=%d%n", 
                                        methodName, varName, varTypeDesc, index);
                    }
                };
            }
        }, ClassReader.SKIP_DEBUG); // SKIP_DEBUG不影响LocalVariableTable的解析，放心用
    }

    public static void main(String[] args) throws Exception {
        extractVarNames("com.example.TargetClass"); // 替换成你的目标类全限定名
    }
}

二、运行时捕获局部变量的值 #

如果要拿到方法执行时局部变量的实际值，就得通过字节码注入，在方法的合适位置插入代码来捕获值。这里给你一套可运行的方案：

1. 编写字节码注入器 #

自定义ClassVisitor和MethodVisitor，在局部变量的作用域内插入代码，调用日志工具输出变量值：

import org.objectweb.asm.ClassWriter;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;

public class LocalVarValueInjector extends ClassVisitor {
    private final String targetMethodName;
    private final String targetMethodDesc;

    public LocalVarValueInjector(ClassWriter cw, String targetMethodName, String targetMethodDesc) {
        super(Opcodes.ASM9, cw);
        this.targetMethodName = targetMethodName;
        this.targetMethodDesc = targetMethodDesc;
    }

    @Override
    public MethodVisitor visitMethod(int access, String methodName, String methodDesc, String signature, String[] exceptions) {
        MethodVisitor mv = super.visitMethod(access, methodName, methodDesc, signature, exceptions);
        // 只处理我们目标的方法
        if (methodName.equals(targetMethodName) && methodDesc.equals(targetMethodDesc)) {
            return new MethodVisitor(Opcodes.ASM9, mv) {
                @Override
                public void visitLocalVariable(String varName, String varTypeDesc, String signature, org.objectweb.asm.Label start, org.objectweb.asm.Label end, int index) {
                    super.visitLocalVariable(varName, varTypeDesc, signature, start, end, index);
                    // 在变量作用域的起始位置插入日志代码
                    mv.visitLabel(start);
                    // 根据变量类型加载值到操作数栈，然后调用日志方法
                    switch (varTypeDesc.charAt(0)) {
                        case 'I': // int类型
                            mv.visitVarInsn(Opcodes.ILOAD, index);
                            mv.visitLdcInsn(varName);
                            mv.visitMethodInsn(Opcodes.INVOKESTATIC, "com/example/VarLogger", "logInt", "(Ljava/lang/String;I)V", false);
                            break;
                        case 'L': // 对象类型（比如String、自定义类）
                            mv.visitVarInsn(Opcodes.ALOAD, index);
                            mv.visitLdcInsn(varName);
                            mv.visitMethodInsn(Opcodes.INVOKESTATIC, "com/example/VarLogger", "logObject", "(Ljava/lang/String;Ljava/lang/Object;)V", false);
                            break;
                        // 可以扩展其他类型：long('J')、float('F')、double('D')等
                    }
                }
            };
        }
        return mv;
    }
}

2. 编写日志辅助类 #

需要一个简单的工具类来接收并打印变量值：

package com.example;

public class VarLogger {
    public static void logInt(String varName, int value) {
        System.out.printf("局部变量[%s]的当前值：%d%n", varName, value);
    }

    public static void logObject(String varName, Object value) {
        System.out.printf("局部变量[%s]的当前值：%s%n", varName, value);
    }
}

3. 用Java Agent实现运行时修改 #

通过Java Agent可以在类加载时修改字节码，这样不需要修改原代码就能捕获变量值：

import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.Instrumentation;
import java.security.ProtectionDomain;
import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassWriter;

public class LocalVarAgent {
    public static void premain(String agentArgs, Instrumentation inst) {
        inst.addTransformer(new ClassFileTransformer() {
            @Override
            public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) {
                // 只处理目标类
                if ("com/example/TargetClass".equals(className)) {
                    ClassReader cr = new ClassReader(classfileBuffer);
                    ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_FRAMES);
                    // 指定要处理的目标方法名和描述符（比如方法是public void test(String name)，描述符是(Ljava/lang/String;)V）
                    LocalVarValueInjector injector = new LocalVarValueInjector(cw, "test", "(Ljava/lang/String;)V");
                    cr.accept(injector, ClassReader.SKIP_FRAMES);
                    return cw.toByteArray();
                }
                return null;
            }
        });
    }
}

最后把Agent类打包成Jar，运行时加上-javaagent:your-agent.jar参数，就能在目标方法执行时看到局部变量的实时值了。

关键注意事项 #

• 调试信息是基础：如果目标类没加-g编译，visitLocalVariable不会被回调，只能通过变量索引处理，但拿不到名称。
• 作用域要注意：插入的代码必须在变量的start和end标签之间，否则会抛出字节码验证错误。
• 类型覆盖：上面的例子只处理了int和对象类型，你可以根据需求扩展其他基本类型的处理逻辑。

内容的提问来源于stack exchange，提问作者user1174152