據說用 Lombok 能夠早點下班？

據說隔壁用 Lombok 的六點就下班了，我也想六點下班！

好的，那麼這篇文章就介紹下什麼是 Lombok，Lombok 作了什麼以及 Lombok 是怎麼作的？

在介紹以前，先經過是否使用 Lombok 的效果來看下對比，首先來看下沒有 Lombok 以前，咱們的一個簡單的 Java 對象（POJO）是長什麼樣子的：

哦，個人天啊，竟然 60 行，好長啊！那咱們接下來使用的 Lombok 來試下：

什麼，只使用了 @Date 註解就能夠實現以前 60 行的相同功能，代碼長度整整縮小了 3 倍，這麼神奇的嘛？那麼讓咱們走進 Lombok 吧！

什麼是 Lombok？

下面是 Lombok 官網的簡介：

簡而言之就是 Lombok 是一個很方便的插件，本質是個 Java 庫，使用它經過相關注解就能夠不用再編寫冗長的 getter 或者 equals 等方法了。

接下來說下 Lombok 實現的原理，這樣就知道爲何要這樣使用 Lombok 的註解了。

Lombok 實現原理

要講 Lombok 的實現原理，在此以前就須要來講下註解的兩種解析方式：運行時註解和編譯時註解。

首先來看下運行時解析，好比 Spring 配置的 AOP 切面這些註解都是在程序運行的時候經過反射來獲取的註解值，可是隻有在程序運行時才能獲取到這些註解值，致使運行時代碼效率很低，而且若是想在編譯階段利用這些註解來進行檢查，好比對用戶的不合理代碼做出錯誤報告，反射的方法就行不通了。

這就引出了第二種在編譯時解析，Lombok 工具就是運行在編譯時解析的。

那如何把註解與 Java 編譯器結合使用呢？Java 也提供了兩種解決方案：

第一種方案是註解處理器（Annotation Processing Tool），它最先是在 JDK 1.5 與註解（Annotation） 一塊兒引入的，它是一個命令行工具，可以提供構建時基於源代碼對程序結構的讀取功能，可以經過運行註解處理器來生成新的中間文件，進而影響編譯過程，不過它在 JDK 1.8 中被移除了，取而代之的是 JSR 269 插入式註解處理器（Pluggable Annotation Processing API），它是實現了 JSR 269 的機制，做爲註解處理器的替代方案。

咱們經過一個流程圖來進一步說明註解處理器的工做原理：

首先寫完代碼後會調用 javac 編譯，在編譯後會生成抽象語法樹（AST），以後會調用插入式註解處理器處理，上面說了插入式註解處理器會修改語法樹，生成一些額外的代碼，通過處理器的處理語法樹會有變更，有變更以後，會再次到生成抽象語法樹的處理環節，將變更後的代碼再次生成抽象語法樹，接着再經過註解處理器，若是此次語法樹沒有被修改，那麼就會生成響應的字節碼，變成 class 文件，以上就是整個註解處理器在整個 javac 編譯源代碼生成 class 文件中起到的做用。

在簡單瞭解了 Lombok 實現原理後，讓咱們看下 Lombok 有哪些常見的註解：

Lombok 註解

下面是整理的經常使用的 Lombok 註解思惟導圖：

右側上方的 @Getter、@Setter、@ToString、@EqualsAndHashCode 這幾個名字你們都不陌生，無非就是幫咱們生成對應的方法，這四個註解的總和也就是剛開始用的註解 @Data，這些註解都歸結爲常見方法的註解。

右側下方的 @AllArgsConstructor、@RequiredArgsConstructor、@NoArgsConstructor 分別爲全參構造函數、必須參數構造函數、無參構造函數，它們一般爲構造方法的註解。

左側的 @NonNull 會自動生成空值校驗；@CleanUp 會自動調用變量的 close 方法釋放資源；@Builder 會自動生成構造者模式，方便對屬性 set/get 操做； @Synchronized 會自動生成同步鎖；@SneakyThrows 會自動生成 try/catch 捕捉異常；@Slf4j 是日誌相關的，會自動爲類添加日誌支持。

以上就是 Lombok 爲咱們提供的比較經常使用的註解。

Lombok 使用

首先須要安裝 Lombok 插件，我在這裏是以 IDEA 2019.3.1 版原本演示的：

安裝 Lombok 插件

點擊 File->Settings->Plugins，搜索 Lombok，而後點擊安裝 Lombok 插件：

在安裝完插件後重啓 IDEA，到此 Lombok 插件就安裝完成了，接下來就要進行實踐演示了：

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 包是運行在編譯時的，當程序編譯成 class 源代碼後，這個 jar 包就不會在源代碼層面有所體現。

接下來演示 Lombok 註解使用方式，並經過查看編譯後 class 文件，理解其工做原理，在這裏以 @Getter 註解爲例：

首先建立一個 GetterDemo 類，其中有 name 和 age 兩個字段。

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";
}

咱們在變量 age 上加上註解 @Getter，而且加上了參數來設置訪問級別，經過 onMethod_ 參數能夠爲咱們在生成的 getAge 方法添加上其餘註解，好比 @NonNull；在 name 上加上 @Getter 註解，並加上 lazy 參數並設爲 true，表示開啓懶加載。

接下來編譯下，編譯的 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() {
    }

    @NonNull
    private 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));
    }
}

能夠發現生成後的源代碼文件中，getAge 方法訪問修飾符爲 private，而且方法上有一個 @NonNull 的註解；getName 方法沒有剛開始就初始化一個字符串，而是隻有調用該方法的時候判斷該字段是否爲空，若爲空，則初始化一個字符串並返回，這樣就能夠爲開銷大的初始化操做作一個懶加載，只有當使用的時候纔會主動加載這個字段。

其餘的註解方法你們能夠本身去實踐操做下。

Lombok 優缺點

在瞭解完 Lombok 以後，讓咱們來分析下 Lombok 的優缺點吧！

Lombok 的優勢有如下幾點：

• 經過註解自動生成樣板代碼，提升開發效率
• 代碼簡潔，只關注相關屬性
• 新增屬性後，無需刻意修改相關方法

可是 Lombok 也有一些缺點：

• 下降了源代碼的可讀性和完整性
• 加大對問題排查的難度（可能問題定位到不存在的行，無從下手）
• 強 x 隊友，由於須要 IDE 的相關插件的支持

總結

本文介紹了什麼是 Lombok，Lombok 作了什麼以及 Lombok 的實現原理，而且分析了 Lombok 的利弊，你們在享受到它的好處的同時，也應該考慮到它帶來的一些問題，你在工做中有被隊友強 x 嗎？你對 Lombok 怎麼看？歡迎留言談論！