SpringBoot整合Lombok及常見問題解決

2022-04-14 19:02:23

Lombok

Lombok能以簡單的註解形式來簡化java程式碼，從而提高開發人員的開發效率。其本身是一個優秀的Java程式碼庫，它採用了一種投機取巧的語法糖，簡化了Java的編碼，為Java程式碼的精簡提供了一種方式，但Lombok並非一個標準的Java庫。

在web開發過程中經常需要寫的Java類，都需要花時間去新增相應的getter/setter、構造器和equals等方法。當屬性多時會出現大量的getter/setter方法，這些顯得很冗長也沒有太多技術含量，一旦修改屬性，容易出現忘記修改對應方法的情況。

官方網站：Project Lombok

1. Lombok常用註解

註解	作用
@Data	註解在類上；提供類所有屬性的 getting 和 setting 方法，還提供了equals、canEqual、hashCode、toString 方法
@Setter	註解在屬性上；為屬性提供 setting 方法
@Setter	註解在屬性上；為屬性提供 getting 方法
@Log4j	註解在類上；為類提供一個屬性名為log 的 log4j 紀錄檔物件
@NoArgsConstructor	註解在類上；為類提供一個無參的構造方法
@AllArgsConstructor	註解在類上；為類提供一個全參的構造方法
@Cleanup :	關閉流
@Builder	被註解的類增加構造者模式
@Synchronized	同步鎖
@SneakyThrows	捕獲異常，類似try/catch 捕獲異常
@NonNull	給引數加個這個註解，當引數為null會丟擲空指標異常
@Value	註解和@Data類似，預設定義所有成員變數為private final修飾，不生成set方法

2. Lombok註解失效原因

在pom.xml引入Lombok依賴後，還需要安裝Lombok外掛，重啟IDEA才能生效。

整合過程

1. 引入Lombok依賴：

複製如下程式碼並插入pom.xml當中，等待maven倉庫自動下載安裝依賴，沒有設定自動導包點選手動匯入。

<!--匯入lombok小辣椒驅動依賴,用來生成get/set等方法依賴-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <!--<optional>true</optional>-->
            <version>1.18.12</version>
            <scope>provided</scope><!--自動生成有參無參構造-->
        </dependency>

2. 安裝Lombok外掛

在IDEA中點選File-》Setting-》Plugins-》搜尋Lombok安裝外掛後，重啟IDEA;

3. 利用Lombok為屬性生成getter/setter等方法程式程式碼範例

a.未使用Lombok編寫實體類（程式肥胖、不好看）

使用IDE自帶的快捷鍵能自動生成getter/setter這些方法：

package com.dvms.entity;

/*
 *檔名: Anglerecord
 *建立者: CJW
 *建立時間:2020/6/6 14:40
 *描述: 記錄
 */
public class Record {

    private String time;
    private String device;
    private String state;

    public Record(String time, String device, String state) {
        this.time = time;
        this.device = device;
        this.state = state;
    }

    public Record() {
    }

    public String getTime() {
        return this.time;
    }

    public String getDevice() {
        return this.device;
    }

    public String getState() {
        return this.state;
    }

    public Record setTime(String time) {
        this.time = time;
        return this;
    }

    public Record setDevice(String device) {
        this.device = device;
        return this;
    }

    public Record setState(String state) {
        this.state = state;
        return this;
    }

    public boolean equals(final Object o) {
        if (o == this) return true;
        if (!(o instanceof Record)) return false;
        final Record other = (Record) o;
        if (!other.canEqual((Object) this)) return false;
        final Object this$time = this.getTime();
        final Object other$time = other.getTime();
        if (this$time == null ? other$time != null : !this$time.equals(other$time)) return false;
        final Object this$device = this.getDevice();
        final Object other$device = other.getDevice();
        if (this$device == null ? other$device != null : !this$device.equals(other$device)) return false;
        final Object this$state = this.getState();
        final Object other$state = other.getState();
        if (this$state == null ? other$state != null : !this$state.equals(other$state)) return false;
        return true;
    }

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

    public int hashCode() {
        final int PRIME = 59;
        int result = 1;
        final Object $time = this.getTime();
        result = result * PRIME + ($time == null ? 43 : $time.hashCode());
        final Object $device = this.getDevice();
        result = result * PRIME + ($device == null ? 43 : $device.hashCode());
        final Object $state = this.getState();
        result = result * PRIME + ($state == null ? 43 : $state.hashCode());
        return result;
    }

    public String toString() {
        return "Record(time=" + this.getTime() + ", device=" + this.getDevice() + ", state=" + this.getState() + ")";
    }
}

b.引入Lombok生成方法（程式苗條、看著很舒服）

可自己根據需求手動增添註解，也可以通過右鍵-》Refactor-》Lomok-》

package com.dvms.entity;

/*
 *檔名: Anglerecord
 *建立者: CJW
 *建立時間:2020/6/6 14:40
 *描述: 記錄
 */

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
import lombok.experimental.Accessors;

@Data
@ToString
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain = true) //鏈式呼叫
public class Record {

    private String time;
    private String device;
    private String state;
}

優點與缺點（可能出現的問題即解決方法）

優點：
Lombok能通過註解的方式，在編譯時自動為屬性生成getter/setter、equals和toString等方法，省去了手動重建這些程式碼的麻煩，使程式實體類（entity/pojo）程式碼看起來更‘苗條’、更有逼格。

缺點（可能出現的問題）：
如果是個人開發，可能出現如下問題：

1.Lombok目前支援JDK1.8，升級JDK版本後可能失效，解決方法：
a.通過IDE自帶的快捷鍵Alt+Insert生成getter/setter，equals，hashCode，toString以及構造器等方法；

b.使用DeLombok工具生成上述這些方法，在最新版本中已包含DeLombok。右鍵選擇Refactored->DeLombok：

或者使用一個命令：

java -jar lombok.jar delombok src -d src-delomboked

把 Lombok 註解實現的類檔案轉換為不使用 Lombok 的 Java 原始檔。

2.Lombok隱藏了JavaBean封裝的細節，程式看著簡潔但是可讀性差。此外儘量不要使用使用這個註解@AllArgsConstructor，該註解提供一個巨型構造器，使外界有機會在初始化物件時修改類中所有的屬性是非常不安全的，畢竟Java類中物件的某些屬性不應被修改。同時，如果某個Java類中有好多個屬性，那麼Lombok會注入好多個引數的構造器到Java類中，而構造器引數的順序完全由Lombok所控制。

3.使用Lombok來編寫Javabean程式碼後，其餘依賴此javabean的其他程式碼都需要引入Lombok依賴，程式碼耦合度上升。同時，還需要在IDE中安裝Lombok的外掛。

4.如果是協同開發，則需要注意如下問題：
當我們的程式程式碼中引入了Lombok外掛，其他人也必須去下載、引入Lombok外掛，否則Java程式碼可能無法正常執行。

到此這篇關於SpringBoot整合Lombok及常見問題解決的文章就介紹到這了,更多相關SpringBoot整合Lombok內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！