六，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
更多相關文章
  • Java 根據模板生成 PDF 文件 以及 excel 文件
    模板PDF 的欄位 引入maven <!-- iText for generating PDF files --> <dependency> <groupId>com.itextpdf</groupId> <artifactId>itextpdf</artifactId> <version>5.5. ...
  • 6.字元串類型和年齡游戲的升級
    Spring之IOC 簡介 首先，官網中有這樣一句話：Spring Framework implementation of the Inversion of Control (IoC) principle.這句話翻譯過來就是：Spring實現控制反轉(IOC)原理，由此可以得出，Inversion ...
  • 孩子特有的純真
    寫在前面 1447 字 | 感觸 | 見聞 | 孩子 | 童真 | 天性 正文 晚上。跳舞。 老師有很多學生，幾乎都念小學，大的不過五年級。小孩子。 今晚只來了一個。其他的孩子據說都在寫作業。 這幾天老師都打算回歸街舞本源，去街上跳舞，於是讓我們大包小包拿東西。 音箱、地膠、小型探照燈，水杯什麼的。 ...
  • 租約機制詳解
    概述 租約機制指在租約期限內，擁有租約的節點有權利操作一些預設好的對象，具體如下 租約是由授權者授予的一段時間內的承諾 授權者一旦發出租約，則無論接受方是否收到，也無論後續接收方處於何種狀態，只要租約不過期，授權者就得遵守承諾，按承諾的時間和內容執行。 接收方在有效期內可以使用授權者的租約，如果租約 ...
  • java~重寫hashcode和equals
    單欄位和多欄位重寫hashcode 在 Java 中，重寫 hashCode 方法的場景通常與對象的哈希值計算有關，特別是在使用哈希表（如 HashMap, HashSet 等）時。下麵是你提供的兩種 hashCode 實現的具體使用場景分析： 1. 第一種實現 @Override public b ...
  • CMake構建學習筆記13-opencv庫的構建
    OpenCV（Open Source Computer Vision Library）是一個開源的電腦視覺和機器學習軟體庫，旨在提供一個跨平臺的、易於使用的、快速執行的電腦視覺介面。如果只是簡單的使用，其實不必要像筆者這樣使用源代碼進行構建，直接使用官方提供的二進位安裝包即可。一般來說，需要從源 ...
  • 理想雪 - 就是為了來見你
    寫在前面 4002 字 | 陪伴 | 親密關係 | 患難與共 《理想雪》系列故事均為架空世界觀，所有人名、地名等與現實世界無任何關聯。 該系列只且僅只為了說明，小說作者在該情境下會誕生的想法和採取的行動，以及背後的世界觀、價值觀和人生觀。因此將具有強烈的個人風格。 未經授權，禁止轉載。僅供小範圍內閱 ...
  • manim邊學邊做--帶箭頭直線
    帶箭頭的直線就是有方向的直線，既可以用來表示矢量，也可以用來標記某個關鍵位置。manim中提供了4種常用的帶箭頭的直線模塊： Arrow：單箭頭的直線 DoubleArrow：雙箭頭的直線 LabeledArrow：帶標簽的直線 Vector：向量 其中，DoubleArrow，LabeledArr ...
一周排行
    -Advertisement-
    Play Games
  • C#自定義控制項—指示燈
    前言 推薦一款基於.NET 8、WPF、Prism.DryIoc、MVVM設計模式、Blazor以及MySQL資料庫構建的企業級工作流系統的WPF客戶端框架-AIStudio.Wpf.AClient 6.0。 項目介紹 框架採用了 Prism 框架來實現 MVVM 模式，不僅簡化了 MVVM 的典型 ...
  • WPF 保姆級教程怎麼實現一個樹形菜單
    先看一下效果吧: 我們直接通過改造一下原版的TreeView來實現上面這個效果 我們先創建一個普通的TreeView 代碼很簡單: <TreeView> <TreeViewItem Header="人事部"/> <TreeViewItem Header="技術部"> <TreeViewItem He ...
  • 2024 年學習人工智慧的免費認證課程
    1. 生成式 AI 簡介 https://imp.i384100.net/LXYmq3 2. Python 語言 https://imp.i384100.net/5gmXXo 3. 統計和 R https://youtu.be/ANMuuq502rE?si=hw9GT6JVzMhRvBbF 4. 數 ...
  • 必應每日壁紙API封裝
    本文為大家介紹下.NET解壓/壓縮zip文件。雖然解壓縮不是啥核心技術，但壓縮性能以及進度處理還是需要關註下，針對使用較多的zip開源組件驗證，給大家提供個技術選型參考 之前在《.NET WebSocket高併發通信阻塞問題 - 唐宋元明清2188 - 博客園 (cnblogs.com)》講過，團隊 ...
  • C#自定義控制項—旋轉按鈕
    之前寫過兩篇關於Roslyn源生成器生成源代碼的用例,今天使用Roslyn的代碼修複器CodeFixProvider實現一個cs文件頭部註釋的功能, 代碼修複器會同時涉及到CodeFixProvider和DiagnosticAnalyzer, 實現FileHeaderAnalyzer 首先我們知道修 ...
  • 不可不知的WPF幾何圖形（Geometry）
    在軟體行業，經常會聽到一句話“文不如表，表不如圖”說明瞭圖形在軟體應用中的重要性。同樣在WPF開發中，為了程式美觀或者業務需要，經常會用到各種個樣的圖形。今天以一些簡單的小例子，簡述WPF開發中幾何圖形（Geometry）相關內容，僅供學習分享使用，如有不足之處，還請指正。 ...
  • 可測試，可維護，可移植：上位機軟體分層設計的重要性
    在 C# 中使用 RabbitMQ 通過簡訊發送重置後的密碼到用戶的手機號上，你可以按照以下步驟進行 1.安裝 RabbitMQ 客戶端庫 首先，確保你已經安裝了 RabbitMQ 客戶端庫。你可以通過 NuGet 包管理器來安裝： dotnet add package RabbitMQ.Clien ...
  • 第19篇 Protocol Buffers 編譯器生成proto文件
    1.下載 Protocol Buffers 編譯器（protoc） 前往 Protocol Buffers GitHub Releases 頁面。在 "Assets" 下找到適合您系統的壓縮文件，通常為 protoc-{version}-win32.zip 或 protoc-{version}-wi ...
  • dotnet 讀 WPF 源代碼筆記 從 WM_POINTER 消息到 Touch 事件
    簡介 在現代微服務架構中，服務發現（Service Discovery）是一項關鍵功能。它允許微服務動態地找到彼此，而無需依賴硬編碼的地址。以前如果你搜 .NET Service Discovery，大概率會搜到一大堆 Eureka，Consul 等的文章。現在微軟為我們帶來了一個官方的包：Micr ...
  • .NET Core搭配Vue開源彈幕效果，實現一個評論小項目。好玩！
    ZY樹洞 前言 ZY樹洞是一個基於.NET Core開發的簡單的評論系統，主要用於大家分享自己心中的感悟、經驗、心得、想法等。 好了，不賣關子了，這個項目其實是上班無聊的時候寫的，為什麼要寫這個項目呢？因為我單純的想吐槽一下工作中的不滿而已。 項目介紹 項目很簡單，主要功能就是提供一個簡單的評論系統 ...
所有分類