Lombok同時使⽤@Data和@Builder踩坑總結

問題背景

Lombok使⽤ 同時使⽤@Data和@Builder ,構建無參構造器報錯!編譯不通過。如下圖:

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

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

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

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

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

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

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

編譯後的class: 

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

解決方法

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

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

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

測試類如下:

2.對註解處理器進⾏編譯,隨後使⽤註解處理器對類進⾏編譯

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

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

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

總結

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

到此這篇關於Lombok同時使⽤@Data和@Builder踩坑總結的文章就介紹到這瞭,更多相關Lombok @Data和@Builder內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: