Spring Boot Lombok配置

本文介绍了如何在Spring Boot项目中配置并使用Lombok,包括添加依赖、在IDEA安装Lombok插件以及简单示例,帮助减少样板代码。

Spring Boot Lombok配置


依赖添加

dependencies {
    annotationProcessor 'org.projectlombok:lombok:1.18.2'
    compileOnly 'org.projectlombok:lombok:1.18.2'
    testAnnotationProcessor 'org.projectlombok:lombok:1.18.2'
    testCompileOnly 'org.projectlombok:lombok:1.18.2'
}

IDEA下载Lombok插件

   &esnp;需要在插件中心中下载相应的插件,这样就不会提示代码错误

使用

   &esnp;简单的使用的话,Data和Builder注解应该就够了,详细的可以参考官方文档,大致的示例代码如下,代码中会自动生成id,name,和amount的get和set方法。

package com.seckill.spring.entity;

import lombok.Builder;
import lombok.Data;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.validation.constraints.Size;

@Entity
@Data
@Builder
public class Goods {
    public Goods(int id, String name, int amount) {
        this.id = id;
        this.name = name;
        this.amount = amount;
    }

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private int id;

    @Size(min = 1, max = 50)
    private String name;

    private int amount;
}

参考链接

### 配置 Lombok 简化 Java 类编写 为了在 Spring Boot 项目中利用 Lombok 来简化 Java 类的编写,开发者需遵循特定步骤来集成此库。Lombok 能够通过简单的注解自动创建常见的样板代码,比如 `getter` 和 `setter` 方法、构造器以及 `toString()` 函数等。 #### 添加 Maven 或 Gradle 依赖项 要在 Spring Boot 工程里启用 Lombok 功能,首先应在项目的构建文件中引入相应的依赖声明。对于采用 Maven 构建工具的情况,在 `pom.xml` 文件内添加如下所示的内容: ```xml <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.24</version><!-- 版本号应根据实际情况调整 --> <scope>provided</scope> </dependency> ``` 而对于使用 Gradle 的工程,则可以在 `build.gradle` 文件中的 dependencies 块下增加下面这行语句[^4]: ```groovy implementation 'org.projectlombok:lombok' annotationProcessor 'org.projectlombok:lombok' ``` 请注意设置 `<optional>true</optional>` 属性是为了防止当其他模块依赖当前模块时也强制安装 lombok;而 scope 设置为 provided 表明编译期间需要该 jar 包支持,但在运行期并不需要将其打包到最终产物之中。 #### 安装 IDE 插件并重启环境 完成上述操作之后,还需要确保所使用的集成开发环境中已正确安装了 Lombok 插件,并按照提示重新启动编辑器以便加载新功能。这样做的目的是让IDE能够识别由 Lombok 注解生成的方法和字段定义,进而提供更好的编码体验和支持特性,如语法高亮显示、错误检测等功能[^3]。 #### 使用 Lombok 注解优化实体类结构 一旦成功集成了 Lombok 后就可以开始应用其提供的各种实用注解来精简业务逻辑层的数据传输对象 (DTOs) 或者领域模型的设计模式。例如,可以借助 `@Data` 这一综合性较强的元数据标签快速实现包含所有常规属性访问接口在内的完整 POJO 实现方式[^1]: ```java import lombok.Data; @Data public class User { private Long id; private String name; } ``` 以上代码片段展示了怎样仅用几行简洁的文字就完成了原本较为繁琐的任务——不仅涵盖了必要的存取方法定义,还额外包含了无参/全参形式下的构造函数签名以及其他辅助性的成员函数原型说明等内容。 #### 处理与 Spring 组件扫描机制之间的兼容性问题 值得注意的是,在某些特殊场景下可能会遇到由于启用了 Lombok 所带来的潜在风险点之一便是影响到了框架内部组件实例化的流程控制逻辑。具体表现为如果过度依赖于 @AllArgsConstructor 自动生成全部参数构造器的话,那么很可能会干扰到默认情况下基于无参构造器反射调用来初始化 Bean 对象的过程。为了避免此类情况的发生建议优先考虑选用带有显式指定所需注入资源列表选项的替代方案,即 `@RequiredArgsConstructor` 结合 `@NonNull` 或者 `final` 关键字共同作用的方式来进行约束限定[^2]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值