字节码进阶之Lombok底层原理

字节码进阶之Lombok底层原理

前言

例如，我们经常在Java代码中为类的属性生成getter和setter方法，这是一种重复且繁琐的工作。使用Lombok可以极大地简化这个过程。

假设我们有如下的Java类：

public class User {
    private String name;
    private int age;
}

在传统的做法中，我们需要手动为name和age属性生成getter和setter方法，这样的代码既冗长又容易出错。但是，如果我们使用Lombok的@Getter和@Setter注解，代码会变得非常简洁：

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class User {
    private String name;
    private int age;
}

当我们编译这段代码时，Lombok的注解处理器会在背后进行以下操作：

1. 源代码解析：Java编译器首先会解析这段源代码，并生成对应的AST。
2. 注解处理：编译器检测到@Getter和@Setter注解，于是调用对应的Lombok注解处理器。
3. 修改AST：Lombok的注解处理器会识别出name和age属性，然后在AST中添加对应的getter和setter方法。
4. 编译字节码：Java编译器最后会将修改后的AST（现在包括了getter和setter方法）编译成字节码。

这样，当我们在其他代码中使用User类时，可以直接调用getName(), setName(String name), getAge(), setAge(int age)等方法，而无需手动编写它们。

这只是Lombok功能的冰山一角。Lombok还提供了许多其他功能，如@ToString, @EqualsAndHashCode, @NoArgsConstructor, @AllArgsConstructor等，都是通过类似的方式在编译时自动生成对应的代码，从而提高开发效率，减少手写重复和模板代码的需要。

lombok 原理

Lombok并不是直接修改字节码的，而是在编译阶段修改AST（抽象语法树）的。当Java编译器编译代码时，它首先会将源代码转换成一个内部的数据结构，这就是AST。Lombok的核心工作就是在这个阶段介入，修改AST。

Lombok工作原理

1. 源代码到AST：当Java编译器启动时，它首先会将源代码解析为AST。

2. Lombok介入：在AST构建完成后，编译器会检查是否有任何注解处理器要处理这些注解。Lombok就是其中的一个注解处理器。此时，Lombok会识别其自己的注解（例如@Getter、@Setter等）并根据这些注解进行适当的AST修改。

3. AST到字节码：一旦所有的注解处理器都完成了它们的工作，编译器会继续其流程，将（可能已被修改的）AST转换成Java字节码。

这个过程中，Lombok实际上没有直接接触或修改字节码；它只是修改了AST。然后，这些修改会自动地体现在生成的字节码中，因为编译器是从AST生成字节码的。

为了让Lombok能够工作，需要在构建工具或IDE中加入Lombok的注解处理器。例如，在Maven或Gradle项目中，添加Lombok作为依赖即可。这样，在编译过程中，Java编译器就会找到并使用Lombok的注解处理器。

举个简单的例子

假设你有以下的Java类，使用了Lombok的@Data注解，这个注解会为我们自动生成getter、setter、equals、hashCode和toString方法：

import lombok.Data;

@Data
public class Person {
    private String name;
    private int age;
}

在这段代码编译的过程中，Lombok会识别@Data注解并对应的修改AST。

原始的AST可能像这样（这是一个非常简化的版本，仅为了描述）：

Class: Person
    Field: name, Type: String
    Field: age, Type: int

当Lombok介入后，它会根据@Data注解在AST上添加方法，所以修改后的AST可能看起来像这样：

Class: Person
    Field: name, Type: String
    Field: age, Type: int
    Method: getName, Return Type: String
    Method: setName, Parameters: String
    Method: getAge, Return Type: int
    Method: setAge, Parameters: int
    Method: equals, Parameters: Object, Return Type: boolean
    Method: hashCode, Return Type: int
    Method: toString, Return Type: String

然后，编译器会基于这个修改后的AST生成字节码。所以，编译完成后的.class文件会包含所有由Lombok生成的方法，尽管在源代码中这些方法并不存在。

重要的是要记住，AST只是一个编译器内部用于表示源代码结构的中间表示形式。Lombok的魔力在于它可以在这个中间表示形式上进行修改，然后让编译器基于修改后的AST生成字节码，从而实现了在源代码中看不到但在编译后的类中存在的方法和其他结构。

要实际查看AST，需要使用工具或库，例如JavaParser等。但在大多数情况下，开发者并不需要直接与AST交互，除非正在进行某种编译器或工具开发。