Lombok省去繁瑣的Getter,Set方法的利器

以前的Java項目中,充斥著太多不友好的代碼:POJO的getter/setter/toString;異常處理;I/O流的關閉操作等等,這些樣板代碼既沒有技術含量,又影響著代碼的美觀,Lombok應運而生。

任何技術的出現都是為了解決某一類問題,如果在此基礎上再建立奇技淫巧,不如迴歸Java本身,應該保持合理使用而不濫用。

Lombok的使用非常簡單:

1)引入相應的maven包

<code><dependency>
    <groupid>org.projectlombok/<groupid>
    <artifactid>lombok/<artifactid>
    <version>1.16.18/<version>
    <scope>provided/<scope>
/<dependency>/<code>

Lombok的scope=provided,說明它只在編譯階段生效,不需要打入包中。事實正是如此,Lombok在編譯期將帶Lombok註解的Java文件正確編譯為完整的Class文件。

2)添加IDE工具對Lombok的支持

IDEA中引入Lombok支持如下:

點擊File-- Settings設置界面,安裝Lombok插件:

Lombok省去繁瑣的Getter,Set方法的利器

點擊File-- Settings設置界面,開啟 AnnocationProcessors:

Lombok省去繁瑣的Getter,Set方法的利器

開啟該項是為了讓Lombok註解在編譯階段起到作用。

Eclipse的Lombok插件安裝可以自行百度,也比較簡單,值得一提的是,由於Eclipse內置的編譯器不是Oracle javac,而是eclipse自己實現的Eclipse Compiler for Java (ECJ).要讓ECJ支持Lombok,需要在eclipse.ini配置文件中添加如下兩項內容:

-Xbootclasspath/a:[lombok.jar所在路徑

3)Lombok實現原理

自從Java 6起,javac就支持“JSR 269 Pluggable Annotation Processing API”規範,只要程序實現了該API,就能在javac運行的時候得到調用。

Lombok就是一個實現了"JSR 269 API"的程序。在使用javac的過程中,它產生作用的具體流程如下:


1. javac對源代碼進行分析,生成一棵抽象語法樹(AST)

2. javac編譯過程中調用實現了JSR 269的Lombok程序

3. 此時Lombok就對第一步驟得到的AST進行處理,找到Lombok註解所在類對應的語法樹 (AST),然後修改該語法樹(AST),增加Lombok註解定義的相應樹節點

4. javac使用修改後的抽象語法樹(AST)生成字節碼文件


4) Lombok註解的使用

POJO類常用註解:

@Getter/@Setter: 作用類上,生成所有成員變量的getter/setter方法;作用於成員變量上,生成該成員變量的getter/setter方法。可以設定訪問權限及是否懶加載等。

<code>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;
}/<code>

@ToString:作用於類,覆蓋默認的toString()方法,可以通過of屬性限定顯示某些字段,通過exclude屬性排除某些字段。

Lombok省去繁瑣的Getter,Set方法的利器

@EqualsAndHashCode:作用於類,覆蓋默認的equals和hashCode

@NonNull:主要作用於成員變量和參數中,標識不能為空,否則拋出空指針異常。

Lombok省去繁瑣的Getter,Set方法的利器

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor:作用於類上,用於生成構造函數。有staticName、access等屬性。

staticName屬性一旦設定,將採用靜態方法的方式生成實例,access屬性可以限定訪問權限。

@NoArgsConstructor:生成無參構造器;

@RequiredArgsConstructor:生成包含final和@NonNull註解的成員變量的構造器;

@AllArgsConstructor:生成全參構造器

Lombok省去繁瑣的Getter,Set方法的利器

@Data:作用於類上,是以下註解的集合:@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor

@Builder:作用於類上,將類轉變為建造者模式

@Log:作用於類上,生成日誌變量。針對不同的日誌實現產品,有不同的註解:

其他重要註解:

@Cleanup:自動關閉資源,針對實現了java.io.Closeable接口的對象有效,如:典型的IO流對象

Lombok省去繁瑣的Getter,Set方法的利器

編譯後結果如下:

Lombok省去繁瑣的Getter,Set方法的利器

@SneakyThrows:可以對受檢異常進行捕捉並拋出,可以改寫上述的main方法如下:

Lombok省去繁瑣的Getter,Set方法的利器

@Synchronized:作用於方法級別,可以替換synchronize關鍵字或lock鎖,用處不大.


專注於技術熱點大數據,人工智能,JAVA、Python、 C 、GO、Javascript等語言最新前言技術,及業務痛點問題分析,請關注【編程我最懂】共同交流學習。


分享到:


相關文章: