六，Spring Boot 容器中 Lombok 外掛的詳細使用，簡化配置，提高開發效率

Rainbow-Sea發表於2024-09-02
Spring BootLombok

六，Spring Boot 容器中 Lombok 外掛的詳細使用，簡化配置，提高開發效率

@

目錄
  • 六，Spring Boot 容器中 Lombok 外掛的詳細使用，簡化配置，提高開發效率
  • 1. Lombok 介紹
  • 2. Lombok 常用註解
    • 2.1 @ToString
    • 2.2 @Setter
    • 2.3 @Data
    • 2.4 @AllArgsConstructor
    • 2.5 @NoArgsConstructor
  • 3. 在 idea 中 安裝 lombok外掛
  • 4. 總結：
  • 6. 最後：

1. Lombok 介紹

Lombok 作用：

  1. 簡化 Java Bean開發，可以使用 Lombok 的註解讓程式碼更加簡潔。
  2. Java專案中，很多沒有技術含量但又必須存在的程式碼；比如：Pojo 的 getter/setter/toString ；異常處理：I/O流的關閉操作等等。
  3. Java專案中，很多沒有技術含量但又必須存在的程式碼：比如：這些程式碼既沒有技術含量，又影響著程式碼的美觀，Lombok 應運而生。

Spring Boot 和 IDEA 官方支援

  1. IDEA 2020已經內建了 Lombok外掛
  2. Spring Boot 2.1.x之後的版本也在 Stater中內建了 Lombok 依賴

2. Lombok 常用註解

@Data：註解在類上，提供類所有屬性的getting和setting方法，此外還提供了equals,canEqual,hashCode,toString方法
@Setter: 註解在屬性上，為屬性提供 setting 方法，註解在類上，則為類中的所有屬性提供 set()方法。
@Getter: 註解在屬性上，為屬性提供 getting 方法註解在類上，則為類中的所有屬性提供 get()方法。
@Log4j：註解在類上：為類提供了一個屬性名為: log 的 log4j的日誌物件
@NoArgsConstructor: 註解在類上，為類提供一個無參的構造方法,(一定會提供)
@AllArgsConstructor: 註解在類上，為類提供一個全參的構造方法
@Cleanup: 可以關閉流
@Builder: 被註解的類加個構造者模式
@Synchronized: 加同步鎖 
@SneakyThrows: 等同於try/catcher捕獲異常
@NonNull:如果給引數加個這個註解，引數為null會丟擲空指標異常
@Value: 註解和@Value類似，區別在於它會把所有成員變數預設定義為 private final 修飾，並且不會生產set()方法

下面我們測試，使用幾個，在開發中比較常用的註解 。

首先想要使用上 Lombok 需要匯入相關 jar 依賴，也可以不用特別匯入，直接使用 Spring Boot 自帶內建的即可。

在這裡插入圖片描述

   <!--        引入 lombok ，使用版本仲裁-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.rainbowsea</groupId>
    <artifactId>springboot_lombok</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!--    匯入SpringBoot 父工程-規定寫法-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.3</version>
    </parent>


    <dependencies>
        <!--    匯入web專案場景啟動器：會自動匯入和web開發相關的jar包所有依賴【庫/jar】-->
        <!--    後面還會在說明spring-boot-starter-web 到底引入哪些相關依賴-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--        引入 lombok ，使用版本仲裁-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

</project>

2.1 @ToString

@ToString： // 在編譯時，生成 toString，注意：預設情況下，會生成一個無參構造器。

在這裡插入圖片描述

package com.rainbowsea.springboot.bean;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;




@ToString  // 在編譯時，生成 toString，注意：預設情況下，會生成一個無參構造器
public class Furn {
    private Integer id = 100;
    private String name = "張三";
    private Double price = 999.0;


}

使用 lombok 註解簡化程式碼，可以透過 idea 自帶的反編譯功能 target，看Furn.class的原始碼，就
可以看到生成的完整程式碼。

如果目錄當中沒有 target 目錄顯示，可以進行如下操作：

在這裡插入圖片描述

在這裡插入圖片描述

2.2 @Setter

@Setter 註解： 註解在屬性上，為屬性提供 setting 方法，註解在類上，則為類中的所有屬性提供 set()方法。

首先，我們先註解使用在屬性上。

在這裡插入圖片描述

package com.rainbowsea.springboot.bean;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;


public class Furn {

    @Setter // 註解在屬性上，編譯生成一個，該屬性的 set()方法：預設情況下，會生成一個無參構造器
    private Integer id = 100;

    private String name = "張三";
    private Double price = 999.0;


}

在這裡插入圖片描述

新增到類上，為類中所有的屬性都新增，set() 方法。

在這裡插入圖片描述

在這裡插入圖片描述

2.3 @Data

@Data ：註解在類上，提供類所有屬性的getting和setting方法，此外還提供 equals，canEqual，hashCode，toString方法， @RequiredArgsConstructor

特別說明: @Data 中的 @RequiredArgsConstructor
在我們寫controller 或是 Service層的時候，需要注入很多的 mapper介面或者另外的service介面，這時候就會寫很多
的@Autowired註解，程式碼看起來很亂。Lombok 提供了一個註解:
@RequiredArgsConstructor(onConstructor=@_(@AutoWired))
寫在類上可以代替@Autowired註解，需要注意的時在注入時，需要用final定義，或者使用 @notnull註解

在這裡插入圖片描述

package com.rainbowsea.springboot.bean;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;



@Data// 註解等價使用了，如下註解: @Getter,@Setter,@RequiredArgsConstructor @ToString,@EqualsAndHas
public class Furn {

    private Integer id = 100;

    private String name = "張三";
    private Double price = 999.0;


}

在這裡插入圖片描述

2.4 @AllArgsConstructor

@AllArgsConstructor：在編譯時，會生成全引數構造器

在這裡插入圖片描述

package com.rainbowsea.springboot.bean;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;



@AllArgsConstructor // 在編譯時，會生成全引數構造器
public class Furn {

    private Integer id = 100;

    private String name = "張三";
    private Double price = 999.0;


}

在這裡插入圖片描述

注意：這裡：我們會發現一點，就是有全引數構造器，但是，卻沒有生成一個預設的“無引數構造器”

2.5 @NoArgsConstructor

@NoArgsConstructor： 在編譯時，會生成無參構造器（一定會生成），不會受到其它的

在這裡插入圖片描述

package com.rainbowsea.springboot.bean;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;


@NoArgsConstructor //在編譯時，會生成無參構造器（一定會生成），不會受到其它的
public class Furn {

    private Integer id = 100;

    private String name = "張三";
    private Double price = 999.0;


}

在這裡插入圖片描述

特別說明：

特別說明，雖然上面的@Data,@ToString註解等等，預設情況下都會生成一個無參構造器，但是當你使用了多個註解的時候，可能會覆蓋掉無參構造器。 但是當我們有其它多個構造器生成時，你如果你希望仍然有無參構造器就需要使用 @NoArgsConstructor 註解了，因為 @NoArgsConstructor是一定會生成一個無參構造器的（無參構造器很重要，因為框架的使用是涉及到反射機制的，而反射機制，需要一個無參構造器，否則你就無法進行反射獲取 bean物件，框架也就無法使用了）。

如下：測試。我們新增上 @Data註解和 @AllArgsConstructor 註解。可以明顯的發現，預設的無引數構造器被覆蓋掉了

在這裡插入圖片描述

所以我們需要新增上：@NoArgsConstructor註解，因為@NoArgsConstructor註解，在編譯時，會生成無參構造器（一定會生成），不會受到其它的影響，被覆蓋。如圖

在這裡插入圖片描述

3. 在 idea 中 安裝 lombok外掛

不裝外掛也可以用基本的註解比如：@Data,@Getter...
但是不能使用其擴充套件功能，比如日誌輸出...，所以我們還是安裝一下，也比較簡單。
直接去外掛商城，搜尋: Lombok 即可

在這裡插入圖片描述

在這裡插入圖片描述

package com.rainbowsea.springboot.controller;


import com.rainbowsea.springboot.bean.Furn;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@Slf4j
@RestController  // @Controller + @ResponseBody
public class HiController {


    @Autowired
    private Furn furn;


    @RequestMapping("/hi") // 設定請求對映路徑
    public String hi(){
        log.info("furn-"+furn);

        // 佔位符方式輸出
        log.info("furn={} myfurn={}",furn,furn);


        return  "hi word";
        // 使用 slf4j日誌輸出
    }
}

執行測試：

在這裡插入圖片描述

4. 總結：

  1. 熟悉常用的 Lombok 註解，提供開發效率。
  2. 基本上@註解都會生成一個預設的無參構造器，但是當存在多個註解的時候，這個預設的無參構造器，可能會被覆蓋掉，從而導致無法不會被生成。但是，框架的上的使用，基本上都是需要使用上反射 機制的，而反射機制是必須要有一個無參構造器 才可以進行反射，獲取到對應的 Bean物件。給框架使用。所以，一般的 bean 物件都會新增上一個@NoArgsConstructor註解該在編譯時，會生成無參構造器（一定會生成），不會受到其它的

6. 最後：

“在這個最後的篇章中，我要表達我對每一位讀者的感激之情。你們的關注和回覆是我創作的動力源泉，我從你們身上吸取了無盡的靈感與勇氣。我會將你們的鼓勵留在心底，繼續在其他的領域奮鬥。感謝你們，我們總會在某個時刻再次相遇。”

在這裡插入圖片描述

相關文章