聽說隔壁用 Lombok 的六點就下班了宙拉,我也想六點下班!
好的丙笋,那么這篇文章就介紹下什么是 Lombok谢澈,Lombok 做了什么以及 Lombok 是怎么做的?
在介紹之前御板,先通過是否使用 Lombok 的效果來看下對比锥忿,首先來看下沒有 Lombok 之前,我們的一個簡單的 Java 對象(POJO)是長什么樣子的:
哦怠肋,我的天啊敬鬓,居然 60 行,好長霸钏啤列林!那我們接下來使用的 Lombok 來試下:
什么瑞你,只使用了 @Date
注解就可以實現(xiàn)之前 60 行的相同功能酪惭,代碼長度整整縮小了 3 倍,這么神奇的嘛者甲?那么讓我們走進 Lombok 吧春感!
什么是 Lombok?
下面是 Lombok 官網(wǎng)的簡介:
簡而言之就是 Lombok 是一個很方便的插件虏缸,本質(zhì)是個 Java 庫鲫懒,使用它通過相關(guān)注解就可以不用再編寫冗長的 getter 或者 equals 等方法了。
接下來講下 Lombok 實現(xiàn)的原理刽辙,這樣就知道為什么要這樣使用 Lombok 的注解了窥岩。
Lombok 實現(xiàn)原理
要講 Lombok 的實現(xiàn)原理,在此之前就需要來說下注解的兩種解析方式:運行時注解和編譯時注解宰缤。
首先來看下運行時解析颂翼,比如 Spring 配置的 AOP 切面這些注解都是在程序運行的時候通過反射來獲取的注解值,但是只有在程序運行時才能獲取到這些注解值慨灭,導(dǎo)致運行時代碼效率很低朦乏,并且如果想在編譯階段利用這些注解來進行檢查,比如對用戶的不合理代碼作出錯誤報告氧骤,反射的方法就行不通了呻疹。
這就引出了第二種在編譯時解析,Lombok 工具就是運行在編譯時解析的筹陵。
那如何把注解與 Java 編譯器結(jié)合使用呢刽锤?Java 也提供了兩種解決方案:
第一種方案是注解處理器(Annotation Processing Tool)镊尺,它最早是在 JDK 1.5 與注解(Annotation) 一起引入的,它是一個命令行工具并思,能夠提供構(gòu)建時基于源代碼對程序結(jié)構(gòu)的讀取功能鹅心,能夠通過運行注解處理器來生成新的中間文件,進而影響編譯過程纺荧,不過它在 JDK 1.8 中被移除了旭愧,取而代之的是 JSR 269 插入式注解處理器(Pluggable Annotation Processing API),它是實現(xiàn)了 JSR 269 的機制宙暇,作為注解處理器的替代方案输枯。
我們通過一個流程圖來進一步說明注解處理器的工作原理:
首先寫完代碼后會調(diào)用 javac
編譯,在編譯后會生成抽象語法樹(AST)占贫,之后會調(diào)用插入式注解處理器處理桃熄,上面說了插入式注解處理器會修改語法樹,生成一些額外的代碼型奥,經(jīng)過處理器的處理語法樹會有變動瞳收,有變動之后,會再次到生成抽象語法樹的處理環(huán)節(jié)厢汹,將變動后的代碼再次生成抽象語法樹螟深,接著再通過注解處理器,如果這次語法樹沒有被修改烫葬,那么就會生成響應(yīng)的字節(jié)碼界弧,變成 class 文件,以上就是整個注解處理器在整個 javac
編譯源代碼生成 class 文件中起到的作用搭综。
在簡單了解了 Lombok 實現(xiàn)原理后垢箕,讓我們看下 Lombok 有哪些常見的注解:
Lombok 注解
下面是整理的常用的 Lombok 注解思維導(dǎo)圖:
右側(cè)上方的 @Getter、@Setter兑巾、@ToString条获、@EqualsAndHashCode
這幾個名字大家都不陌生,無非就是幫我們生成對應(yīng)的方法蒋歌,這四個注解的總和也就是剛開始用的注解 @Data
帅掘,這些注解都?xì)w結(jié)為常見方法的注解。
右側(cè)下方的 @AllArgsConstructor奋姿、@RequiredArgsConstructor锄开、@NoArgsConstructor
分別為全參構(gòu)造函數(shù)、必須參數(shù)構(gòu)造函數(shù)称诗、無參構(gòu)造函數(shù)萍悴,它們通常為構(gòu)造方法的注解。
左側(cè)的 @NonNull
會自動生成空值校驗;@CleanUp
會自動調(diào)用變量的 close
方法釋放資源癣诱;@Builder
會自動生成構(gòu)造者模式计维,方便對屬性 set/get
操作; @Synchronized
會自動生成同步鎖撕予;@SneakyThrows
會自動生成 try/catch
捕捉異常鲫惶;@Slf4j
是日志相關(guān)的,會自動為類添加日志支持实抡。
以上就是 Lombok 為我們提供的比較常用的注解欠母。
Lombok 使用
首先需要安裝 Lombok 插件,我在這里是以 IDEA 2019.3.1 版本來演示的:
安裝 Lombok 插件
點擊 File->Settings->Plugins吆寨,搜索 Lombok
赏淌,然后點擊安裝 Lombok 插件:
在安裝完插件后重啟 IDEA,到此 Lombok 插件就安裝完成了啄清,接下來就要進行實踐演示了:
Lombok 常用注解演示
首先在 pom 文件中引入依賴:
<dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
<scope>provided</scope>
</dependency>
</dependencies>
其中 <scope>provided</scope>
表示 jar 包是運行在編譯時的六水,當(dāng)程序編譯成 class 源代碼后,這個 jar 包就不會在源代碼層面有所體現(xiàn)辣卒。
接下來演示 Lombok 注解使用方式掷贾,并通過查看編譯后 class 文件,理解其工作原理荣茫,在這里以 @Getter
注解為例:
首先創(chuàng)建一個 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
计露,并且加上了參數(shù)來設(shè)置訪問級別博脑,通過 onMethod_
參數(shù)可以為我們在生成的 getAge
方法添加上其他注解憎乙,比如 @NonNull
票罐;在 name
上加上 @Getter
注解,并加上 lazy
參數(shù)并設(shè)為 true
泞边,表示開啟懶加載该押。
接下來編譯下,編譯的 class 源代碼如下:
package com.wupx.lombok;
import java.util.concurrent.atomic.AtomicReference;
import lombok.NonNull;
public class GetterDemo {
private String age;
private final AtomicReference<Object> 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));
}
}
可以發(fā)現(xiàn)生成后的源代碼文件中阵谚,getAge
方法訪問修飾符為 private
蚕礼,并且方法上有一個 @NonNull
的注解;getName
方法沒有剛開始就初始化一個字符串梢什,而是只有調(diào)用該方法的時候判斷該字段是否為空奠蹬,若為空,則初始化一個字符串并返回嗡午,這樣就可以為開銷大的初始化操作做一個懶加載囤躁,只有當(dāng)使用的時候才會主動加載這個字段。
其他的注解方法大家可以自己去實踐操作下。
Lombok 優(yōu)缺點
在了解完 Lombok 之后狸演,讓我們來分析下 Lombok 的優(yōu)缺點吧言蛇!
Lombok 的優(yōu)點有以下幾點:
- 通過注解自動生成樣板代碼,提高開發(fā)效率
- 代碼簡潔宵距,只關(guān)注相關(guān)屬性
- 新增屬性后腊尚,無需刻意修改相關(guān)方法
但是 Lombok 也有一些缺點:
- 降低了源代碼的可讀性和完整性
- 加大對問題排查的難度(可能問題定位到不存在的行,無從下手)
- 強 x 隊友满哪,因為需要 IDE 的相關(guān)插件的支持
總結(jié)
本文介紹了什么是 Lombok婿斥,Lombok 做了什么以及 Lombok 的實現(xiàn)原理,并且分析了 Lombok 的利弊哨鸭,大家在享受到它的好處的同時受扳,也應(yīng)該考慮到它帶來的一些問題,你在工作中有被隊友強 x 嗎兔跌?你對 Lombok 怎么看勘高?歡迎留言談?wù)摚?/p>