Lombok 详解：通过注解消除样板代码

一、Lombok 是什么？

Lombok 是一个 Java 库，通过一组注解来简化 Java 开发。它的核心作用是在编译阶段自动生成代码，减少开发人员手动编写 getter、setter、构造方法、toString 等重复性代码。

举例来说，你写了一个 User 类，定义了 id、name、email 三个私有字段，然后加上 @Data 注解。编译之后，这个类实际包含的字节码里会自动生成所有字段的 getter 和 setter、toString()、equals()、hashCode() 以及一个全参构造方法。你在 IDE 里看到的源文件是简洁的，但运行时它是完整的。

java 复制代码

import lombok.Data;

@Data
public class User {
    private Long id;
    private String name;
    private String email;
}

没有 Lombok 时，你需要手动生成这些方法，或者让 IDE 帮你生成，但生成后源文件会变得冗长。

二、Lombok 解决了什么问题？

Java 一直被人诟病"啰嗦"。一个简单的 POJO 类可能要写几十行 getter、setter、构造方法、equals、hashCode、toString。这些代码与业务逻辑无关，属于"机械性重复劳动"。

Lombok 把这些重复劳动从开发阶段转移到了编译阶段。你只需要关注字段定义和业务逻辑，编译时 Lombok 会帮你生成所有需要的基础方法。代码变短了，可读性提高了，维护成本降低了------修改字段名时，不需要同步修改 getter/setter 方法名，因为它们是自动生成的。

三、核心注解详解

@Data

最常用的注解，组合了以下功能：

@Getter / @Setter：所有字段生成 getter 和 setter
@ToString：生成包含所有字段的 toString()
@EqualsAndHashCode：生成 equals() 和 hashCode()
@RequiredArgsConstructor：生成包含 final 字段或 @NonNull 字段的构造方法

一个 @Data 就能覆盖绝大多数 POJO 的需求。需要排除某些字段时，用 @ToString.Exclude 或 @EqualsAndHashCode.Exclude 标记即可。

@Getter / @Setter

单独控制某个字段或整个类的 getter/setter 生成。可以配合 AccessLevel 控制访问权限：

java 复制代码

@Getter @Setter
private String name;

@Getter(AccessLevel.PROTECTED)
private String password;

@NoArgsConstructor / @AllArgsConstructor / @RequiredArgsConstructor

@NoArgsConstructor：生成无参构造方法
@AllArgsConstructor：生成全参构造方法
@RequiredArgsConstructor：生成包含 final 字段或 @NonNull 字段的构造方法

JPA 实体类需要无参构造方法，配合 @AllArgsConstructor 可以同时提供两种构造方法。

java 复制代码

@Entity
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    @Id
    private Long id;
    private String name;
}

@Builder

生成建造者模式代码，适合构建复杂对象，尤其是字段较多的 POJO。

java 复制代码

@Builder
public class User {
    private Long id;
    private String name;
    private String email;
}

// 使用方式
User user = User.builder()
    .id(1L)
    .name("张三")
    .email("zhangsan@example.com")
    .build();

@Builder 生成的 builder() 方法返回一个内部 Builder 类，每个字段对应一个链式方法，最后调用 build() 创建对象。构造复杂对象时，这种方式比多参数构造方法更清晰，也比多个 setter 更安全（不会出现漏设字段的问题）。

@Slf4j

在类上添加 @Slf4j，会自动生成一个名为 log 的 Logger 对象，类型是 org.slf4j.Logger。

java 复制代码

@Slf4j
@Service
public class UserService {
    public void getUser(Long id) {
        log.info("查询用户，id: {}", id);
        // 业务逻辑
    }
}

等价于手动写：

java 复制代码

private static final Logger log = LoggerFactory.getLogger(UserService.class);

Spring Boot 默认使用 Logback，加上 @Slf4j 后直接使用 log.info()、log.error() 输出日志，省掉每个类都声明 Logger 的重复代码。

四、Lombok 在 Spring Boot 项目中的配置

在 Spring Boot 项目中使用 Lombok，需要两步：

第一步：添加依赖

Maven：

xml 复制代码

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

Gradle：

gradle 复制代码

compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'

optional=true 或 compileOnly 表示该依赖只在编译时需要，打包时不会传递到最终 Jar 包中。

第二步：安装 IDEA 插件

IDEA 需要安装 Lombok 插件才能正确识别注解并生成代码。安装后重启 IDEA，才能正常显示 @Data 生成的 getter 方法补全提示。

五、Lombok 的原理

Lombok 不是通过运行时反射，而是通过**注解处理器（Annotation Processor）**在编译阶段修改抽象语法树（AST，Abstract Syntax Tree）来实现代码生成。

流程如下：

Java 编译器解析 .java 源文件，生成 AST。
Lombok 的注解处理器被触发，扫描 AST 中的 Lombok 注解。
根据注解的元数据，修改 AST，插入新的方法节点（getter、setter、构造方法等）。
编译器继续处理修改后的 AST，生成对应的字节码 .class 文件。

这个机制叫做 JSR 269 Pluggable Annotation Processing API，是 Java 6 引入的标准 API，允许第三方库在编译时介入编译过程。Lombok 利用这个 API 在源码解析之后、字节码生成之前插入自己的处理逻辑。

这也是为什么 Lombok 需要在 IDE 中安装插件------IDE 的语法高亮和代码补全需要感知 Lombok 生成的代码，否则在写代码时会认为 getter 不存在而报错。

六、Lombok 的优缺点

优点	说明
代码更简洁	POJO 类从几十行缩短到几行
提高开发效率	不需要手动生成 getter、setter 等
减少错误	自动生成，避免手写时遗漏或写错
易于维护	修改字段时，相关方法自动更新

缺点	说明
团队学习成本	新成员需要了解 Lombok 注解的含义
调试不友好	源码里看不到生成的方法，调试时可能需要依赖反编译工具
IDE 依赖插件	没有插件时，代码会报错，影响开发体验
升级风险	不同版本的 Lombok 对 JDK 版本支持不同，升级时可能遇到兼容性问题

七、常见问题

IDE 报错找不到 getter 方法

解决方法：安装 Lombok 插件，并在 Settings -> Build, Execution, Deployment -> Compiler -> Annotation Processors 中启用注解处理。

@Data 在 JPA 实体类中的坑

@Data 生成的 equals() 和 hashCode() 包含所有字段，在懒加载场景下可能触发代理对象的异常。建议 JPA 实体类使用 @Getter @Setter @NoArgsConstructor 组合，避免使用 @Data。

@Builder 和继承

@Builder 默认不处理父类字段。需要同时使用 @SuperBuilder，或手动在构造方法中处理父类字段。

八、使用建议

对于 POJO、DTO、VO 等数据传输对象，可以放心使用 @Data 或 @Getter、@Setter，能显著减少代码量。对于 JPA 实体类，建议用 @Getter、@Setter、@NoArgsConstructor、@AllArgsConstructor 的组合，避免 @Data 带来的 equals 和 hashCode 问题。Service 和 Controller 层推荐使用 @Slf4j，能省掉手动声明 Logger 的重复代码。

Lombok 不是一个新框架，而是一个"编译期代码生成工具"。它不改变运行时行为，只是帮你把那些 IDE 能生成但会占据屏幕空间的代码在编译时自动补全。合理使用 Lombok 能有效提高编码效率，但也要注意它的局限性，尤其是在团队协作和长期维护的场景下。