以前的Java項(xiàng)目中杨耙,充斥著太多不友好的代碼:POJO的getter/setter/toString衬廷;異常處理鲤氢;I/O流的關(guān)閉操作等等搀擂,這些樣板代碼既沒(méi)有技術(shù)含量,又影響著代碼的美觀卷玉,Lombok應(yīng)運(yùn)而生哨颂。
為什么推薦使用Lombok:
@Lombok有啥牛皮的?SpringBoot和IDEA官方都要支持它相种!
最近IDEA 2020最后一個(gè)版本發(fā)布了威恼,已經(jīng)內(nèi)置了Lombok插件,SpringBoot 2.1.x之后的版本也在Starter中內(nèi)置了Lombok依賴寝并。為什么他們都要支持Lombok呢箫措?今天我來(lái)講講Lombok的使用,看看它有何神奇之處食茎!
任何技術(shù)的出現(xiàn)都是為了解決某一類問(wèn)題蒂破,如果在此基礎(chǔ)上再建立奇技淫巧,不如回歸Java本身别渔,應(yīng)該保持合理使用而不濫用。
Lombok的使用非常簡(jiǎn)單:
1)引入相應(yīng)的maven包
????<dependency>
? ????????<groupId>org.projectlombok</groupId>
? ????????<artifactId>lombok</artifactId>
? ????????<version>1.16.18</version>
????????? <scope>provided</scope>
????</dependency>
Lombok的scope=provided惧互,說(shuō)明它只在編譯階段生效哎媚,不需要打入包中。事實(shí)正是如此喊儡,Lombok在編譯期將帶Lombok注解的Java文件正確編譯為完整的Class文件拨与。
2)添加IDE工具對(duì)Lombok的支持
????IDEA中引入Lombok支持如下:
????點(diǎn)擊File-- Settings設(shè)置界面,安裝Lombok插件:
點(diǎn)擊File-- Settings設(shè)置界面艾猜,開(kāi)啟 AnnocationProcessors:
開(kāi)啟該項(xiàng)是為了讓Lombok注解在編譯階段起到作用买喧。
Eclipse的Lombok插件安裝可以自行百度捻悯,也比較簡(jiǎn)單,值得一提的是淤毛,由于Eclipse內(nèi)置的編譯器不是Oracle javac今缚,而是eclipse自己實(shí)現(xiàn)的Eclipse Compiler for Java (ECJ).要讓ECJ支持Lombok,需要在eclipse.ini配置文件中添加如下兩項(xiàng)內(nèi)容:
????-Xbootclasspath/a:[lombok.jar所在路徑
3)Lombok實(shí)現(xiàn)原理
自從Java 6起低淡,javac就支持“JSR 269 Pluggable Annotation Processing API”規(guī)范姓言,只要程序?qū)崿F(xiàn)了該API,就能在javac運(yùn)行的時(shí)候得到調(diào)用蔗蹋。
Lombok就是一個(gè)實(shí)現(xiàn)了"JSR 269 API"的程序何荚。在使用javac的過(guò)程中,它產(chǎn)生作用的具體流程如下:
1. javac對(duì)源代碼進(jìn)行分析猪杭,生成一棵抽象語(yǔ)法樹(shù)(AST)
2. javac編譯過(guò)程中調(diào)用實(shí)現(xiàn)了JSR 269的Lombok程序
3. 此時(shí)Lombok就對(duì)第一步驟得到的AST進(jìn)行處理餐塘,找到Lombok注解所在類對(duì)應(yīng)的語(yǔ)法樹(shù)? ?????(AST),然后修改該語(yǔ)法樹(shù)(AST)皂吮,增加Lombok注解定義的相應(yīng)樹(shù)節(jié)點(diǎn)
4. javac使用修改后的抽象語(yǔ)法樹(shù)(AST)生成字節(jié)碼文件
4)?Lombok注解的使用
POJO類常用注解:
@Getter/@Setter: 作用類上唠倦,生成所有成員變量的getter/setter方法;作用于成員變量上涮较,生成該成員變量的getter/setter方法稠鼻。可以設(shè)定訪問(wèn)權(quán)限及是否懶加載等狂票。
package com.kaplan.pojo;
import lombok.*;
import lombok.extern.log4j.Log4j;
@Getter
@Setter
public class TestDemo {
private String name;
private int age ; private String email;
private String address; private String password;
@Getter @Setter private boolean funny;
}
@ToString:作用于類候齿,覆蓋默認(rèn)的toString()方法,可以通過(guò)of屬性限定顯示某些字段闺属,通過(guò)exclude屬性排除某些字段慌盯。
@EqualsAndHashCode:作用于類,覆蓋默認(rèn)的equals和hashCode
@NonNull:主要作用于成員變量和參數(shù)中掂器,標(biāo)識(shí)不能為空亚皂,否則拋出空指針異常。
@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor:作用于類上国瓮,用于生成構(gòu)造函數(shù)灭必。有staticName、access等屬性乃摹。
staticName屬性一旦設(shè)定禁漓,將采用靜態(tài)方法的方式生成實(shí)例,access屬性可以限定訪問(wèn)權(quán)限孵睬。
@NoArgsConstructor:生成無(wú)參構(gòu)造器播歼;
@RequiredArgsConstructor:生成包含final和@NonNull注解的成員變量的構(gòu)造器;
@AllArgsConstructor:生成全參構(gòu)造器
@Data:作用于類上掰读,是以下注解的集合:@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor
@Builder:作用于類上秘狞,將類轉(zhuǎn)變?yōu)榻ㄔ煺吣J?/b>
@Log:作用于類上叭莫,生成日志變量。針對(duì)不同的日志實(shí)現(xiàn)產(chǎn)品烁试,有不同的注解:
其他重要注解:
@Cleanup:自動(dòng)關(guān)閉資源雇初,針對(duì)實(shí)現(xiàn)了java.io.Closeable接口的對(duì)象有效,如:典型的IO流對(duì)象
編譯后結(jié)果如下:
@SneakyThrows:可以對(duì)受檢異常進(jìn)行捕捉并拋出廓潜,可以改寫(xiě)上述的main方法如下:
@Synchronized:作用于方法級(jí)別抵皱,可以替換synchronize關(guān)鍵字或lock鎖,用處不大.