Lombok工作原理和使用

朱雀 2022-10-06 04:55 139阅读 0赞

# **Lombok工作原理** #

在Lombok使用的过程中，只需要添加相应的注解，无需再为此写任何代码。自动生成的代码到底是如何产生的呢？

核心之处就是对于注解的解析上。JDK5引入了注解的同时，也提供了两种解析方式。

1运行时解析

运行时能够解析的注解，必须将@Retention设置为RUNTIME，这样就可以通过反射拿到该注解。java.lang.reflect反射包中提供了一个接口AnnotatedElement，该接口定义了获取注解信息的几个方法，Class、Constructor、Field、Method、Package等都实现了该接口，对反射熟悉的朋友应该都会很熟悉这种解析方式。

2编译时解析

编译时解析有两种机制，分别简单描述下：

a）Annotation Processing Tool

apt自JDK5产生，JDK7已标记为过期，不推荐使用，JDK8中已彻底删除，自JDK6开始，可以使用Pluggable Annotation Processing API来替换它，apt被替换主要有2点原因：

\[1\]api都在com.sun.mirror非标准包下

\[2\]没有集成到javac中，需要额外运行

b）Pluggable Annotation Processing API

[JSR 269][]自JDK6加入，作为apt的替代方案，它解决了apt的两个问题，javac在执行的时候会调用实现了该API的程序，这样我们就可以对编译器做一些增强，javac执行的过程如下：

![1dde17dae4a21d27b87dc5d1adec0683.png][]

图1

Lombok本质上就是一个实现了“[JSR 269 API][]”的程序。在使用javac的过程中，它产生作用的具体流程如下：

1.javac对源代码进行分析，生成了一棵抽象语法树（AST）

2.运行过程中调用实现了“JSR 269 API”的Lombok程序

3.此时Lombok就对第一步骤得到的AST进行处理，找到@Data注解所在类对应的语法树（AST），然后修改该语法树（AST），增加getter和setter方法定义的相应树节点

4.javac使用修改后的抽象语法树（AST）生成字节码文件，即给class增加新的节点（代码块）

通过读Lombok源码，发现对应注解的实现都在HandleXXX中，比如@Getter注解的实现在HandleGetter.handle()。还有一些其它类库使用这种方式实现，比如[Google Auto][]、[Dagger][]等等。

# **Lombok使用** #

**下面介绍一下常用的几个注解：**

**@Setter** 注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。

**@Getter** 使用方法同上，区别在于生成的是getter方法。

**@ToString** 注解在类，添加toString方法。调用toString()方法，可以输出实体类中所有属性的值。

**@EqualsAndHashCode** 注解在类，生成hashCode和equals方法。

**@NoArgsConstructor** 注解在类，生成无参的构造方法。

**@RequiredArgsConstructor** 注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。

**@AllArgsConstructor** 注解在类，生成包含类中所有字段的构造方法。

**@Data** 注解在类，生成setter/getter、equals、canEqual、hashCode、toString、EqualsAndHashCode、RequiredArgsConstrutor方法，如为final属性，则不会为该属性生成setter方法。

**@Slf4j** 注解在类，生成log变量，严格意义来说是常量。private static final Logger log = LoggerFactory.getLogger(UserController.class);

接下来我们编辑一个实体类Student，添加几个属性，最后在类上添加@Data属性，这个注解可以帮我们在.class文件中生成类中所有属性的get/set方法、equals、canEqual、hashCode、toString方法等。

![52d5d06daa6dad07e7e5d607e0a041ea.png][]

图2

这是之前没有加@Data注解的写法的对比会发现加了注解的代码少了get/set方法。

![4e9c74d1a7c65ba2ff650f617fe75b90.png][]

图3

下面创建一个类进行测试，发现没有get/set方法的实体类加了注解以后也是可以正常调用get/set方法的。

![d1c2c94656311f5136cb0501679d339f.png][]

图4

下一篇[Lombok优缺点和总结][Lombok]

[JSR 269]: https://jcp.org/en/jsr/detail?id=269
[1dde17dae4a21d27b87dc5d1adec0683.png]: /images/20221005/12844810706a4b8a84ecbbcd77f6632c.png
[JSR 269 API]: https://www.jcp.org/en/jsr/detail?id=269
[Google Auto]: https://github.com/google/auto
[Dagger]: http://square.github.io/dagger/
[52d5d06daa6dad07e7e5d607e0a041ea.png]: /images/20221005/d3512daeb04a47ed9fba05d6a81b3808.png
[4e9c74d1a7c65ba2ff650f617fe75b90.png]: /images/20221005/f9b15b4f1b524c79b2453e69ca661e18.png
[d1c2c94656311f5136cb0501679d339f.png]: /images/20221005/04bb69f6216445e7b938879605ff6e68.png
[Lombok]: https://blog.csdn.net/qq_35685189/article/details/117809756?spm=1001.2014.3001.5501