用ASM字节码框架生成Lombok插件的Getter、Setter方法

前言

本文部分内容摘自书籍：《深入理解JVM字节码》

文章目录

1. 回顾Lombok用法
2. 查看POJO类底层字节码(.class)
3. ASM字节码框架简介
4. 属性类型映射表
5. 方法简单描述
6.测试
7.注意事项

回顾Lombok用法

1.导包lombok-1.18.12.jar
2.Idea下载lombok插件

用法：
POJO类内定义好属性，类上顶个@Data注解，Lombok插件就会自动帮属性生成了Getter、Setter。并帮这个类重写了equals、toString

思考问题: 明明类内没有定义方法，安个插件，导个包，就好使了。底层到底是怎么做的呢？

查看POJO类底层字节码(.class)

使用javap -c 查看person类的字节码情况


Lombok在Person类中生成了Getter、Setter、toString方法。。。方法体内都是一条条的指令

另外，在Lombok的jar包下也用到了ASM字节码框架

ASM字节码框架简介

转载自：https://www.cnblogs.com/benwu/articles/8168122.html

属性类型映射表

.class	.java
B	byte
C	char
D	double
F	float
I	int
J	long
S	short
Z	boolean
L ClassName;	引用类型，“L” + 对象类型的类全名 + “;”
[	一维数组

方法简单描述

.class	.java
(FDLjava/lang/String;)Ljava/lang/String;---->(参数列表)返回值	public String test(float f, double d, String s){ }

生成Getter、Setter方法

1.建立一个类 定义ClassReader、ClassWriter、ClassVisitor、Flie为成员属性，创建映射表内部类

import org.apache.commons.io.FileUtils;

import java.io.File;
import java.io.IOException;
import java.lang.reflect.Field;
import java.util.HashMap;
import java.util.Map;

/**
 * 使用ASM字节码框架 往POJO类注入getter setter 方法
 */
public class POJOHandler {

    private ClassReader reader;
    private ClassWriter writer;
    private ClassVisitor cv;
    private File file;


	/**
     * Java中数据类型和Java字节码中数据类型的表示方式的对应关系
     */
    private static class TypeList{
        private static final Map<String,String> typeMap = new HashMap<>(7);
        private static final Map<String,Class> classMap = new HashMap<>(7);

        static {
            typeMap.put("String","Ljava/lang/String;");
            typeMap.put("Integer","Ljava/lang/Integer;");
            typeMap.put("Double","Ljava/lang/Double;");
            typeMap.put("Float","Ljava/lang/Float;");
            typeMap.put("Short","Ljava/lang/Short;");
            typeMap.put("Boolean","Ljava/lang/Boolean;");
            typeMap.put("Long","Ljava/lang/Long;");

            classMap.put("String",String.class);
            classMap.put("Integer",Integer.class);
            classMap.put("Double",Double.class);
            classMap.put("Float",Float.class);
            classMap.put("Short",Short.class);
            classMap.put("Boolean",Boolean.class);
            classMap.put("Long",Long.class);
        }

        public static String getType(String type){
            return typeMap.get(type);
        }

        public static Class getClass(String type){
            return classMap.get(type);
        }

    }
}

2.设计方法 读取类.class文件，转化成byte[]形式

/**
     * 获取当前要注入Getter/Setter的类的.class文件 (电脑硬盘上)
     * 将.class文件内容按照字节形式读取上来解析
     * @param currentClass
     * @return
     */
    public byte[] getClassBytes(Class currentClass) throws IOException {
        // 获取当前类的全名 data.Person
        String className = currentClass.getName();
        // 读取电脑硬盘上的当前工程下当前类的.class文件 将类全名转化成data/Person.class
        String fileName = className.replace(".","/") + ".class";
        // 使用ClassLoader类加载器获取电脑硬盘上的当前工程下当前类的.class文件路径
        String classFilePath = ClassLoader.getSystemResource(fileName).getPath();
        // 创建File对象 映射到硬盘上的文件
        file = new File(classFilePath);
        // 使用commons-io-2.7.jar包下的文件工具 将文件内容以字节形式读取上来
        byte[] classBytes = FileUtils.readFileToByteArray(file);

        return classBytes;
    }

3.设计方法 对类的.class文件进行修改

ClassReader负责读取类文件字节数组，accept调用之后ClassReader会把解析Class文件过程中的事件源源不断地通知给ClassVisitor对象调用不同的visit方法，ClassVisitor可以在这些visit方法中对字节码进行修改，ClassWriter的toByteArray方法则把最终修改的字节码以byte数组对原始的字节码做修改

/**
     * 通过类的属性 通过字节码创建方法 往方法内注入组成方法的字节码
     * @param currentClass
     * @param classBytes 要被ClassReader解析的类文件的字节码
     */
    public void injectMethod(Class currentClass, byte[] classBytes) throws IOException {
        // 获取类的 包名加类名 格式化成文件路径的形式
        String classFullName = currentClass.getName().replace(".","/");
        // 获取这个类的全部属性
        Field[] fields = currentClass.getDeclaredFields();
        // 用ASM提供的ClassReader解析字节码
        reader = new ClassReader(classBytes);
        // ASM提供的ClassWriter 生成最终修改过的字节码
        writer = new ClassWriter(ClassWriter.COMPUTE_MAXS | ClassWriter.COMPUTE_FRAMES);
        // 开始访问 并开始修改类的字节码结构
        cv = new ClassVisitor(Opcodes.ASM5, writer) {
            @Override
            public void visitEnd() {

                // 循环类的属性 给每一个属性加Getter Setter方法
                for(Field field : fields){
                    // 获取属性名字
                    String fieldName = field.getName();
                    // 将属性名字第一个字母大写 拼装成方法名 name-->Name
                    String fieldUpperName = fieldName.substring(0,1).toUpperCase() + fieldName.substring(1);
                    // 获取属性在字节码里表示的类型
                    String typeSimpleName = field.getType().getSimpleName();
                    // 获取属性的类型在字节码中的形式 String --> Ljava/lang/String;
                    String fieldCodeType = TypeList.getType(typeSimpleName);
                    // 获取属性类型的class
                    Class fieldType = TypeList.getClass(typeSimpleName);

                    // get set 方法名
                    String getMethodName = "get" + fieldUpperName;
                    String setMethodName = "set" + fieldUpperName;

                    // TODO get方法
                    // 需要一个MethodVisit访问类中的方法 生成get方法
                    // 参数：权限修饰符、方法名、方法参数列表和返回值类型、方法签名、免责条款
                    MethodVisitor getMV = cv.visitMethod(Opcodes.ACC_PUBLIC, getMethodName, "()" + fieldCodeType, null, null);
                    getMV.visitCode();
                    // 往方法内注入字节码指令
                    // 1.获取方法内的this
                    getMV.visitVarInsn(Opcodes.ALOAD,0);
                    // 2.                 获取属性的指令     属性所属的类        属性名字         属性的类型
                    getMV.visitFieldInsn(Opcodes.GETFIELD, classFullName, fieldName, Type.getDescriptor(fieldType));
                    // 3.将属性的值返回出去
                    getMV.visitInsn(Opcodes.ARETURN);
                    // 4.设置栈大小和局部变量表大小
                    getMV.visitMaxs(2,1);
                    if(getMV != null){
                        getMV.visitEnd();
                    }

                    // TODO set方法                                                                set方法有参数无返回值(Void)
                    MethodVisitor setMV = cv.visitMethod(Opcodes.ACC_PUBLIC,setMethodName,"(" + fieldCodeType + ")V",null,null);
                    setMV.visitCode();
                    // 获取this
                    setMV.visitVarInsn(Opcodes.ALOAD,0);
                    // 获取参数列表中的第一个数
                    setMV.visitVarInsn(Opcodes.ALOAD, 1);
                    // 给属性赋值
                    setMV.visitFieldInsn(Opcodes.PUTFIELD, classFullName, fieldName, fieldCodeType);
                    // void方法要加上return指令
                    setMV.visitInsn(Opcodes.RETURN);
                    setMV.visitMaxs(2,2);
                    if(setMV != null){
                        setMV.visitEnd();
                    }

                }
            }
        };
        // 解析字节码文件 并执行ClassVisitor中的重写的方法
        reader.accept(cv,0);

        // 将最终修改好的字节码 用ClassWriter将其转成byte[]形式 写回文件
        byte[] bytesModified = writer.toByteArray();
        FileUtils.writeByteArrayToFile(file, bytesModified);
    }

测试

1.创建POJO类

2.调handler方法，注入Getter、Setter方法

3.使用Getter、Setter方法，代码报错爆红也可以直接运行，最后获取结果

注意事项

注入Getter、Setter方法的方法可以执行多次，如果这么做，实例化animal对象时会报错误：ClassFormatError。
因为一旦向字节码文件进行修改，便是永久性写入文件内了，在执行一次的话，就会有多个重名的方法在.class文件内，类加载的就会报错。本文只执行了一次，就注释掉，调用对象的Getter、Setter方法了。
解决方法：在注入Getter、Setter的visitEnd方法内用反射技术判断这个类到底有没有这个方法，没有就注入

如有错误，请多多指正！
码字不易，觉得不错点个赞呗！！