当前位置：首页 > news >正文

Lombok 的安装与使用

news 文章来源：https://blog.csdn.net/qq_61635026/article/details/132119686 2025/5/18 11:42:42

文章目录

一、什么是 Lombok
- 1.1 Lombok 的概念
- 1.2 为什么使用 Lombok
- 1.3 Lombok 的相关注解
二、Lombok 的安装
- 2.1 引入依赖
- 2.2 安装插件
三、Lombok 的使用案例
四、Lombok 的原理

一、什么是 Lombok

1.1 Lombok 的概念

Lombok（“Project Lombok”）是一款针对 Java 开发的实用工具库。它通过使用注解自动生成 Java 类的通用代码，从而简化了 Java 代码的编写过程。Lombok 的目标是减少样板代码（boilerplate code），提高代码的简洁性和可读性。

1.2 为什么使用 Lombok

在传统的 Java 开发中，常常需要为 Java 类编写大量的 getter 和 setter 方法、equals 和 hashCode方法、toString方法等通用的代码，这些代码在大多数情况下都是重复且无趣的。而使用 Lombok，可以通过简单的注解在Java类上，自动生成这些通用代码，从而避免了重复劳动。

1.3 Lombok 的相关注解

下面是常用的 Lombok 注解：

注解	说明
`@Data`	自动生成 `getter`、`setter`、`equals`、`hashCode` 和 `toString` 方法。
`@Getter`	自动生成 `getter` 方法。
`@Setter`	自动生成 `setter` 方法。
`@ToString`	自动生成 `toString` 方法。
`@EqualsAndHashCode`	自动生成 `equals` 和 `hashCode` 方法。
`@NoArgsConstructor`	自动生成无参构造函数。
`@RequiredArgsConstructor`	自动生成带有 `@NonNull` 注解的成员变量的构造函数。
`@AllArgsConstructor`	自动生成包含所有成员变量的构造函数。
`@Builder`	自动生成建造者模式的构建方法。
`@Slf4j`	自动生成 `log` 日志对象。
`@Value`	类似于 `@Data`，但生成的类是不可变的（immutable）。
`@Cleanup`	自动生成资源（如流）的关闭代码。
`@SneakyThrows`	自动生成异常抛出代码，用于把受检异常转换为非受检异常。
`@NonNull`	为成员变量标记非空约束，自动生成空值检查代码。
`@Getter(AccessLevel.NONE)`	取消生成 `getter` 方法。
`@Setter(AccessLevel.NONE)`	取消生成 `setter` 方法。
`@NoArgsConstructor(access = AccessLevel.PRIVATE)`	生成私有的无参构造函数。

以上是常用的一些 Lombok 注解及其说明，通过使用这些注解，可以简化 Java 类的编写，减少样板代码，提高代码的简洁性和可读性。需要根据实际情况选择合适的注解，以便在项目中获得更好的开发体验。

二、Lombok 的安装

2.1 引入依赖

可以通过 Lombok的官网：https://projectlombok.org/ 获取依赖：

如果是 Maven 项目，选择Install中的Build tools，点击maven 进行复制，然后粘贴到 pom.xml 中的 <dependencies> 里面即可；当然，在创建 Spring Boot 项目时，也可以直接在创建的时候选择 Lombok 依赖。

2.2 安装插件

在 IDEA 中，如果想要在使用时提示相应的注解，还需要安装 Lombok Builder Helper 插件：

三、Lombok 的使用案例

创建了一个使用 Lombok 注解的User类：

@Component
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class User {private Integer id;private String name;private Integer age;
}

通过 TestController类获取 User 对象，并对其执行操作：

@Controller
@ResponseBody
public class TestController {@Autowiredprivate User user;@RequestMapping("/test")public void test(){System.out.println(user);System.out.println("===================");user.setId(123);user.setName("张三");user.setAge(18);System.out.println("===================");System.out.println(user);}
}

执行结果：

四、Lombok 的原理

Lombok 的原理主要依赖于 Java 的注解处理器（Annotation Processor）。在编译 Java 源代码的过程中，注解处理器会读取源代码中的Lombok 注解，并根据注解的定义自动生成相应的 Java 代码，然后将这些生成的代码插入到编译结果中，最终生成编译后的 class 文件。

具体来说，Lombok的原理如下：

注解的识别：在编译 Java 源代码的过程中，注解处理器会扫描源代码中的 Lombok 注解，如@Getter、@Setter、@NoArgsConstructor等。
解析注解：一旦发现 Lombok 注解，注解处理器会解析该注解的定义，并确定生成代码的内容，例如生成 getter 和 setter 方法，构造函数等。
生成代码：根据注解的定义，注解处理器会生成对应的 Java 代码片段，比如生成 getter 方法的代码，setter 方法的代码，构造函数的代码等。
插入生成的代码：注解处理器将生成的代码插入到源代码中相应的位置。
编译：在生成了包含 Lombok 生成的代码的新的 Java 源代码之后，编译器会继续将新的源代码编译成字节码文件（.class文件）。
最终结果：最终生成的class文件包含了Lombok生成的代码，这样在运行时，就能够使用Lombok自动生成的方法和构造函数等功能。

例如，在编译 User 类前的代码如下：

编译后查看 target 目录下 User 对应的 .class 文件：

此时可以发现自动生成了各种 setter 、getter 和构造方法等。并且与 Lombok 相关的注解也消失了。