SpringBoot整合Lombok及常見問題解決

更新時間：2022年04月14日 15:29:54 作者：*豬耳朵*

本文主要介紹了SpringBoot整合Lombok及常見問題解決，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

Lombok

Lombok能以簡單的注解形式來簡化java代碼，從而提高開發(fā)人員的開發(fā)效率。其本身是一個優(yōu)秀的Java代碼庫，它采用了一種投機取巧的語法糖，簡化了Java的編碼，為Java代碼的精簡提供了一種方式，但Lombok并非一個標準的Java庫。

在web開發(fā)過程中經(jīng)常需要寫的Java類，都需要花時間去添加相應的getter/setter、構(gòu)造器和equals等方法。當屬性多時會出現(xiàn)大量的getter/setter方法，這些顯得很冗長也沒有太多技術(shù)含量，一旦修改屬性，容易出現(xiàn)忘記修改對應方法的情況。

請?zhí)砑訄D片描述

官方網(wǎng)站：Project Lombok

1. Lombok常用注解

注解	作用
@Data	注解在類上；提供類所有屬性的 getting 和 setting 方法，還提供了equals、canEqual、hashCode、toString 方法
@Setter	注解在屬性上；為屬性提供 setting 方法
@Setter	注解在屬性上；為屬性提供 getting 方法
@Log4j	注解在類上；為類提供一個屬性名為log 的 log4j 日志對象
@NoArgsConstructor	注解在類上；為類提供一個無參的構(gòu)造方法
@AllArgsConstructor	注解在類上；為類提供一個全參的構(gòu)造方法
@Cleanup :	關(guān)閉流
@Builder	被注解的類增加構(gòu)造者模式
@Synchronized	同步鎖
@SneakyThrows	捕獲異常，類似try/catch 捕獲異常
@NonNull	給參數(shù)加個這個注解，當參數(shù)為null會拋出空指針異常
@Value	注解和@Data類似，默認定義所有成員變量為private final修飾，不生成set方法

請?zhí)砑訄D片描述

2. Lombok注解失效原因

在pom.xml引入Lombok依賴后，還需要安裝Lombok插件，重啟IDEA才能生效。

整合過程

1. 引入Lombok依賴：

復制如下代碼并插入pom.xml當中，等待maven倉庫自動下載安裝依賴，沒有設置自動導包點擊手動導入。

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

請?zhí)砑訄D片描述

2. 安裝Lombok插件

在IDEA中點擊File-》Setting-》Plugins-》搜索Lombok安裝插件后，重啟IDEA;

請?zhí)砑訄D片描述

3. 利用Lombok為屬性生成getter/setter等方法程序代碼示例

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

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

請?zhí)砑訄D片描述

package com.dvms.entity;

/*
 *文件名: Anglerecord
 *創(chuàng)建者: CJW
 *創(chuàng)建時間: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生成方法（程序苗條、看著很舒服）

可自己根據(jù)需求手動增添注解，也可以通過右鍵-》Refactor-》Lomok-》

請?zhí)砑訄D片描述

package com.dvms.entity;

/*
 *文件名: Anglerecord
 *創(chuàng)建者: CJW
 *創(chuàng)建時間: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) //鏈式調(diào)用
public class Record {

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

優(yōu)點與缺點（可能出現(xiàn)的問題即解決方法）

優(yōu)點：
Lombok能通過注解的方式，在編譯時自動為屬性生成getter/setter、equals和toString等方法，省去了手動重建這些代碼的麻煩，使程序?qū)嶓w類（entity/pojo）代碼看起來更‘苗條’、更有逼格。

缺點（可能出現(xiàn)的問題）：
如果是個人開發(fā)，可能出現(xiàn)如下問題：

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

請?zhí)砑訄D片描述

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

請?zhí)砑訄D片描述

或者使用一個命令：

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

把 Lombok 注解實現(xiàn)的類文件轉(zhuǎn)換為不使用 Lombok 的 Java 源文件。

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

3.使用Lombok來編寫Javabean代碼后，其余依賴此javabean的其他代碼都需要引入Lombok依賴，代碼耦合度上升。同時，還需要在IDE中安裝Lombok的插件。

4.如果是協(xié)同開發(fā)，則需要注意如下問題：
當我們的程序代碼中引入了Lombok插件，其他人也必須去下載、引入Lombok插件，否則Java代碼可能無法正常運行。

到此這篇關(guān)于SpringBoot整合Lombok及常見問題解決的文章就介紹到這了,更多相關(guān)SpringBoot整合Lombok內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: