Lombok怎么用？Java开发必学的代码自动生成工具详解

Lombok 是 Java 生态里一个非常实用的第三方库，它的核心作用就是通过简单的注解帮你省掉那些重复、冗余的样板代码——比如 setter、getter、logger 等等。说白了，就是让代码写起来更爽，同时也让代码本身更干净。

举个例子，你只要在类上加上一个 @Getter 和 @Setter 注解，就再也不用手动敲那些烦人的 getter 和 setter 方法了。Lombok 会在编译的时候自动帮你生成它们，完全不需要你操心。

为什么一个 @Getter 注解就能让所有变量自动拥有 getter 方法？奥秘在于 Lombok 参与了 Java 编译的环节——它在生成 .class 文件的过程中，偷偷帮你把一堆 getter 方法写进去。所以最终编译出来的 User.class 文件，其实包含了完整的 getter 实现。简单来说，Lombok 本质上是一种语法糖，它只是帮你提升了开发效率，最后生成的 .class 文件依然是完全标准的 Java 字节码。

安装 Lombok

要在项目中使用 Lombok，需要做两件事：在 Maven 中添加 Lombok 依赖，同时在 IDEA 中安装对应的插件。

1. 加入 Maven 依赖

    org.projectlombok
    lombok
    1.18.12

2. 在 IDEA 中安装 Lombok 插件

这里使用的 IDEA 版本是 2019.3.3，不同版本的安装方式可能会略有差异。

先点击左上角 IntelliJ IDEA → Preferences。

然后点击左侧的 Plugins，再切换到上方的 Marketplace 标签页，在搜索框里输入 lombok，找到对应的插件并安装即可。

为什么一定要安装 IDEA 的 Lombok 插件？

实际上，只要在 Maven 中加入了 Lombok 依赖，用 mvn clean package 就能正常构建，在 IDEA 里点击绿色运行按钮也能成功执行。问题的关键在于——如果不安装插件，IDEA 就无法识别 Lombok 自动生成的方法，导致代码里一片红（提示找不到方法），但运行却完全正常。这种“代码报红但能跑”的诡异现象，就是 Lombok 侵入性的一种体现。

比如下面这段代码，IDEA 看不到 setId()、setName() 等 setter 方法，所以会报红。但因为 Maven 依赖里已经包含了 Lombok，所以点击第 13 行的绿色箭头运行，程序却可以正常跑通。

所以，Lombok 是一个侵入性很强的第三方库。只要团队里有一个人开始用 Lombok，那么所有人都必须装上对应的插件，否则一打开项目就会看到满屏的红字，体验极差。

Lombok 用法

Lombok 官方提供了很多注解，但“劲酒虽好，可不能贪杯”。用得越多，团队的学习成本就越高，反而可能适得其反。所以这里只介绍最常用、也最必要的几个注解，其他的进阶用法就不展开了。

1. @Getter / @Setter

自动生成 getter 和 setter 方法。

2. @ToString

自动重写 toString() 方法，会打印出所有变量。

3. @EqualsAndHashCode

自动生成 equals(Object other) 和 hashCode() 方法，默认包含所有非静态、非 transient 的变量。

如果某些变量不想参与比较，可以用 exclude 排除，或者用 of 指定只包含哪些字段。

问：为什么只有一个整体的 @EqualsAndHashCode 注解，而不是分开的 @Equals 和 @HashCode？

答：Java 规定，当两个对象 equals 时，它们的 hashCode 必须相同；反之，hashCode 相同时，对象不一定 equals。所以 equals 和 hashCode 必须一起实现，否则可能违反 Java 的约定。

4. @NoArgsConstructor, @AllArgsConstructor, @RequiredArgsConstructor

这三个注解都是用来生成构造器的，区别在于生成的构造器参数不同。

@NoArgsConstructor：生成一个无参构造器。

@AllArgsConstructor：生成一个包含所有参数的构造器。

这里有一个 Java 的小坑需要注意：当没有定义任何构造器时，Java 编译器会自动生成一个无参构造器。但一旦你手动写了构造器（比如用了 @AllArgsConstructor），编译器就不会再自动补上无参构造器了。然而很多框架（比如 Spring Data JPA）要求每个实体类都必须有一个无参构造器。所以，如果你用了 @AllArgsConstructor，一定要同时加上 @NoArgsConstructor，否则会踩到各种坑。

@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Integer id;
    private String name;
}

@RequiredArgsConstructor：生成一个只包含“特定参数”的构造器。特定参数指的是那些被 final 修饰的变量。

补充一点：如果所有变量都没有用 final 修饰，那么 @RequiredArgsConstructor 会生成一个无参构造器。

5. @Data

这是一个整合包，加上 @Data 注解等价于同时加了以下注解：

• @Getter / @Setter
• @ToString
• @EqualsAndHashCode
• @RequiredArgsConstructor

@Data 是使用频率最高的 Lombok 注解，通常用在值可以被更新的对象上，比如日常的 DTO 或者 JPA 中的 Entity。换句话说，@Data 适合 mutable class。

6. @Value

这也是一个整合包，但它会把所有变量都设为 final。其他部分和 @Data 类似，等价于以下注解：

• @Getter（注意没有 setter）
• @ToString
• @EqualsAndHashCode
• @RequiredArgsConstructor

上面说的 @Data 适合用在 POJO 或 DTO 上，而 @Value 则适合用在值不希望被改变的对象上——创建后只读，不可修改。也就是 @Value 适合 immutable class。

注意：Lombok 的 @Value 注解和 Spring 的 @Value 注解名称相同，导入时别搞混了。

7. @Builder

自动生成流式 set 值的写法，从此再也不用写一堆 setter 了。

注意：虽然 @Builder 让我们可以用流式写法快速设置对象的值，但 setter 本身还是不能省略的。因为 Spring 等框架在很多地方需要通过 getter/setter 来取值或赋值。所以通常的做法是 @Data 和 @Builder 一起用在同一个类上，既方便我们流式编码，也方便框架干活。

@Data
@Builder
public class User {
    private Integer id;
    private String name;
}

8. @Slf4j

自动生成该类的 log 静态常量，想打日志直接打，不用再手动 new 一个 Logger 了。

除了 @Slf4j，Lombok 也提供了其他日志框架的变种注解，比如 @Log、@Log4j 等，它们都是帮你创建一个静态常量 log，只是底层使用的日志库不同而已。

@Log // 对应：private static final java.util.logging.Logger log = ...;
@Log4j // 对应：private static final org.apache.log4j.Logger log = ...;

Spring Boot 默认支持的是 SLF4J + Logback 的日志框架，所以 @Slf4j 可以直接用在 Spring Boot 项目上，无需额外配置。在所有日志注解中，@Slf4j 也是最常用的。

总结

Lombok 是 Java 开发中提升效率的利器，但也要注意合理使用，避免过度依赖导致团队维护成本增加。掌握以上几个核心注解，就能在日常开发中游刃有余了。