點選上方藍色字型，選擇“設為星标”
優質文章，及時送達
聽說隔壁用 Lombok 的六點就下班了，我也想六點下班！
好的，那麼這篇文章就介紹下 什麼是 Lombok， Lombok 做了什麼以及 Lombok 是怎麼做的？在介紹之前，先通過是否使用 Lombok 的效果來看下對比，首先來看下沒有 Lombok 之前，我們的一個簡單的 Java 對象(POJO)是長什麼樣子的：
哦，我的天啊，居然 60 行，好長啊！那我們接下來使用的 Lombok 來試下：
什麼，隻使用了
@Data
注解就可以實作之前 60 行的相同功能，代碼長度整整縮小了 3 倍，這麼神奇的嘛？那麼讓我們走進 Lombok 吧！
什麼是 Lombok？
下面是 Lombok 官網的簡介：
Lombok 簡介 簡而言之就是 Lombok 是一個很友善的插件，本質是個 Java 庫，使用它通過相關注解就可以不用再編寫冗長的 getter 或者 equals 等方法了。接下來講下 Lombok 實作的原理，這樣就知道為什麼要這樣使用 Lombok 的注解了。
Lombok 實作原理
要講 Lombok 的實作原理，在此之前就需要來說下注解的兩種解析方式： 運作時注解和 編譯時注解。首先來看下 運作時解析，比如 Spring 配置的 AOP 切面這些注解都是在程式運作的時候通過反射來擷取的注解值，但是隻有在程式運作時才能擷取到這些注解值，導緻運作時代碼效率很低，并且如果想在編譯階段利用這些注解來進行檢查，比如對使用者的不合理代碼作出錯誤報告，反射的方法就行不通了。這就引出了第二種在 編譯時解析，Lombok 工具就是運作在編譯時解析的。那如何把注解與 Java 編譯器結合使用呢？Java 也提供了兩種解決方案：第一種方案是 注解處理器(Annotation Processing Tool)，它最早是在 JDK 1.5 與 注解(Annotation) 一起引入的，它是一個指令行工具，能夠提供建構時基于源代碼對程式結構的讀取功能，能夠通過運作注解處理器來生成新的中間檔案，進而影響編譯過程，不過它在 JDK 1.8 中被移除了，取而代之的是 JSR 269 插入式注解處理器(Pluggable Annotation Processing API)，它是實作了 JSR 269 的機制，作為注解處理器的替代方案。我們通過一個流程圖來進一步說明注解處理器的工作原理：
首先寫完代碼後會調用
javac
編譯，在編譯後會 生成抽象文法樹(AST)，之後會調用 插入式注解處理器處理，上面說了插入式注解處理器會修改文法樹，生成一些額外的代碼，經過處理器的處理文法樹會有變動，有變動之後，會再次到生成抽象文法樹的處理環節，将變動後的代碼再次生成抽象文法樹，接着再通過注解處理器，如果這次文法樹沒有被修改，那麼就會 生成響應的位元組碼，變成 class 檔案，以上就是整個注解處理器在整個
javac
編譯源代碼生成 class 檔案中起到的作用。在簡單了解了 Lombok 實作原理後，讓我們看下 Lombok 有哪些常見的注解：
Lombok 注解
下面是整理的常用的 Lombok 注解思維導圖：
Lombok 注解 右側上方的
@Getter、@Setter、@ToString、@EqualsAndHashCode
這幾個名字大家都不陌生，無非就是幫我們生成對應的方法，這四個注解的總和也就是剛開始用的注解
@Data
，這些注解都歸結為常見方法的注解。右側下方的
@AllArgsConstructor、@RequiredArgsConstructor、@NoArgsConstructor
分别為全參構造函數、必須參數構造函數、無參構造函數，它們通常為構造方法的注解。左側的
@NonNull
會自動生成空值校驗；
@CleanUp
會自動調用變量的
close
方法釋放資源；
@Builder
會自動生成構造者模式，友善對屬性
set/get
操作；
@Synchronized
會自動生成同步鎖；
@SneakyThrows
會自動生成
try/catch
捕捉異常；
@Slf4j
是日志相關的，會自動為類添加日志支援。以上就是 Lombok 為我們提供的比較常用的注解。
Lombok 使用
首先需要安裝 Lombok 插件，我在這裡是以 IDEA 2019.3.1 版本來示範的：
安裝 Lombok 插件
點選 File->Settings->Plugins，搜尋
Lombok
，然後點選安裝 Lombok 插件：
在安裝完插件後重新開機 IDEA，到此 Lombok 插件就安裝完成了，接下來就要進行實踐示範了：
Lombok 常用注解示範
首先在 pom 檔案中引入依賴：
org.projectlomboklombok1.18.12provided
其中
provided
表示 jar 包是運作在編譯時的，當程式編譯成 class 源代碼後，這個 jar 包就不會在源代碼層面有所展現。接下來示範 Lombok 注解使用方式，并通過檢視編譯後 class 檔案，了解其工作原理，在這裡以
@Getter
注解為例：首先建立一個 GetterDemo 類，其中有
name
和
age
兩個字段。
package com.wupx.lombok;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NonNull;
public class GetterDemo {
@Getter(value = AccessLevel.PRIVATE, onMethod_ = {@NonNull})
private String age;
@Getter(lazy = true)
private final String name = "wupx";
}
我們在變量
age
上加上注解
@Getter
，并且加上了參數來設定通路級别，通過
onMethod_
參數可以為我們在生成的
getAge
方法添加上其他注解，比如
@NonNull
；在
name
上加上
@Getter
注解，并加上
lazy
參數并設為
true
，表示開啟懶加載。接下來編譯下，編譯的 class 源代碼如下：
package com.wupx.lombok;
import java.util.concurrent.atomic.AtomicReference;
import lombok.NonNull;
public class GetterDemo {
private String age;
private final AtomicReference name = new AtomicReference();
public GetterDemo() {
}
@NonNull
private String getAge() {
return this.age;
}
public String getName() {
Object value = this.name.get();
if (value == null) {
synchronized(this.name) {
value = this.name.get();
if (value == null) {
String actualValue = "wupx";
value = "wupx" == null ? this.name : "wupx";
this.name.set(value);
}
}
}
return (String)((String)(value == this.name ? null : value));
}
}
可以發現生成後的源代碼檔案中，
getAge
方法通路修飾符為
private
，并且方法上有一個
@NonNull
的注解；
getName
方法沒有剛開始就初始化一個字元串，而是隻有調用該方法的時候判斷該字段是否為空，若為空，則初始化一個字元串并傳回，這樣就可以為開銷大的初始化操作做一個懶加載，隻有當使用的時候才會主動加載這個字段。其他的注解方法大家可以自己去實踐操作下。
Lombok 優缺點
在了解完 Lombok 之後，讓我們來分析下 Lombok 的優缺點吧！Lombok 的優點有以下幾點：
- 通過注解自動生成樣闆代碼，提高開發效率
- 代碼簡潔，隻關注相關屬性
- 新增屬性後，無需刻意修改相關方法
但是 Lombok 也有一些缺點：
- 降低了源代碼的可讀性和完整性
- 加大對問題排查的難度(可能問題定位到不存在的行，無從下手)
- 強 x 隊友，因為需要 IDE 的相關插件的支援
總結
本文介紹了什麼是 Lombok，Lombok 做了什麼以及 Lombok 的實作原理，并且分析了 Lombok 的利弊，大家在享受到它的好處的同時，也應該考慮到它帶來的一些問題，你在工作中有被隊友強 x 嗎？你對 Lombok 怎麼看？
- 面試官問：MySQL的自增ID用完了，怎麼辦？
- ArrayList插入1000w條資料之後，我懷疑了jvm...
- 螞蟻二面，面試官問我零拷貝的實作原理，當場懵了…
明天見(｡･ω･｡)ﾉ♡