六,Spring Boot 容器中 Lombok 插件的詳細使用,簡化配置,提高開發效率

来源:https://www.cnblogs.com/TheMagicalRainbowSea/p/18392433
-Advertisement-
Play Games

六,Spring Boot 容器中 Lombok 插件的詳細使用,簡化配置,提高開發效率 @目錄六,Spring Boot 容器中 Lombok 插件的詳細使用,簡化配置,提高開發效率1. Lombok 介紹2. Lombok 常用註解2.1 @ToString2.2 @Setter2.3 @Dat ...


六,Spring Boot 容器中 Lombok 插件的詳細使用,簡化配置,提高開發效率

@

目錄


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. 最後:

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

在這裡插入圖片描述


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 模板PDF 的欄位 引入maven <!-- iText for generating PDF files --> <dependency> <groupId>com.itextpdf</groupId> <artifactId>itextpdf</artifactId> <version>5.5. ...
  • Spring之IOC 簡介 首先,官網中有這樣一句話:Spring Framework implementation of the Inversion of Control (IoC) principle.這句話翻譯過來就是:Spring實現控制反轉(IOC)原理,由此可以得出,Inversion ...
  • 寫在前面 1447 字 | 感觸 | 見聞 | 孩子 | 童真 | 天性 正文 晚上。跳舞。 老師有很多學生,幾乎都念小學,大的不過五年級。小孩子。 今晚只來了一個。其他的孩子據說都在寫作業。 這幾天老師都打算回歸街舞本源,去街上跳舞,於是讓我們大包小包拿東西。 音箱、地膠、小型探照燈,水杯什麼的。 ...
  • 概述 租約機制指在租約期限內,擁有租約的節點有權利操作一些預設好的對象,具體如下 租約是由授權者授予的一段時間內的承諾 授權者一旦發出租約,則無論接受方是否收到,也無論後續接收方處於何種狀態,只要租約不過期,授權者就得遵守承諾,按承諾的時間和內容執行。 接收方在有效期內可以使用授權者的租約,如果租約 ...
  • 單欄位和多欄位重寫hashcode 在 Java 中,重寫 hashCode 方法的場景通常與對象的哈希值計算有關,特別是在使用哈希表(如 HashMap, HashSet 等)時。下麵是你提供的兩種 hashCode 實現的具體使用場景分析: 1. 第一種實現 @Override public b ...
  • OpenCV(Open Source Computer Vision Library)是一個開源的電腦視覺和機器學習軟體庫,旨在提供一個跨平臺的、易於使用的、快速執行的電腦視覺介面。如果只是簡單的使用,其實不必要像筆者這樣使用源代碼進行構建,直接使用官方提供的二進位安裝包即可。一般來說,需要從源 ...
  • 寫在前面 4002 字 | 陪伴 | 親密關係 | 患難與共 《理想雪》系列故事均為架空世界觀,所有人名、地名等與現實世界無任何關聯。 該系列只且僅只為了說明,小說作者在該情境下會誕生的想法和採取的行動,以及背後的世界觀、價值觀和人生觀。因此將具有強烈的個人風格。 未經授權,禁止轉載。僅供小範圍內閱 ...
  • 帶箭頭的直線就是有方向的直線,既可以用來表示矢量,也可以用來標記某個關鍵位置。manim中提供了4種常用的帶箭頭的直線模塊: Arrow:單箭頭的直線 DoubleArrow:雙箭頭的直線 LabeledArrow:帶標簽的直線 Vector:向量 其中,DoubleArrow,LabeledArr ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...