听说用 Lombok 可以早点下班?
??點(diǎn)擊上方?好好學(xué)java?,選擇?星標(biāo)?公眾號(hào)
重磅資訊、干貨,第一時(shí)間送達(dá) 今日推薦:分享一個(gè)牛逼的 Java 開源后臺(tái)管理系統(tǒng),不要造輪子了!個(gè)人原創(chuàng)+1博客:點(diǎn)擊前往,查看更多 作者:武培軒 出處:https://www.cnblogs.com/wupeixuan/p/12609174.html聽說隔壁用 Lombok 的六點(diǎn)就下班了,我也想六點(diǎn)下班!
好的,那么這篇文章就介紹下什么是 Lombok,Lombok 做了什么以及 Lombok 是怎么做的?
在介紹之前,先通過是否使用 Lombok 的效果來(lái)看下對(duì)比,首先來(lái)看下沒有 Lombok 之前,我們的一個(gè)簡(jiǎn)單的 Java 對(duì)象(POJO)是長(zhǎng)什么樣子的:
哦,我的天啊,居然 60 行,好長(zhǎng)啊!那我們接下來(lái)使用的 Lombok 來(lái)試下:
什么,只使用了 @Date 注解就可以實(shí)現(xiàn)之前 60 行的相同功能,代碼長(zhǎng)度整整縮小了 3 倍,這么神奇的嘛?那么讓我們走進(jìn) Lombok 吧!
什么是 Lombok?
下面是 Lombok 官網(wǎng)的簡(jiǎn)介:
Lombok 簡(jiǎn)介簡(jiǎn)而言之就是 Lombok 是一個(gè)很方便的插件,本質(zhì)是個(gè) Java 庫(kù),使用它通過相關(guān)注解就可以不用再編寫冗長(zhǎng)的 getter 或者 equals 等方法了。
接下來(lái)講下 Lombok 實(shí)現(xiàn)的原理,這樣就知道為什么要這樣使用 Lombok 的注解了。
Lombok 實(shí)現(xiàn)原理
要講 Lombok 的實(shí)現(xiàn)原理,在此之前就需要來(lái)說下注解的兩種解析方式:運(yùn)行時(shí)注解和編譯時(shí)注解。
首先來(lái)看下運(yùn)行時(shí)解析,比如 Spring 配置的 AOP 切面這些注解都是在程序運(yùn)行的時(shí)候通過反射來(lái)獲取的注解值,但是只有在程序運(yùn)行時(shí)才能獲取到這些注解值,導(dǎo)致運(yùn)行時(shí)代碼效率很低,并且如果想在編譯階段利用這些注解來(lái)進(jìn)行檢查,比如對(duì)用戶的不合理代碼作出錯(cuò)誤報(bào)告,反射的方法就行不通了。
這就引出了第二種在編譯時(shí)解析,Lombok 工具就是運(yùn)行在編譯時(shí)解析的。
那如何把注解與 Java 編譯器結(jié)合使用呢?Java 也提供了兩種解決方案:
第一種方案是注解處理器(Annotation Processing Tool),它最早是在 JDK 1.5 與注解(Annotation) 一起引入的,它是一個(gè)命令行工具,能夠提供構(gòu)建時(shí)基于源代碼對(duì)程序結(jié)構(gòu)的讀取功能,能夠通過運(yùn)行注解處理器來(lái)生成新的中間文件,進(jìn)而影響編譯過程,不過它在 JDK 1.8 中被移除了,取而代之的是 JSR 269 插入式注解處理器(Pluggable Annotation Processing API),它是實(shí)現(xiàn)了 JSR 269 的機(jī)制,作為注解處理器的替代方案。
我們通過一個(gè)流程圖來(lái)進(jìn)一步說明注解處理器的工作原理:
首先寫完代碼后會(huì)調(diào)用 javac 編譯,在編譯后會(huì)生成抽象語(yǔ)法樹(AST),之后會(huì)調(diào)用插入式注解處理器處理,上面說了插入式注解處理器會(huì)修改語(yǔ)法樹,生成一些額外的代碼,經(jīng)過處理器的處理語(yǔ)法樹會(huì)有變動(dòng),有變動(dòng)之后,會(huì)再次到生成抽象語(yǔ)法樹的處理環(huán)節(jié),將變動(dòng)后的代碼再次生成抽象語(yǔ)法樹,接著再通過注解處理器,如果這次語(yǔ)法樹沒有被修改,那么就會(huì)生成響應(yīng)的字節(jié)碼,變成 class 文件,以上就是整個(gè)注解處理器在整個(gè) javac 編譯源代碼生成 class 文件中起到的作用。
在簡(jiǎn)單了解了 Lombok 實(shí)現(xiàn)原理后,讓我們看下 Lombok 有哪些常見的注解:
Lombok 注解
下面是整理的常用的 Lombok 注解思維導(dǎo)圖:
Lombok 注解右側(cè)上方的 @Getter、@Setter、@ToString、@EqualsAndHashCode 這幾個(gè)名字大家都不陌生,無(wú)非就是幫我們生成對(duì)應(yīng)的方法,這四個(gè)注解的總和也就是剛開始用的注解 @Data,這些注解都?xì)w結(jié)為常見方法的注解。
右側(cè)下方的 @AllArgsConstructor、@RequiredArgsConstructor、@NoArgsConstructor 分別為全參構(gòu)造函數(shù)、必須參數(shù)構(gòu)造函數(shù)、無(wú)參構(gòu)造函數(shù),它們通常為構(gòu)造方法的注解。
左側(cè)的 @NonNull 會(huì)自動(dòng)生成空值校驗(yàn);@CleanUp 會(huì)自動(dòng)調(diào)用變量的 close 方法釋放資源;@Builder 會(huì)自動(dòng)生成構(gòu)造者模式,方便對(duì)屬性 set/get 操作;@Synchronized 會(huì)自動(dòng)生成同步鎖;@SneakyThrows 會(huì)自動(dòng)生成 try/catch 捕捉異常;@Slf4j 是日志相關(guān)的,會(huì)自動(dòng)為類添加日志支持。
以上就是 Lombok 為我們提供的比較常用的注解。
Lombok 使用
首先需要安裝 Lombok 插件,我在這里是以 IDEA 2019.3.1 版本來(lái)演示的:
安裝 Lombok 插件
點(diǎn)擊 File->Settings->Plugins,搜索 Lombok,然后點(diǎn)擊安裝 Lombok 插件:
在安裝完插件后重啟 IDEA,到此 Lombok 插件就安裝完成了,接下來(lái)就要進(jìn)行實(shí)踐演示了:
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 包是運(yùn)行在編譯時(shí)的,當(dāng)程序編譯成 class 源代碼后,這個(gè) jar 包就不會(huì)在源代碼層面有所體現(xiàn)。
接下來(lái)演示 Lombok 注解使用方式,并通過查看編譯后 class 文件,理解其工作原理,在這里以 @Getter 注解為例:
首先創(chuàng)建一個(gè) GetterDemo 類,其中有 name 和 age 兩個(gè)字段。
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"; }我們?cè)谧兞?age 上加上注解 @Getter,并且加上了參數(shù)來(lái)設(shè)置訪問級(jí)別,通過 onMethod_ 參數(shù)可以為我們?cè)谏傻?getAge 方法添加上其他注解,比如 @NonNull;在 name 上加上 @Getter 注解,并加上 lazy 參數(shù)并設(shè)為 true,表示開啟懶加載。
接下來(lái)編譯下,編譯的 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() {}@NonNullprivate 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,并且方法上有一個(gè) @NonNull 的注解;getName 方法沒有剛開始就初始化一個(gè)字符串,而是只有調(diào)用該方法的時(shí)候判斷該字段是否為空,若為空,則初始化一個(gè)字符串并返回,這樣就可以為開銷大的初始化操作做一個(gè)懶加載,只有當(dāng)使用的時(shí)候才會(huì)主動(dòng)加載這個(gè)字段。
其他的注解方法大家可以自己去實(shí)踐操作下。
Lombok 優(yōu)缺點(diǎn)
在了解完 Lombok 之后,讓我們來(lái)分析下 Lombok 的優(yōu)缺點(diǎn)吧!
Lombok 的優(yōu)點(diǎn)有以下幾點(diǎn):
通過注解自動(dòng)生成樣板代碼,提高開發(fā)效率
代碼簡(jiǎn)潔,只關(guān)注相關(guān)屬性
新增屬性后,無(wú)需刻意修改相關(guān)方法
但是 Lombok 也有一些缺點(diǎn):
降低了源代碼的可讀性和完整性
加大對(duì)問題排查的難度(可能問題定位到不存在的行,無(wú)從下手)
強(qiáng) x 隊(duì)友,因?yàn)樾枰?IDE 的相關(guān)插件的支持
總結(jié)
本文介紹了什么是 Lombok,Lombok 做了什么以及 Lombok 的實(shí)現(xiàn)原理,并且分析了 Lombok 的利弊,大家在享受到它的好處的同時(shí),也應(yīng)該考慮到它帶來(lái)的一些問題,你在工作中有被隊(duì)友強(qiáng) x 嗎?你對(duì) Lombok 怎么看?歡迎留言談?wù)?#xff01;
總結(jié)
以上是生活随笔為你收集整理的听说用 Lombok 可以早点下班?的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Java 完美实现添加、读取和删除 Ex
- 下一篇: mycat 10 分钟轻松入门