快捷導(dǎo)航

SpringBoot整合Lombok插件與使用詳解

更新時(shí)間：2024年09月28日 11:51:29 作者：pan_junbiao

Lombok是Java開發(fā)的插件,通過(guò)注解自動(dòng)生成常用代碼,如getter/setter,節(jié)省開發(fā)時(shí)間,提高效率,它在編譯期生成方法,不影響性能,安裝Lombok需要添加Maven依賴和IDEA插件,使用注解如@Data、@Getter等簡(jiǎn)化代碼編寫,官網(wǎng)提供詳細(xì)文檔

1、Lombok 插件的簡(jiǎn)介

‌Lombok‌ 是一款 Java 開發(fā)插件，旨在通過(guò)定義的一些注解來(lái)消除業(yè)務(wù)工程中冗長(zhǎng)和繁瑣的代碼，尤其是對(duì)于簡(jiǎn)單的 Java 模型對(duì)象(POJO)。使用 Lombok 插件后，Java 開發(fā)人員可以節(jié)省出重復(fù)構(gòu)建諸如 hashCode 和 equals 這樣的方法以及各種業(yè)務(wù)對(duì)象模型的 accessor 和 ToString 等方法的大量時(shí)間。這些方法在編譯源代碼期間自動(dòng)生成，并沒(méi)有如反射那樣降低程序的性能。

Lombok官網(wǎng)：《Project Lombok》

2、安裝 Lombok

（1）添加 Maven 依賴

打開 pom.xml 文件，添加 Maven 依賴：

<!-- Lombok 依賴 -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.34</version>
    <scope>provided</scope>
</dependency>

（2）安裝 IDEA 插件

打開 IDEA，單擊 IDEA 菜單欄“File → settings” 選項(xiàng)，在彈出的對(duì)話框中選擇“Plugins”（插件）選項(xiàng)，在彈出的插件窗口的搜索欄中輸入：Lombok，在搜索結(jié)果中找到 Lombok，單擊“install”按鈕完成安裝。在安裝完成后，在使用 Lombok 前需要重啟 IDEA。

3、Lombok 的使用

安裝完成后，開發(fā)人員可以通過(guò)簡(jiǎn)單的注解形式來(lái)幫助簡(jiǎn)化消除一些必須有但顯得很臃腫的 Java 代碼，如屬性的構(gòu)造器、getter、setter、equals、hashcode、toString方法等，從而提高開發(fā)效率，使開發(fā)者能夠?qū)Ｗ⒂跇I(yè)務(wù)邏輯的實(shí)現(xiàn)‌。

【實(shí)例】創(chuàng)建實(shí)體類，使用 Lombok 提供的注解，簡(jiǎn)化代碼。

（1）創(chuàng)建 UserInfo.java 用戶信息實(shí)體類

package com.pjb.pm.entity;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
/**
 * 用戶信息實(shí)體類
 * @author pan_junbiao
 **/
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserInfo
{
    private Long userId;
    private String userName;
    private String departmentCode;
    private String blogName;
    private String blogUrl;
}

（2）初始化用戶信息對(duì)象類，并打印對(duì)象屬性

public static void main(String[] args)
{
    //創(chuàng)建用戶對(duì)象，由于使用 @Builder 注解，所有可以使用鏈?zhǔn)斤L(fēng)格創(chuàng)建對(duì)象。
    UserInfo userInfo = UserInfo.builder()
            .userId(1L)
            .userName("pan_junbiao的博客")
            .blogName("您好，歡迎訪問(wèn) pan_junbiao的博客")
            .blogUrl("https://blog.csdn.net/pan_junbiao")
            .build();
    //打印用戶對(duì)象，由于使用了 @Data 注解，所有自動(dòng)生成 toString 方法
    System.out.println(userInfo);
}

控制臺(tái)輸出結(jié)果：

UserInfo(userId=1, userName=pan_junbiao的博客, blogName=您好，歡迎訪問(wèn) pan_junbiao的博客, blogUrl=https://blog.csdn.net/pan_junbiao)

4、Lombok 注解說(shuō)明

注解	說(shuō)明
@Data	自動(dòng)生成 Getter/Setter、toString、equals、hashCode 方法，以及不帶參數(shù)的構(gòu)造方法。
@Getter、@Setter	自動(dòng)生成 Getter/Setter 方法
@ToString	自動(dòng)生成 toString 方法。
@NoArgsConstructor	自動(dòng)生成無(wú)參構(gòu)造方法。
@RequiredArgsConstructor	自動(dòng)生成包含 final 和 @NonNull 修飾的屬性的構(gòu)造方法。
@AllArgsConstructor	自動(dòng)生成全參的構(gòu)造方法。
@NonNull	輔助處理 NullPointerException 異常。當(dāng)用于方法參數(shù)前，表示調(diào)用該方法時(shí)參數(shù)不能為 null；當(dāng)用于屬性上方，表示為該屬性賦值時(shí)值不能為 null。
@EqualsAndHashCode	自動(dòng)生成 equals 和 hashCode、canEqual 方法。用于比較兩個(gè)類對(duì)象是否相同。
@Builder	提供鏈?zhǔn)斤L(fēng)格創(chuàng)建對(duì)象。
@CleanUp	自動(dòng)管理資源，不用再在 finally 中添加資源的 close 方法，例如：關(guān)閉 IO 流對(duì)象。
@Value	用于注解 final 類。
@SneakyThrows	對(duì)方法中異常進(jìn)行捕捉并拋出。
@Log	支持使用各種日志（Logger）對(duì)象。在類中生成日志對(duì)象，在方法中可以直接使用。針對(duì)不同的日志實(shí)現(xiàn)產(chǎn)品，有不同的日志注解，使用 @Log 表示使用 Java 自帶的日志功能，除了 @Log ，還可以使用@Log4j 、 @Log4j2 、 @Slf4j 等注解，來(lái)使用不同的日志產(chǎn)品。