Lombok原理和同时使⽤@Data和@Builder 的坑

ゝ一世哀愁。 2024-04-05 07:40 31阅读 0赞

### **问题背景** ###

Lombok使⽤ 同时使⽤@Data和@Builder ，构建无参构造器报错！编译不通过。如下图：

![63b32f5b288ef8e1eea575ce7613f167.jpeg][]

### **Lombok @Data和@Builder分别单独分析用法** ###

Lombok使⽤@Data可以⽣成⽆参构造和类⾥⾯所有属性的getter/setter⽅法。可以简化我们代码的开发。（需要安装Lombok插件和引⼊Lombok依赖）。

例如下⾯的⼀个实体类,引⼊Lombok后，可以⾃动⽣成GET/SET⽅法和⽆参构造函数。

![cd3780523eaff343ba64b3c9adcf7b01.png][]

编译后的class为:可以看到不仅帮我们生成了get和set ，同时也有默认的无参构造器

![00d61c6e624ac58bbf720ed4621bb032.jpeg][]

那么怎么自动生成有参构造器呢？使用@Builder注解，将会帮助我们⽣成全属性的构造⽅法。

![e924d6a5d23cc49eb0518dbea182de2f.png][]

编译后的class为：可以看到 已经帮我们构建好了全属性的构造方法，但是如果值只引用@Builder注解是无法生成get和set的。

![7d685daea15be59495d8bb9546c0e068.jpeg][]

但是如果同时使⽤@Data和@Builder的话，可以看出尽管⽣成了GET/SET⽅法，但是⽆参构造⽅法没有了，这显然是不能接受的，因为很多框架都会调⽤⽆参构造去创建对象。

![acc44cd8dad75e2af7554afbf328f943.png][]

编译后的class：

![59fba6652fc9cb3ddea15b5a2c6431f3.jpeg][]

我们尝试在Tet1类，⼿动添加⽆参构造⽅法。编译发现报错不通过：

![63b32f5b288ef8e1eea575ce7613f167.jpeg][]

### **解决方法** ###

### **方法一** ###

Lombok同时使⽤@Data和@Builder的时候，如果要⽣成⽆参构造，需要在代码⾥⾯⼿动引⼊注解@Tolerate，让Lombok在⽣成类的时候，对指定的构造函数不感知。

![015e05b4cb41e484ce978e54d06f412d.jpeg][]

### **方法二** ###

直接使用无参构造器+有参构造器的方式，@RequiredArgsConstructor 来构建有参，@NoArgsConstructor来构建无参构造器，如图所示：

![9370cd4278ef36e38e404d9908abdd24.png][]

编译后效果：

![93fabd812ccbdaeb3dcc442822c5a90a.jpeg][]

### **Lombok原理** ###

Java的编译分为以下⼏个阶段：

解析与填充符号表->注解处理->分析与字节码⽣成->⽣成⼆进制class⽂件。

*  Lombok 使⽤的是 JDK 6 实现的 JSR 269: Pluggable Annotation Processing API (编译期的注解处理器)，它是在编译期时把 Lombok 的注解代码，转换为常规的 Java ⽅法⽽实现注⼊。
 *  在编译期阶段，当 Java 源码被抽象成语法树 (AST) 之后，Lombok 会根据⾃⼰的注解处理器动态的修改AST，增加新的代码 (节点)，在这⼀切执⾏之后，再通过分析⽣成了最终的字节码 (.class) ⽂件，这就是Lombok 的执⾏原理。

可以借助注解处理器实现⼀个简单的 Setter，我们的实现步骤是:

*  ⾃定义⼀个注解标签接⼝，并实现⼀个⾃定义的注解处理器；
 *  利⽤ tools.jar 的 javac api 处理 AST (抽象语法树)3. 使⽤⾃定义的注解处理器编译代码。

1.定义⾃定义注解和注解处理器

⾸先创建⼀个 MySetter.java ⾃定义⼀个注解，代码如下：

![e47aedbee950d7639320ed4cb1960c69.png][]

再实现⼀个⾃定义的注解处理器，代码如下：

![59e7b8aaa2f7ff166fe077541d234ad9.jpeg][]

![ec0eadd43501a9abf5f64a0fec9da771.png][]

测试类如下:

![727c5fb19b198e9008ba139143189b8f.png][]

2.对注解处理器进⾏编译，随后使⽤注解处理器对类进⾏编译

⾸先需要先对注解处理器进⾏编译（javac -cp ⽤于引⼊第三⽅jar包进⾏编译）

![8b87f2f013287908941d21ac98642d6b.jpeg][]

然后使⽤注解处理器对这个Person测试类进⾏编译:

这时候再看⽣成的Person.class，可以发现Setter⽅法已经⽣成了:

![c6b33b097e6bcf61ea9935eeb1083468.png][]

![fc0d5454fde501c26fa726d67602f920.png][]

### **总结** ###

当然尽管测试类已经⽣成Setter⽅法，但是因为是在编译时期⽣成的，因此我们在开发的时候是没法直接调⽤Setter⽅法的，因此Lombok提供了插件机制，⽅便我们在开发的时候可以直接去调⽤Lombok的特性。

[63b32f5b288ef8e1eea575ce7613f167.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/5bc34d7105084703855ab481c59fba4d.jpeg
[cd3780523eaff343ba64b3c9adcf7b01.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/10984aa328134e47b30ac6118084a68a.png
[00d61c6e624ac58bbf720ed4621bb032.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/c6b1dc80c59f4025afdd16d4c3900794.jpeg
[e924d6a5d23cc49eb0518dbea182de2f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/301d86b24b5e412096ac8073f0119a14.png
[7d685daea15be59495d8bb9546c0e068.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/8e1980f335f84285be0b9b03b7a18e38.jpeg
[acc44cd8dad75e2af7554afbf328f943.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/e694d089dc3f49d6b9a0444a6c0cb05e.png
[59fba6652fc9cb3ddea15b5a2c6431f3.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/d47b6e2fb51e421ebda8bd9c44e04b72.jpeg
[015e05b4cb41e484ce978e54d06f412d.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/8eb21001b13a47f796f6761ca5fd4fc0.jpeg
[9370cd4278ef36e38e404d9908abdd24.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/545744e4e91c4113a394100f3dd08460.png
[93fabd812ccbdaeb3dcc442822c5a90a.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/c36862ff4b0b41a8aa2626e2db598c35.jpeg
[e47aedbee950d7639320ed4cb1960c69.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/e2251a7e09224f4a95bb4f742089b82c.png
[59e7b8aaa2f7ff166fe077541d234ad9.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/a30d4d3dfcf84c2aa74512782e03a7cc.jpeg
[ec0eadd43501a9abf5f64a0fec9da771.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/2ea32e0652ab47fb9820685b5bc78cef.png
[727c5fb19b198e9008ba139143189b8f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/02180c87a3154ec9bbb8e5e0ab838bfa.png
[8b87f2f013287908941d21ac98642d6b.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/84f13630e33546a4867ad9394c21d852.jpeg
[c6b33b097e6bcf61ea9935eeb1083468.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/8ee3add85dd44d3fab16256a7d62d5e2.png
[fc0d5454fde501c26fa726d67602f920.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/04/c141876f49714404b8944ea31a839e4f.png