FilesLast commitLast update
1 month ago
README

Lombok


Lombok:通过注解在编译期自动生成 getter/setter/构造器等模板代码,消除 Java 样板代码。

基础功能注解

  1. @Data
    组合注解,等价于同时使用@Getter、@Setter、@ToString、@EqualsAndHashCode和@RequiredArgsConstructor。生成无参构造需配合@NoArgsConstructor,适用于POJO类。

  2. @Getter/@Setter
    为类或属性生成getter/setter方法。可指定访问级别(如AccessLevel.PRIVATE),final属性不生成setter。

  3. @ToString
    生成toString()方法,默认包含所有非静态字段。支持exclude排除字段、callSuper包含父类信息、includeFieldNames控制字段名显示。

  4. @EqualsAndHashCode
    生成equals()和hashCode()方法。通过callSuper=true可包含父类字段,exclude可排除指定字段。

  5. 构造器相关

    • @NoArgsConstructor:无参构造器。
    • @RequiredArgsConstructor:为@NonNull或final字段生成构造器。
    • @AllArgsConstructor:全参数构造器。

高级功能注解

  1. @Builder
    实现建造者模式,支持链式调用(如User.builder().name("test").age(20).build())。可配合@SuperBuilder支持父类字段。

  2. 日志注解
    @Slf4j、@Log、@Log4j等,自动生成日志记录器(如private static final Logger log = ...)。

  3. 资源管理

    • @Cleanup:自动关闭资源(如文件流、数据库连接),确保close()被调用。
    • @SneakyThrows:将检查异常转为运行时异常,无需显式捕获。
  4. 非空校验
    @NonNull用于字段或参数,若值为null则抛出NullPointerException。

  5. 同步控制
    @Synchronized:将方法体包裹在synchronized块中,可指定锁对象。

  6. 不可变类
    @Value:生成不可变类(字段final,无setter,全参构造器),类似@Data但更严格。

  7. 类型推断
    val/var:局部变量类型推断(val为final,var不可变),需配合Java 10+。

特殊场景注解

  1. 懒加载
    @Getter(lazy=true):字段首次访问时初始化,线程安全。

  2. 委托模式
    @Delegate:将方法调用转发到另一个对象(如@Delegate(types=List.class)实现List接口)。

  3. 工具类
    @UtilityClass:生成不可实例化的工具类,自动添加private构造器和static方法。

  4. 字段默认值
    @FieldDefaults(makeFinal=true, level=AccessLevel.PRIVATE):设置字段默认访问级别和final属性。

依赖配置

Maven 依赖:

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

IDE 插件安装(必须,否则 IDE 报红):

  • IntelliJ IDEA:Settings → Plugins → 搜索 "Lombok" → Install → Restart
  • VS Code:安装 "Lombok Annotations Support" 扩展
  • Eclipse:下载 lombok.jar → 双击运行 → 选择 eclipse.exe 路径 → Install

注意事项

  • 依赖配置:需在Maven/Gradle中添加Lombok依赖,并在IDE安装插件(如IntelliJ的Lombok插件)。
  • 代码可读性:过度使用可能降低代码可读性,建议仅用于POJO类或简单工具类。
  • 构造器冲突:Lombok不支持多种构造器重载,需通过注解组合实现。
  • 父类字段:@EqualsAndHashCode和@ToString需通过callSuper=true显式包含父类字段。

Lombok vs Java 14+ Record vs AutoValue

方案 代码量 可变性 适用场景
Lombok @Data 极少 可变(默认) 传统 POJO、DTO、快速原型
Java record 极少 不可变 不可变数据载体、Java 14+ 新项目
Google AutoValue 少 不可变 严格不可变值对象、需 Builder

选型建议:新项目 Java 14+ 优先用 record;遗留项目或需要可变性时继续用 Lombok @Data。

注解速查表

注解 作用 典型场景
@Data getter/setter/toString/equals/hashCode/构造器 POJO / DTO 类
@Builder 建造者模式链式调用 复杂对象构建
@Slf4j 生成 log 日志记录器 所有业务类
@Value 不可变类(final + 全参构造) 值对象
@Cleanup 自动关闭资源 文件流 / DB 连接
@SneakyThrows 检查异常转运行时异常 Lambda 内抛异常
@NonNull 非空校验,null 时 NPE 参数/字段防御

Lombok通过编译期注解处理器(JSR 269)修改抽象语法树(AST)生成代码,不改变运行时行为。官方文档建议结合具体场景选择注解,避免过度简化影响代码维护性。



← 返回 Java 工具