天天看點

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

問題背景

Lombok同時使用@Data和@Builder ,會出現建構無參構造器報錯!最終導緻編譯不通過。如下圖:

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

Lombok @Data和@Builder分别單獨分析用法

Lombok使⽤@Data可以⽣成⽆參構造和類⾥⾯所有屬性的getter/setter⽅法。可以簡化我們代碼的開發。(需要安裝Lombok插件和引⼊Lombok依賴)。

例如下⾯的⼀個實體類,引⼊Lombok後,可以⾃動⽣成GET/SET⽅法和⽆參構造函數。

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

編譯後的class為:可以看到不僅幫我們生成了get和set ,同時也有預設的無參構造器

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

那麼怎麼自動生成有參構造器呢?使用@Builder注解,将會幫助我們⽣成全屬性的構造方法。

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

編譯後的class可以看到 已經幫我們建構好了全屬性的構造方法,但是如果值隻引用@Builder注解是無法生成get和set的。

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

但是如果同時使⽤@Data和@Builder的話,可以看出盡管⽣成了GET/SET⽅法,但是⽆參構造⽅法沒有了,這顯然是不能接受的,因為很多架構都會調⽤⽆參構造去建立對象。

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

編譯後的class:

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

我們嘗試在Tet1類,⼿動添加⽆參構造⽅法。編譯發現報錯不通過:

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

最新 Java 開發工具教程:​​https://www.javastack.cn/devtools/​​

解決方法

方法一

Lombok同時使⽤@Data和@Builder的時候,如果要⽣成⽆參構造,需要在代碼⾥⾯⼿動引⼊注解@Tolerate,讓Lombok在⽣成類的時候,對指定的構造函數不感覺。

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

方法二

直接使用無參構造器+有參構造器的方式,@RequiredArgsConstructor 來建構有參,@NoArgsConstructor來建構無參構造器,如圖所示:

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

編譯後效果:

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

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 ⾃定義⼀個注解,代碼如下:

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

再實作⼀個⾃定義的注解處理器,代碼如下:

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!
Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!
Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

測試類如下:

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!
  1. 對注解處理器進⾏編譯,随後使⽤注解處理器對類進⾏編譯

⾸先需要先對注解處理器進⾏編譯(javac -cp ⽤于引⼊第三⽅jar包進⾏編譯)

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

然後使⽤注解處理器對這個Person測試類進⾏編譯:

這時候再看⽣成的Person.class,可以發現Setter⽅法已經⽣成了:

Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!
Lombok 同時使用 @Data 和 @Builder 的巨坑,千萬别亂用!

總結

當然盡管測試類已經⽣成Setter⽅法,但是因為是在編譯時期⽣成的,是以我們在開發的時候是沒法直接調⽤Setter⽅法的,是以Lombok提供了插件機制,⽅便我們在開發的時候可以直接去調⽤Lombok的特性。