Lombok介绍

原创已于 2025-01-09 11:57:48 修改 · 2.2k 阅读 ·

本内容遵循CC 4.0 BY-SA版权协议

GEO检测

树檀

关注

标签

#java #spring boot #maven

分类后端开发

于 2025-01-09 11:48:40 首次发布

Java 专栏收录该内容

1 篇文章

订阅专栏

Lombok

1. Lombok简介

Lombok是一种Java库，它通过注解（annotations）的方式自动插入代码到你的编辑器和构建工具中。这样可以减少样板代码（boilerplate code），比如getter、setter、构造函数等。Lombok由Reinier Zwitserloot 和 Roel Spilker于2009年创立，旨在简化Java开发中的繁琐操作。

2. 为什么要使用Lombok

减少重复代码：Lombok能自动生成像getter、setter、equals、hashCode、toString等方法，从而减少大量的样板代码。
提高可读性：通过移除冗余代码，使源代码更加简洁易读，专注于业务逻辑而非模板代码。
降低维护成本：由于减少了手动编写的代码量，也就降低了因人为错误导致的bug几率，并且在属性变更时不需要同步修改对应的getter/setter等方法。

3. 如何使用Lombok

首先需要在项目中引入Lombok依赖。对于Maven项目，在pom.xml中添加：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>最新版本号</version> <!-- 确保替换为最新版 -->
    <scope>provided</scope>
</dependency>

接下来，你可以在类或字段上使用Lombok提供的注解。常用注解如下

@Getter 和 @Setter

为类的所有非静态字段自动生成 getter 和 setter 方法。

@ToString

自动生成 toString() 方法，默认包含所有字段，可以通过 exclude 属性排除某些字段。

@EqualsAndHashCode

自动生成 equals(Object other) 和 hashCode() 方法，默认基于所有字段生成，可以使用 exclude 排除不需要的字段。

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor

@NoArgsConstructor 自动生成无参构造函数。
@RequiredArgsConstructor 根据需要初始化的字段（final 或标记有特定注解）自动生成构造函数。
@AllArgsConstructor 为每个字段生成一个构造函数。

@Data

这是一个快捷方式，它包含了 @ToString, @EqualsAndHashCode, @Getter / @Setter 和 @RequiredArgsConstructor 的功能，非常适合于 VO、 DTO 等。

@Builder

提供了一种构建复杂对象的方式，支持流畅的 API 来创建对象实例。

@Slf4j 和 @Log

自动生成日志记录器字段，分别对应 SLF4J 和 Java Util Logging。还有其他变体如 @Log4j, @CommonsLog 等。

@Cleanup

自动管理资源，在方法退出时自动调用本地变量的 close() 方法，适用于实现了 AutoCloseable 接口的对象。

@SneakyThrows

允许你抛出通常必须声明为已检查异常的异常，而无需在方法签名中显式声明或捕获它们。

@Synchronized

用于替代 Java 中的 synchronized 关键字，提供更细粒度的锁控制。

@Value

类似于 @Data，但是针对不可变类，即所有字段都是私有的、只读的，并且类本身是 final 的。

@NonNul

可用于字段、方法参数或方法内部局部变量上，自动在相应位置插入空值检查并抛出 NullPointerException。

@Accessors

控制 getter 和 setter 方法的生成方式。例如，可以通过 chain = true 来使 setter 返回当前对象实例，从而支持方法链式调用。

4. 使用Lombok的注意事项

IDE支持：确保你的IDE安装了Lombok插件以正确解析Lombok注解，否则可能会遇到编译问题或无法识别新生成的方法。
反射问题：因为Lombok是在编译期生成方法，有时候可能会遇到一些与反射相关的不兼容问题。
团队协作：如果你在一个团队中工作，确保所有成员都知道并理解Lombok的使用，因为它可能会影响代码的可读性和维护性。
慎用@Data：虽然@Data很方便，但它会自动生成所有字段的getter、setter、toString()、equals()和hashCode()，这可能导致性能问题或不必要的方法暴露，特别是在大型项目中。

总的来说，Lombok是一个非常强大的工具，能够极大地提升Java开发效率，但在使用时也需要考虑上述提到的一些注意事项。