> 作者：幻好
> 
> 來源：[恆生LIGHT雲社群](https://developer.hs.net/thread/1419 "恆生LIGHT雲社群")

### 引言

在通常的Java專案中，充斥著太多不友好的程式碼：POJO的getter/setter/toString；異常處理；I/O流的關閉操作等等，這些樣板程式碼既沒有技術含量，又影響著程式碼的美觀，Lombok應運而生。

而 IDEA 2020 版本中，已經內建了Lombok外掛，SpringBoot 2.1.x之後的版本也在Starter中內建了Lombok依賴。今天來講講Lombok的使用，看看它有何神奇之處！

### Lombok的安裝配置

使用 Lombok 之前我們先要在所使用的 IDE 中進行整合安裝，這裡以 IDEA 為例，安裝步驟十分簡單：

- 前往 `File -> Settings -> Plugin -> Marketplace` ，搜尋 Lombok，並安裝

![image-20210926224151642.png](https://developer.hs.net/storage/attachments/2021/09/26/0E6D1ck6pl2t0kvnyBgJrjbDFkuswshfq3cxGdnZ_thumb.png "3176")
- 選擇搜尋結果 Lombok ，點選 Install 安裝。
- 安裝完成後重啟即可。

在 IDE 安裝了 Lombok 外掛後，我們就可以在 `pom.xml` 檔案中新增 Lombok 的依賴進行使用了。

```xml
<dependency>
    <groupid>org.projectlombok</groupid>
    <artifactid>lombok</artifactid>
    <optional>true</optional>
</dependency>
```

### Lombok的常用註解

#### 1. [@Data](https://my.oschina.net/difrik)

`@Data` 是一個方便使用的組合註解，是 `@ToString`、`@EqualsAndHashCode`、`@Getter`、`@Setter` 和 `@RequiredArgsConstructor` 的組合體。

```java
@Data
public class DemoUser {
    private String userId;
    private String userName;
    private String userAge;
}
```

編譯後Lombok會生成如下程式碼：

```java
public class DemoUser {
    private String userId;
    private String userName;
    private String userAge;

public DemoUser() {
    }

public String getUserId() {
        return this.userId;
    }

public String getUserName() {
        return this.userName;
    }

public String getUserAge() {
        return this.userAge;
    }

public void setUserId(String userId) {
        this.userId = userId;
    }

public void setUserName(String userName) {
        this.userName = userName;
    }

public void setUserAge(String userAge) {
        this.userAge = userAge;
    }

public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof DemoUser)) {
            return false;
        } else {
            DemoUser other = (DemoUser)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                label47: {
                    Object this$userId = this.getUserId();
                    Object other$userId = other.getUserId();
                    if (this$userId == null) {
                        if (other$userId == null) {
                            break label47;
                        }
                    } else if (this$userId.equals(other$userId)) {
                        break label47;
                    }

return false;
                }

Object this$userName = this.getUserName();
                Object other$userName = other.getUserName();
                if (this$userName == null) {
                    if (other$userName != null) {
                        return false;
                    }
                } else if (!this$userName.equals(other$userName)) {
                    return false;
                }

Object this$userAge = this.getUserAge();
                Object other$userAge = other.getUserAge();
                if (this$userAge == null) {
                    if (other$userAge != null) {
                        return false;
                    }
                } else if (!this$userAge.equals(other$userAge)) {
                    return false;
                }

return true;
            }
        }
    }

protected boolean canEqual(Object other) {
        return other instanceof DemoUser;
    }

public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $userId = this.getUserId();
        int result = result * 59 + ($userId == null ? 43 : $userId.hashCode());
        Object $userName = this.getUserName();
        result = result * 59 + ($userName == null ? 43 : $userName.hashCode());
        Object $userAge = this.getUserAge();
        result = result * 59 + ($userAge == null ? 43 : $userAge.hashCode());
        return result;
    }

public String toString() {
        return "DemoUser(userId=" + this.getUserId() + ", userName=" + this.getUserName() + ", userAge=" + this.getUserAge() + ")";
    }
}
```

#### 2.[@Value](https://my.oschina.net/u/3193899)

使用 `@Value` 註解可以把類宣告為不可變的，宣告後此類相當於 `final` 類，無法被繼承，其屬性也會變成 `final` 屬性。

```java
@Value
public class DemoUser {
    private final String userId;
    private final String userName;
    private final String userAge;
}
```

編譯後Lombok會生成如下程式碼：

```java
public final class DemoUser {
    private final String userId;
    private final String userName;
    private final String userAge;

public DemoUser(String userId, String userName, String userAge) {
        this.userId = userId;
        this.userName = userName;
        this.userAge = userAge;
    }

public String getUserId() {
        return this.userId;
    }

public String getUserName() {
        return this.userName;
    }

public String getUserAge() {
        return this.userAge;
    }

public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof DemoUser)) {
            return false;
        } else {
            DemoUser other;
            label44: {
                other = (DemoUser)o;
                Object this$userId = this.getUserId();
                Object other$userId = other.getUserId();
                if (this$userId == null) {
                    if (other$userId == null) {
                        break label44;
                    }
                } else if (this$userId.equals(other$userId)) {
                    break label44;
                }

return false;
            }

Object this$userName = this.getUserName();
            Object other$userName = other.getUserName();
            if (this$userName == null) {
                if (other$userName != null) {
                    return false;
                }
            } else if (!this$userName.equals(other$userName)) {
                return false;
            }

Object this$userAge = this.getUserAge();
            Object other$userAge = other.getUserAge();
            if (this$userAge == null) {
                if (other$userAge != null) {
                    return false;
                }
            } else if (!this$userAge.equals(other$userAge)) {
                return false;
            }

return true;
        }
    }

public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $userId = this.getUserId();
        int result = result * 59 + ($userId == null ? 43 : $userId.hashCode());
        Object $userName = this.getUserName();
        result = result * 59 + ($userName == null ? 43 : $userName.hashCode());
        Object $userAge = this.getUserAge();
        result = result * 59 + ($userAge == null ? 43 : $userAge.hashCode());
        return result;
    }

public String toString() {
        return "DemoUser(userId=" + this.getUserId() + ", userName=" + this.getUserName() + ", userAge=" + this.getUserAge() + ")";
    }
}
```

#### 3.[@Slf4j](https://my.oschina.net/slf4j)

使用 Lombok 生成日誌物件時，根據使用日誌實現的不同，有多種註解可以使用。比如 `@Log`、`@Log4j`、`@Log4j2`、`@Slf4j`等。

```java
@Value
public class DemoUser {
    private final String userId;
    private final String userName;
    private final String userAge;
}
```

編譯後Lombok會生成如下程式碼：

```java
public class DemoUser {
    private static final Logger log = LoggerFactory.getLogger(DemoUser.class);
    private String userId;
    private String userName;
    private String userAge;

public DemoUser() {
    }
}
```

#### 4.[@Builder](https://my.oschina.net/u/1245189)

使用 `@Builder` 註解可以透過建造者模式來建立物件，建造者模式加鏈式呼叫，建立物件非常方便。

```java
@Builder
public class DemoUser {
    private final String userId;
    private final String userName;
    private final String userAge;
}
```

編譯後Lombok會生成如下程式碼：

```java
public class DemoUser {
    private final String userId;
    private final String userName;
    private final String userAge;

DemoUser(String userId, String userName, String userAge) {
        this.userId = userId;
        this.userName = userName;
        this.userAge = userAge;
    }

public static DemoUser.DemoUserBuilder builder() {
        return new DemoUser.DemoUserBuilder();
    }

public static class DemoUserBuilder {
        private String userId;
        private String userName;
        private String userAge;

DemoUserBuilder() {
        }

public DemoUser.DemoUserBuilder userId(String userId) {
            this.userId = userId;
            return this;
        }

public DemoUser.DemoUserBuilder userName(String userName) {
            this.userName = userName;
            return this;
        }

public DemoUser.DemoUserBuilder userAge(String userAge) {
            this.userAge = userAge;
            return this;
        }

public DemoUser build() {
            return new DemoUser(this.userId, this.userName, this.userAge);
        }

public String toString() {
            return "DemoUser.DemoUserBuilder(userId=" + this.userId + ", userName=" + this.userName + ", userAge=" + this.userAge + ")";
        }
    }
}
```

### Lombok的原理

如果IDEA不安裝Lombok外掛的話，我們開啟使用Lombok的專案是無法透過編譯的。裝了以後IDEA才會提示我們Lombok為我們生成的方法和屬性。

使用了@Data註解以後，檢視類結構可以發現getter、setter、toString等方法。

自Java 6起，javac開始支援**JSR 269 Pluggable Annotation Processing API**規範，只要程式實現了該API，就能在java原始碼編譯時呼叫定義的註解。舉例來講，如今有一個實現了"JSR 269 API"的程式A,那麼使用javac編譯原始碼的時候具體流程以下：

1. javac對原始碼進行分析，生成一棵抽象語法樹(AST)；外掛
2. 執行過程當中呼叫實現了"JSR 269 API"的A程式；
3. 此時A程式就能夠完成它本身的邏輯，包括修改第一步驟獲得的抽象語法樹(AST)；
4. javac使用修改後的抽象語法樹(AST)生成位元組碼檔案；

詳細的流程圖以下：

![53a402ceac1a471d889423831bfcb4bf-2.png](https://developer.hs.net/storage/attachments/2021/09/26/zVNLrnPXaQc29Y2OuEoZA0JRV0PSNFSlTYLbelHH_thumb.png "3177")

從上面的Lombok執行的流程圖中能夠看出，在Javac 解析成AST抽象語法樹以後, Lombok 根據本身編寫的註解處理器，動態地修改 AST，增長新的節點（即Lombok自定義註解所須要生成的程式碼），最終經過分析生成JVM可執行的位元組碼Class檔案。使用Annotation  Processing自定義註解是在編譯階段進行修改，而jdk的反射技術是在執行時動態修改，二者相比，反射雖然更加靈活一些可是帶來的效能損耗更加大。

### Lombok的缺點

- 在開發工具中，使用Lombok註解省略的方法在被呼叫時，會報找不到定義的錯誤，此種狀況下，須要作些特殊處理；
- 使用Lombok雖然可以省去手動建立`setter`和`getter`等方法的麻煩，可是卻大大下降了原始碼的可讀性和完整性，下降了閱讀原始碼的溫馨度。

認識Java專案開發效率工具 Lombok

相關文章