撰于 阅读 22

springboot项目配置Lombok 避免编写那些冗余的 Java 样板式代码

1.介绍

Lombok 是一个超酷的 Java 库，它能让你避免编写那些冗余的 Java 样板式代码，如对象中的 get、set、toString 等方法，解放你的双手，堪称偷懒神器，在企业级项目开发中，是必会的一个库。

1.1 简化 Getter 和 Setter 方法

在传统的 Java 开发中，你经常需要为每个类的属性手动编写 Getter 和 Setter 方法，但是有了 Lombok，你只需要在属性上加上 @Getter 和 @Setter 注解，Lombok 就会为你自动生成这些方法。

1.2 自动生成构造函数

通过 @NoArgsConstructor、@RequiredArgsConstructor 或 @AllArgsConstructor 注解，你可以快速生成无参构造函数、带有必需参数的构造函数或者带有全部参数的构造函数。
不用每个需要注入的对象都添加@Autowrite了

1.3 自动生成 equals 和 hashCode 方法

通过 @EqualsAndHashCode 注解，Lombok 会根据类的字段自动生成 equals() 和 hashCode() 方法，让你的类更易于比较和使用在集合中。

1.4 日志记录更轻松

使用 @Slf4j 注解，你可以直接在类中使用 log 对象，而无需手动创建日志记录器。

1.5 简化异常抛出

通过 @SneakyThrows 注解，你可以在方法中抛出受检异常，而无需显式地在方法上声明或捕获它们，但是用的较少，业务中一般的异常都需要catch去处理

1.6 数据类简化

使用 @Data 注解，Lombok 会为你自动生成所有常用方法，如 Getter、Setter、toString() 等，让你的数据类更加简洁

1.7 链式调用

使用 @Builder 注解，Lombok 可以帮你创建一个更优雅的构建器模式，让你的对象初始化更加流畅。
例子：

ArticleDO articleDO = ArticleDO.builder()
                    .title(publishArticleReqVO.getTitle())
                    .titleImage(publishArticleReqVO.getTitleImage())
                    .description(publishArticleReqVO.getDescription())
                    .build();

2.项目中添加 Lombok 依赖

想要在项目中使用 Lombok, 首先, 你需要在项目中添加 Lombok 依赖。只需要在项目的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.28</version>
    <scope>provided</scope>
</dependency>

3.IDEA 配置 Lombok 插件

TIP: IDEA 2020.3 及以上版本已经内置安装了 Lombok 插件，如果你的 IDEA 版本大于该版本，则不用管，否则需要按下面的步骤，来手动安装 Lombok 插件。

除了添加依赖外，还需要在 IDEA 中安装 Lombok 插件，才能正式的使用 Lombok。

根据你的系统依次点击菜单：

  • Windows 系统：File -> Settings... -> Plugins;
  • Mac 系统：IntelliJ IDEA -> Preferences -> Plugins;
    点击 Marketplace ， 进入插件市场, 输入关键词 lombok, 搜索该插件：

    然后，点击 Install 按钮开始安装，这里已经安装过了，所以显示的打钩。安装完成后，点击 Apply 按钮应用设置即可。
#java#springboot#lombok