SpringBoot整合Lombok插件与使用说明

1、Lombok 插件的简介

‌Lombok‌ 是一款 Java 开发插件，旨在通过定义的一些注解来消除业务工程中冗长和繁琐的代码，尤其是对于简单的 Java 模型对象(POJO)。使用 Lombok 插件后，Java 开发人员可以节省出重复构建诸如 hashCode 和 equals 这样的方法以及各种业务对象模型的 accessor 和 ToString 等方法的大量时间。这些方法在编译源代码期间自动生成，并没有如反射那样降低程序的性能。

2、安装 Lombok

（1）添加 Maven 依赖

打开 pom.xml 文件，添加 Maven 依赖：

<!-- Lombok 依赖 -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.34</version>
    <scope>provided</scope>
</dependency>

2）安装 IDEA 插件

打开 IDEA，单击 IDEA 菜单栏“File → settings” 选项，在弹出的对话框中选择“Plugins”（插件）选项，在弹出的插件窗口的搜索栏中输入：Lombok，在搜索结果中找到 Lombok，单击“install”按钮完成安装。在安装完成后，在使用 Lombok 前需要重启 IDEA。

3、Lombok 的使用
安装完成后，开发人员可以通过简单的注解形式来帮助简化消除一些必须有但显得很臃肿的 Java 代码，如属性的构造器、getter、setter、equals、hashcode、toString方法等，从而提高开发效率，使开发者能够专注于业务逻辑的实现‌。

【实例】创建实体类，使用 Lombok 提供的注解，简化代码。

（1）创建 UserInfo.java 用户信息实体类

package com.pjb.pm.entity;
 
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
 
/**
 * 用户信息实体类
 * @author pan_junbiao
 **/
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserInfo
{
    private Long userId;
    private String userName;
    private String departmentCode;
    private String blogName;
    private String blogUrl;
}

（2）初始化用户信息对象类，并打印对象属性

public static void main(String[] args)
{
    //创建用户对象，由于使用 @Builder 注解，所有可以使用链式风格创建对象。
    UserInfo userInfo = UserInfo.builder()
            .userId(1L)
            .userName("pan_junbiao的博客")
            .blogName("您好，欢迎访问 pan_junbiao的博客")
            .blogUrl("https://blog.csdn.net/pan_junbiao")
            .build();
 
    //打印用户对象，由于使用了 @Data 注解，所有自动生成 toString 方法
    System.out.println(userInfo);
}

控制台输出结果：

UserInfo(userId=1, userName=pan_junbiao的博客, blogName=您好，欢迎访问 pan_junbiao的博客, blogUrl=https://blog.csdn.net/pan_junbiao)

4、Lombok 注解说明

注解	说明
@Data	自动生成 Getter/Setter、toString、equals、hashCode 方法，
以及不带参数的构造方法。
@Getter、@Setter	自动生成 Getter/Setter 方法
@ToString	自动生成 toString 方法。
@NoArgsConstructor	自动生成无参构造方法。
@RequiredArgsConstructor	自动生成包含 final 和 @NonNull 修饰的属性的构造方法。
@AllArgsConstructor	自动生成全参的构造方法。
@NonNull	辅助处理 NullPointerException 异常。当用于方法参数前，
表示调用该方法时参数不能为 null；当用于属性上方，表示为该属性赋值时值不能为 null。
@EqualsAndHashCode	自动生成 equals 和 hashCode、canEqual 方法。
用于比较两个类对象是否相同。
@Builder	提供链式风格创建对象。
@CleanUp	自动管理资源，不用再在 finally 中添加资源的 close 方法，例如：关闭 IO 流对象。
@Value	用于注解 final 类。
@SneakyThrows	对方法中异常进行捕捉并抛出。
@Log	支持使用各种日志（Logger）对象。
在类中生成日志对象，在方法中可以直接使用。针对不同的日志实现产品，
有不同的日志注解，使用 @Log 表示使用 Java 自带的日志功能，
除了 @Log ，还可以使用@Log4j 、 @Log4j2 、 @Slf4j 等注解，来使用不同的日志产品。