SpringBoot [ 4.使用Lombok]

最新推荐文章于 2025-08-24 21:54:12 发布
原创 最新推荐文章于 2025-08-24 21:54:12 发布 · 535 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#springboot #lombok

本文介绍了SpringBoot项目中Lombok的使用，包括如何集成Lombok插件，通过pom引入依赖，以及常用注解如@Getter、@Setter、@ToString、@EqualsAndHashCode、@Data、@RequiredArgsConstructor、@AllArgsConstructor和@Accessors的详细用法，帮助提高编程效率。

SpringBoot [ 4.使用Lombok] - 目录

文章目录

1.概述

我前面得几篇博客频繁得使用到了Lombok，这里我就讲一下，我在公司得工作过程当中，我最常用得一些Lombok得注解得用法。

Lombok它是一款使用注解，用来精简代码，提高编程效率得Java工具，
至于它是怎么精简得，以及它得一些特性，下面得内容我会介绍。

2.使用

2.1.编译器集成Lombok插件

Java编译器，idea和eclipse都可以集成Lombok插件，本人使用得是idea，这里就简单介绍一下idea得集成。

打开idea得setting配置，在Plugins中搜索Lombok，点击安装，然后重启编译器即可使用。

在这里插入图片描述

2.2.pom引入依赖

spring-boot-dependencies当中已经有了Lombok得版本管理，这里我们直接引入就好了。

<!-- Lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
</dependency>


<!-- 依赖统一管理 -->
<dependencyManagement>
    <dependencies>
        <!-- Spring Boot -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>${spring.boot.version}</version>
            <scope>import</scope>
            <type>pom</type>
        </dependency>
    </dependencies>
</dependencyManagement>

3.常用注解

在工作当中，我最常用得就是在，entity，dto，vo这些类上频繁得使用到Lombok得注解; 这些注解得作用其实就是，使用之后不需要编写对应得Java代码，比如说我使用@Getter注解之后，就不需要编写get方法；

不需要编写代码，那项目怎么运行呢，是这样的，在项目进行打包编译得时候它会在.class文件中自动生成对应得代码，只不过在我们项目源码中没有对应得编码。

3.1.类注解

3.1.1.@Getter

在类打上@Getter注解，不需要生成Get方法得代码，其他地方就可直接使用Get方法;

package com.mantou.boot.dto;

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Getter
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

在这里插入图片描述

/**
 * Lombok测试接口
 * @author mantou
 */
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {

    /**
     * 获取Lombok实例
     * @return
     */
    @GetMapping(value = "/getLombokInstance")
    public Result getLombokInstance() {

        LombokDemoDTO lombokDemoDTO = new LombokDemoDTO();
        String content = lombokDemoDTO.getContent();

        return Result.success();
    }
}

3.1.2.@Setter

在类打上@Setter注解，不需要生成Set方法得代码，其他地方就可直接使用Set方法;

package com.mantou.boot.dto;

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Getter
@Setter
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

在这里插入图片描述

/**
 * Lombok测试接口
 * @author mantou
 */
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {

    /**
     * 获取Lombok实例
     * @return
     */
    @GetMapping(value = "/getLombokInstance")
    public Result getLombokInstance() {

        LombokDemoDTO lombokDemoDTO = new LombokDemoDTO();
        lombokDemoDTO.setContent("内容");
        String content = lombokDemoDTO.getContent();

        return Result.success();
    }
}

3.1.3.@ToString

在类打上@ToString注解，会重写类得toString方法

package com.mantou.boot.dto;

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Getter
@Setter
@ToString
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

3.1.5.@EqualsAndHashCode

在类打上@EqualsAndHashCode注解，会重写类得equals方法和hashCode方法

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Getter
@Setter
@ToString
@EqualsAndHashCode
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

到这里为止，我们可以看一下项目编译过后的.class文件
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
很明显，它生成了get方法，set方法，重写了toString方法，hashCode方法和equals方法.

3.1.4.@Data

这个@Data是我最常用的注解之一，因为具备@Setter，@Getter，@ToString，@EqualsAndHashCode的功能。

这个时候，我们把上面的那四个注解去掉，打上@Data注解

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Data
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

打上注解以后，把.class文件clean一下，重写编译，再看.class文件

在这里插入图片描述
在这里插入图片描述
我们可以发现，生成的编码和上面那四个注解生成的编码是一样的.

3.1.5.@RequiredArgsConstructor

这个注解我比较喜欢用，类打上这个注解后，会生成一个静态方法，该方法会返回一个new的对象，这个方法名是由我们自定义的.

package com.mantou.boot.dto;

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Data
@RequiredArgsConstructor(staticName = "newLombokDemoDTO")
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

在这里插入图片描述

/**
 * Lombok测试接口
 * @author mantou
 */
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {

    /**
     * 获取Lombok实例
     * @return
     */
    @GetMapping(value = "/getLombokInstance")
    public Result getLombokInstance() {

        LombokDemoDTO lombokDemoDTO = LombokDemoDTO.newLombokDemoDTO();
        lombokDemoDTO.setContent("内容");

        String content = lombokDemoDTO.getContent();

        return Result.success(lombokDemoDTO.toString());
    }
}

这个时候我们再来看一下.class文件，生成了一个静态的方法，返回一个new的对象
在这里插入图片描述

3.1.6.@AllArgsConstructor

在类打上@AllArgsConstructor注解，会生成一个有所有参数的构造方法

/**
 * Lombok测试类
 * @author mantou
 */
@Data
@AllArgsConstructor
@RequiredArgsConstructor(staticName = "newLombokDemoDTO")
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

看下.class文件

在这里插入图片描述

3.1.7.@Accessors

这个注解其实就是使对象支持链式的set方法

package com.mantou.boot.dto;

import lombok.*;
import lombok.experimental.Accessors;

/**
 * Lombok测试类
 * @author mantou
 */
@Data
@AllArgsConstructor
@Accessors(chain = true)
@RequiredArgsConstructor(staticName = "newLombokDemoDTO")
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

使用

/**
 * Lombok测试接口
 * @author mantou
 */
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {

    /**
     * 获取Lombok实例
     * @return
     */
    @GetMapping(value = "/getLombokInstance")
    public Result getLombokInstance() {

        LombokDemoDTO lombokDemoDTO = LombokDemoDTO.newLombokDemoDTO()
                .setContent("内容").setTitle("标题");

        String content = lombokDemoDTO.getContent();

        return Result.success(lombokDemoDTO.toString());
    }
}

我们看一下.class文件，其实就是在set方法加了一个返回值

在这里插入图片描述

3.1.8.@Slf4j

这个是一个提供日志对象(log)的注解，我项目中日志使用的是slf4j + logback，我这里就使用@Slf4j注解，如果日志使用的是log4j，那就使用@Log4j注解;

/**
 * Lombok测试接口
 * @author mantou
 */
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {

    /**
     * 获取Lombok实例
     * @return
     */
    @GetMapping(value = "/getLombokInstance")
    public Result getLombokInstance() {

        LombokDemoDTO lombokDemoDTO = LombokDemoDTO.newLombokDemoDTO()
                .setContent("内容").setTitle("标题");

        String content = lombokDemoDTO.getContent();

        log.info("content : {}", content);

        return Result.success(lombokDemoDTO.toString());
    }

再看一下.class文件，生成了一个日志对象
在这里插入图片描述

我在实际的开发当中，最常用的Lombok注解就这些了.

Springboot：lombok
zhengzaifeidelushang的博客
07-20 186
Springboot：lombok 一、pom.xml引入lombak依赖 <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> 二、lombok用法 import org.springframew
springboot3.x入门系列【1】集成knife4j
qq_20467517的博客
08-10 1117
在Spring Boot 3.x中集成Knife4j（以前称为Swagger UI增强版）来为API文档提供更友好的界面和管理功能。
Spring Boot 之 Lombok 使用详解
web18285997089的博客
12-31 1480
*@Data:**这是一个组合注解，相当于@Getter,@Setter,@ToString,@EqualsAndHashCode,@RequiredArgsConstructor的组合。它会生成所有字段的 getter 和 setter 方法，toString()、equals() 和 hashCode() 方法，以及一个包含 final 字段和非空字段的构造函数。**@Slf4j:**生成一个名为 log 的日志对象，可以直接使用 log.info() 等方法输出日志。可以指定参与比较的字段。
Spring boot Lombok
xiao/du的博客
05-06 802
文章目录Spring boot Lombok上一节 Spring boot 参数校验源码简介idea 安装eclipse 安装常用注解简单示例@UtilityClass 和 @Slf4j 修饰工具类@Accessors@NonNull@Cleanup @SneakyThrows@val @vargetter,setter 使用问题下一节 Spring boot jdbcTemplate Spring boot Lombok 上一节 Spring boot 参数校验 Spring boot 参数校验 源码
注解的使用（一）：APT，编译时注解处理器
bugyinyin的博客
12-04 567
关于编译时注解（APT）由浅入深有三部分，分别是： 自定义注解处理器 ： 例如 ButterKnife、Room 根据注解生成新的类； 利用 JcTree 在编译时修改代码：像 Lombok 自动往类中新增 getter/setter 方法、往方法中插入代码行等； 自定义 Gradle 插件在编译时修改代码 ：例如一些代码插桩框架，以及我司一些应用使用了这种方式。 这篇文章以Demo的形式，介绍如何从零开始创建一个自定义的注解处理器，并生成一个新的类。这个类中有一个静态方法，方法返回添加了自定义注解的所
Springboot使用Lombok库
小hui的博客
06-21 2541
java怎么整合lombok库,各个注解的作用及使用方法
若依4.7.8（springboot2.5.15）升级到4.8.1（springboot3.3.5）并集成Dubbo3客户端
搬砖工
08-24 1304
本文讲解若依4.7.8（springboot2.5.15）升级到4.8.1（springboot3.3.5）并集成Dubbo3客户端，同时使用nacos做服务发现的实现过程。深入浅出。
基于 SpringBoot2.x + MyBatisPlus + MySQL + Shiro+ Layui构建的高效文件管理系统
06-15
本资源基于 SpringBoot2.x + MyBatisPlus + MySQL + Shiro+ Layui 等搭配七牛云，阿里云OSS实现的云存储管理系统。包含文件上传、删除、预览、云资源列表查询、下载、文件移动、重命名、目录管理、登录、注册、以及...
Springboot 集成 lombok.jar过程解析
08-25
Springboot 集成 lombok.jar 过程解析 Spring Boot 是一个高效的开发框架，而 Lombok 则是一套代码模板解决方案，它可以极大地提升开发的效率。Lombok 的主要目的是解决在实体 Bean 中大量的 Getter/Setter 方法，...
springboot设计.docx
11-18
前端技术栈插件版本用途uview-ui^2.0.31多平台快速开发的UI框架uni-simple-router^2.0.7专为uniapp打造的路由器moment^2.29.4js工具库mescroll-uni^1.3.7上拉加载下拉刷新插件@uni-ui/code-ui^1.4.8二维码生成工具2....
springboot中使用lombok
stein的博客
01-11 3465
lombok的使用
SpringBoot系列-- SpringBoot中使用lombok简化开发
Gang-bb的博客
01-29 2953
目录1. 项目环境2.添加依赖和安装插件3. 实体类常用注解总结3.1 @Setter、@Getter3.1.1 注解在属性上3.1.2 注解在类上3.1.3 注解对静态属性和final类型属性3.2 @NoArgsConstructor3.3 @AllArgsConstructor3.4 @RequiredArgsConstructor3.5 @ToString3.6 @EqualsAndHashCode3.7 @Data(常用)3.8 @Builder3.9 @Value3.10 @NonNull4.
SpringBoot使用LomBok
weixin_34417814的博客
05-07 214
Lombok是什么？它是一个能帮我们消除那些必须要写但是重复的代码，比如setter，getter，构造函数之类的方法。 首先先简单说一下idea安装lombok，有2种方法： 1.直接从http://plugins.jetbrains.com/下载，然后放到idea安装文件下面的plugins，然后重启idea 2.在idea的settings（win...
六，Spring Boot 容器中 Lombok 插件的详细使用，简化配置，提高开发效率
weixin_61635597的博客
09-02 1946
简化 Java Bean开发，可以使用 Lombok 的注解让代码更加简洁。Java项目中，很多没有技术含量但又必须存在的代码；比如：Pojo 的 getter/setter/toString；异常处理：I/O流的关闭操作等等。Java项目中，很多没有技术含量但又必须存在的代码：比如：这些代码既没有技术含量，又影响着代码的美观，Lombok 应运而生。Spring Boot 和 IDEA 官方支持IDEA 2020已经内置了 Lombok插件。
SpringBoot Lombok的使用
weixin_45566730的博客
02-17 202
1、Lombok 使用步骤 首先是在pom.xml文件中进行如下配置<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> 在idea中下载lombok插件，下载步骤如下 • 点击file—>settings 点击plugins---->Marketplace
SpringBoot——Lombok的使用
zh_tnis的博客
05-19 403
1.pom.xml <!--web项目--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--这个包引入能
Spring Boot中Lombok的使用
someday____的博客
08-11 1693
Lombok是一个Java库，能以简单的注解形式来简化java代码，提高开发人员的开发效率。我们通常要使用这对象时必须要写一些getter和setter等方法，这些方法很冗长而且没有技术含量，而Lombok通过一些注解，就可以很好的消除这些代码。...
Spring Boot的Lombok详解
rm -rf/坏习惯
08-21 1809
Lombok是一个Java库，旨在通过自动生成样板代码来减少开发人员需要编写的冗余代码，从而提高代码的可读性和简洁性。它通过注解的方式，让开发人员能够在编写代码时自动产生一些常见的方法和字段，如getter、setter、构造函数、equalshashCode等，从而简化了Java类的创建和维护。Lombok使得你可以在代码中专注于核心逻辑，而不必担心冗长的样板代码。Lombok大大简化了Java开发过程中的样板代码编写，使开发人员能够专注于核心逻辑，提高代码的可维护性和可读性。
在springboot中无法使用lombok依赖项
最新发布
10-31
在 Spring Boot 中无法使用 Lombok 依赖项，可尝试以下解决办法： ### 1. 确保 Lombok 插件已安装 在 IDE（如 IntelliJ IDEA）中，需安装 Lombok 插件。具体步骤为：点击“file”>>“setting”，打开 settings 页面；点击“plugins”，在搜索框中输入 “lombok”，出现“lombok”插件后点击“install”进行安装；安装完成后，在原来“install”按钮的地方会出现“restart”按钮，点击该按钮重启 IDE [^2]。 ### 2. 检查项目依赖配置 在项目的 `pom.xml` 文件中，要正确引入 Lombok 依赖。示例如下： ```xml <!--lombok依赖--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.6</version> </dependency> ``` 确保依赖的版本号等信息无误，同时可以尝试刷新 Maven 依赖，让项目重新加载依赖项 [^2]。 ### 3. 配置注解处理器路径 若使用的是 Maven 项目，可以配置 Java 编译参数和 Lombok 的注解处理器路径。示例如下： ```xml <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.1</version> <configuration> <source>1.8</source> <target>1.8</target> <annotationProcessorPaths> <path> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.6</version> </path> </annotationProcessorPaths> </configuration> </plugin> </plugins> </build> ``` 这样可以确保 Lombok 在编译时正确处理注解（如 `@Data`、`@Getter`） [^3]。 ### 4. 检查 IDE 设置 在 IDE 中，要开启注解处理功能。以 IntelliJ IDEA 为例，可在“Settings” -> “Build, Execution, Deployment” -> “Compiler” -> “Annotation Processors” 中，勾选 “Enable annotation processing”。 ### 5. 检查 JDK 版本兼容性 确保使用的 JDK 版本与 Lombok 兼容，避免因为版本不兼容导致无法使用 Lombok 依赖项。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值