SpringBoot整合Lombok及常見問題怎麼解決

Lombok

使用註解可以讓Lombok簡化Java程式碼、提高開發效率。本身就是一個優秀的Java程式庫，它採用了一種投機取巧的語法糖，簡化了Java的編碼，為Java程式碼的精簡提供了一種方式，但Lombok並非一個標準的Java庫。

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

官方網站：Project Lombok

1. Lombok常用註解

##@Cleanup :關閉流

註解	作用
@Data	註解在類別上；提供類別所有屬性的getting 和setting 方法，也提供了equals、 canEqual、hashCode、toString 方法
@Setter	註解在屬性上；為屬性提供setting 方法
#@Setter	註解在屬性上；提供屬性getting 方法
#@Log4j	註解在類別上；為類別提供一個屬性名為log 的log4j 日誌物件
@NoArgsConstructor	#註解在類別上；為類別提供一個無參的建構方法
@ AllArgsConstructor	註解在類別上；為類別提供一個全參的建構方法

################################################################################################################################### ######@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以及建構器等方法；

在最新版本的DeLombok中，可以使用該工具產生上述這些方法。右鍵選擇Refactored->DeLombok：

#############或使用一個指令：###

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

###把Lombok 註解實作的類別檔案轉換成不使用Lombok 的Java 來源文件。 ######使用Lombok可以簡化JavaBean封裝，但會影響可讀性。另外盡量不要使用這個註解@AllArgsConstructor，該註解提供一個巨型構造器，使外界有機會在初始化物件時修改類別中所有的屬性是非常不安全的，畢竟Java類別中物件的某些屬性不應被修改。同時，如果某個Java類別中有好多個屬性，那麼Lombok會注入好多個參數的構造器到Java類別中，而構造器參數的順序完全由Lombok所控制。 ######3.使用Lombok來寫Javabean程式碼後，其餘依賴此javabean的其他程式碼都需要引入Lombok依賴，程式碼耦合度上升。同時，也需要在IDE中安裝Lombok的插件。 ######4.如果是協同開發，則需要注意以下問題：###當我們的程式碼中引入了Lombok插件，其他人也必須去下載、引入Lombok插件，否則Java程式碼可能無法正常運行。 ###

以上是SpringBoot整合Lombok及常見問題怎麼解決的詳細內容。更多資訊請關注PHP中文網其他相關文章！