Lombok使用詳解，簡化Java編程

作者：日拱一兵 2019-11-27 10:05:00

開發后端

在 Java 應用程序中存在許多重復相似的、生成之后幾乎不對其做更改的代碼，但是我們還不得不花費很多精力編寫它們來滿足 Java 的編譯需求。

前言

在 Java 應用程序中存在許多重復相似的、生成之后幾乎不對其做更改的代碼，但是我們還不得不花費很多精力編寫它們來滿足 Java 的編譯需求

比如，在 Java 應用程序開發中，我們幾乎要為所有 Bean 的成員變量添加 get() ,set() 等方法，這些相對固定但又不得不編寫的代碼浪費程序員很多精力，同時讓類內容看著更雜亂，我們希望將有限的精力關注在更重要的地方。

[[283807]]

Lombok 已經誕生很久了，甚至在 Spring Boot Initalizr 中都已加入了 Lombok 選項，

這里我們將 Lombok 做一下詳細說明:

Lombok

官網的介紹：Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java. Never write another getter or equals method again. Early access to future java features such as val, and much more.

直白的說： Lombok 是一種 Java™ 實用工具，可用來幫助開發人員消除 Java 的冗長，尤其是對于簡單的 Java 對象(POJO)。它通過注解實現這一目的，且看:

Bean 的對比

傳統的 POJO 類是這樣的

通過Lombok改造后的 POJO 類是這樣的

一眼可以觀察出來我們在編寫 Employee 這個類的時候通過 @Data 注解就已經實現了所有成員變量的 get() 與 set() 方法等，同時 Employee 類看起來更加清晰簡潔。Lombok 的神奇之處不止這些，豐富的注解滿足了我們開發的多數需求。

Lombok的安裝

查看下圖，@Data的實現，我們發現這個注解是應用在編譯階段的

這和我們大多數使用的注解，如 Spring 的注解(在運行時，通過反射來實現業務邏輯)是有很大差別的，如Spring 的@RestController 注解

一個更直接的體現就是，普通的包在引用之后一般的 IDE 都能夠自動識別語法，但是 Lombok 的這些注解，一般的 IDE 都無法自動識別，因此如果要使用 Lombok 的話還需要配合安裝相應的插件來支持 IDE 的編譯，防止IDE 的自動檢查報錯，下面以 IntelliJ IDEA 舉例安裝插件。

在Repositories中搜索Lombok，安裝后重啟IDE即可

在Maven或Gradle工程中添加依賴

至此我們就可以應用 Lombok 提供的注解干些事情了。

Lombok注解詳解

Lombok官網提供了許多注解，但是 “勁酒雖好，可不要貪杯哦”，接下來逐一講解官網推薦使用的注解(有些注解和原有Java編寫方式沒太大差別的也沒有在此處列舉，如@ Synchronized等)

@Getter和@Setter

該注解可應用在類或成員變量之上，和我們預想的一樣，@Getter 和 @Setter 就是為成員變量自動生成 get 和 set 方法，默認生成訪問權限為 public 方法，當然我們也可以指定訪問權限 protected 等，如下圖：

成員變量name指定生成set方法，并且訪問權限為protected;boolean類型的成員變量 female 只生成get方法，并修改方法名稱為 isFemale()。當把該注解應用在類上，默認為所有非靜態成員變量生成 get 和 set 方法，也可以通過 AccessLevel.NONE 手動禁止生成get或set方法，如下圖：

@ToString

該注解需應用在類上，為我們生成 Object 的 toString 方法，而該注解里面的幾個屬性能更加豐富我們想要的內容, exclude 屬性禁止在 toString 方法中使用某字段，而of屬性可以指定需要使用的字段，如下圖：

查看編譯后的Employee.class得到我們預期的結果，如下圖

@EqualsAndHashCode

該注解需應用在類上，使用該注解，lombok會為我們生成 equals(Object other) 和 hashcode() 方法，包括所有非靜態屬性和非transient的屬性，同樣該注解也可以通過 exclude 屬性排除某些字段，of 屬性指定某些字段，也可以通過 callSuper 屬性在重寫的方法中使用父類的字段，這樣我們可以更靈活的定義bean的比對，如下圖：

查看編譯后的Employee.class文件，如下圖：

@NonNull

該注解需應用在方法或構造器的參數上或屬性上，用來判斷參數的合法性，默認拋出 NullPointerException 異常

查看NonNullExample.class文件，會為我們拋出空指針異常，如下圖：

當然我們可以通過指定異常類型拋出其他異常，lombok.nonNull.exceptionType = [NullPointerException | IllegalArgumentException] , 為實現此功能我們需要在項目的根目錄新建lombok.config文件：

重新編譯NonNullExample類，已經為我們拋出非法參數異常：

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor

以上三個注解分別為我們生成無參構造器，指定參數構造器和包含所有參數的構造器，默認情況下，@RequiredArgsConstructor, @AllArgsConstructor 生成的構造器會對所有標記 @NonNull 的屬性做非空校驗。

無參構造器很好理解，我們主要看看后兩種，先看 @RequiredArgsConstructor

從上圖中我們可以看出， @RequiredArgsConstructor 注解生成有參數構造器時只會包含有 final 和 @NonNull 標識的 field，同時我們可以指定 staticName 通過生成靜態方法來構造對象

查看Employee.class文件

當我們把 staticName 屬性去掉我們來看遍以后的文件:

相信你已經注意到細節

@AllArgsConstructor 就更簡單了，請大家自行查看吧

@Data

介紹了以上的注解，再來介紹 @Data 就非常容易懂了，@Data 注解應用在類上，是@ToString, @EqualsAndHashCode, @Getter / @Setter 和 @RequiredArgsConstructor合力的體現，如下圖：

@Builder

函數式編程或者說流式的操作越來越流行，應用在大多數語言中，讓程序更具更簡介，可讀性更高，編寫更連貫，@Builder就帶來了這個功能，生成一系列的builder API，該注解也需要應用在類上，看下面的例子就會更加清晰明了。

編譯后的Employee.class文件如下：

媽媽再也不用擔心我 set 值那么麻煩了，流式操作搞定：

@Log

該注解需要應用到類上，在編寫服務層，需要添加一些日志，以便定位問題，我們通常會定義一個靜態常量Logger，然后應用到我們想日志的地方，現在一個注解就可以實現：

查看class文件，和我們預想的一樣：

Log有很多變種，CommonLog，Log4j，Log4j2，Slf4j等，lombok依舊良好的通過變種注解做良好的支持：

我實際使用的是 @Slf4j 注解

val

熟悉 Javascript 的同學都知道，var 可以定義任何類型的變量，而在 java 的實現中我們需要指定具體變量的類型，而 val 讓我們擺脫指定，編譯之后就精準匹配上類型，默認是 final 類型，就像 java8 的函數式表達式，()->System.out.println(“hello lombok”); 就可以解析到Runnable函數式接口。