以前的Java項目中,充斥著太多不友好的代碼:POJO的getter/setter/toString;異常處理;I/O流的關(guān)閉操作等等,這些樣板代碼既沒有技術(shù)含量,又影響著代碼的美觀,Lombok應(yīng)運而生。
為什么推薦使用Lombok:
@Lombok有啥牛皮的?SpringBoot和IDEA官方都要支持它!
最近IDEA 2020最后一個版本發(fā)布了,已經(jīng)內(nèi)置了Lombok插件,SpringBoot 2.1.x之后的版本也在Starter中內(nèi)置了Lombok依賴。為什么他們都要支持Lombok呢?今天我來講講Lombok的使用,看看它有何神奇之處!
任何技術(shù)的出現(xiàn)都是為了解決某一類問題,如果在此基礎(chǔ)上再建立奇技淫巧,不如回歸Java本身,應(yīng)該保持合理使用而不濫用。
Lombok的使用非常簡單:
1)引入相應(yīng)的maven包
org.projectlombok
lombok
1.16.18
provided
Lombok的scope=provided,說明它只在編譯階段生效,不需要打入包中。事實正是如此,Lombok在編譯期將帶Lombok注解的Java文件正確編譯為完整的Class文件。
2)添加IDE工具對Lombok的支持
IDEA中引入Lombok支持如下:
點擊File-- Settings設(shè)置界面,安裝Lombok插件:
點擊File-- Settings設(shè)置界面,開啟 AnnocationProcessors:
開啟該項是為了讓Lombok注解在編譯階段起到作用。
Eclipse的Lombok插件安裝可以自行百度,也比較簡單,值得一提的是,由于Eclipse內(nèi)置的編譯器不是Oracle javac,而是eclipse自己實現(xiàn)的Eclipse Compiler for Java (ECJ).要讓ECJ支持Lombok,需要在eclipse.ini配置文件中添加如下兩項內(nèi)容:
-Xbootclasspath/a:[lombok.jar所在路徑
3)Lombok實現(xiàn)原理
自從Java 6起,javac就支持“JSR 269 Pluggable Annotation Processing API”規(guī)范,只要程序?qū)崿F(xiàn)了該API,就能在javac運行的時候得到調(diào)用。
Lombok就是一個實現(xiàn)了"JSR 269 API"的程序。在使用javac的過程中,它產(chǎn)生作用的具體流程如下:
1. javac對源代碼進行分析,生成一棵抽象語法樹(AST)
2. javac編譯過程中調(diào)用實現(xiàn)了JSR 269的Lombok程序
3. 此時Lombok就對第一步驟得到的AST進行處理,找到Lombok注解所在類對應(yīng)的語法樹 (AST),然后修改該語法樹(AST),增加Lombok注解定義的相應(yīng)樹節(jié)點
4. javac使用修改后的抽象語法樹(AST)生成字節(jié)碼文件
4) Lombok注解的使用 POJO類常用注解:
@Getter/@Setter: 作用類上,生成所有成員變量的getter/setter方法;作用于成員變量上,生成該成員變量的getter/setter方法。可以設(shè)定訪問權(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:作用于類,覆蓋默認的toString()方法,可以通過of屬性限定顯示某些字段,通過exclude屬性排除某些字段。
@EqualsAndHashCode:作用于類,覆蓋默認的equals和hashCode
@NonNull:主要作用于成員變量和參數(shù)中,標識不能為空,否則拋出空指針異常。
@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor:作用于類上,用于生成構(gòu)造函數(shù)。有staticName、access等屬性。
staticName屬性一旦設(shè)定,將采用靜態(tài)方法的方式生成實例,access屬性可以限定訪問權(quán)限。
@NoArgsConstructor:生成無參構(gòu)造器;
@RequiredArgsConstructor:生成包含final和@NonNull注解的成員變量的構(gòu)造器;
@AllArgsConstructor:生成全參構(gòu)造器
@Data:作用于類上,是以下注解的集合:@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor
@Builder:作用于類上,將類轉(zhuǎn)變?yōu)榻ㄔ煺吣J?/span>
@Log:作用于類上,生成日志變量。針對不同的日志實現(xiàn)產(chǎn)品,有不同的注解:
其他重要注解:
@Cleanup:自動關(guān)閉資源,針對實現(xiàn)了java.io.Closeable接口的對象有效,如:典型的IO流對象
編譯后結(jié)果如下:
@SneakyThrows:可以對受檢異常進行捕捉并拋出,可以改寫上述的main方法如下:
@Synchronized:作用于方法級別,可以替換synchronize關(guān)鍵字或lock鎖,用處不大.
發(fā)表評論