Lombok 注解详解：让 Java 代码更简洁高效

在 Java 开发中，我们经常需要编写大量重复的模板代码，如 getter、setter、构造方法等。这些代码不仅繁琐，还会增加维护成本。Lombok 是一款优秀的 Java 工具库，它通过注解的方式，自动为我们生成这些模板代码，让开发者能够专注于核心业务逻辑。本文将详细介绍 Lombok 中常用的注解，帮助大家更好地使用 Lombok 提升开发效率。

一、Lombok 简介
Lombok 是一个可以通过简单注解来简化 Java 代码的工具，它会在编译期间自动为我们生成对应的代码。使用 Lombok 需要在项目中引入相关依赖，以 Maven 项目为例，在 pom.xml 文件中添加以下依赖：

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

引入依赖后，在 IDE 中还需要安装 Lombok 插件，否则可能会出现编译错误或代码提示异常。

二、常用 Lombok 注解
（一）减少模板代码的注解
@Getter 和 @Setter
@Getter 注解用于为类中的字段自动生成 getter 方法，@Setter 注解用于自动生成 setter 方法。这两个注解可以用在类上，也可以用在字段上。
当用在类上时，会为类中所有非静态字段生成对应的 getter 和 setter 方法；当用在字段上时，只为该字段生成对应的方法。
例如：

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class User {
    private String name;
    private int age;
}

编译后，该类会生成 name 和 age 的 getter 和 setter 方法，就像我们手动编写的一样。
2. @ToString
@ToString 注解用于为类自动生成 toString () 方法。默认情况下，toString () 方法会包含类中所有非静态字段的信息，字段之间用逗号分隔。
我们还可以通过一些属性来定制 toString () 方法，例如 exclude 属性用于排除某些字段，of 属性用于指定只包含某些字段。
示例：

import lombok.ToString;

@ToString(exclude = "age")
public class User {
    private String name;
    private int age;
}

编译后生成的 toString () 方法会排除 age 字段，只包含 name 字段的信息。

3. @EqualsAndHashCode
@EqualsAndHashCode 注解用于为类自动生成 equals () 和 hashCode () 方法。默认情况下，这两个方法会基于类中所有非静态字段来计算。
同样，我们可以通过 exclude 和 of 属性来指定参与计算的字段。
例如：

import lombok.EqualsAndHashCode;

@EqualsAndHashCode(of = "name")
public class User {
    private String name;
    private int age;
}

这里指定只根据 name 字段来生成 equals () 和 hashCode () 方法。
（二）日志相关注解
@Slf4j
@Slf4j 注解用于为类自动生成一个日志对象，方便我们在类中进行日志输出。它适用于使用 SLF4J 日志框架的项目。
使用示例：

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class LogDemo {
    public void doSomething() {
        log.info("执行了doSomething方法");
    }
}

编译后，该类会生成一个名为 log 的日志对象，我们可以直接使用它来输出日志。
除了 @Slf4j，Lombok 还提供了其他日志相关的注解，如 @Log、@Log4j、@Log4j2 等，分别对应不同的日志框架，使用方法类似。
（三）构造器相关注解
@NoArgsConstructor
@NoArgsConstructor 注解用于为类自动生成无参构造方法。如果类中存在 final 字段，且该字段没有初始化值，使用 @NoArgsConstructor 注解会导致编译错误，此时需要结合 @NonNull 注解或通过其他方式为 final 字段赋值。
示例：

import lombok.NoArgsConstructor;

@NoArgsConstructor
public class User {
    private String name;
    private int age;
}

编译后，该类会生成一个无参构造方法。
2. @AllArgsConstructor
@AllArgsConstructor 注解用于为类自动生成包含所有字段的构造方法，字段的顺序与它们在类中声明的顺序一致。
例如：

import lombok.AllArgsConstructor;

@AllArgsConstructor
public class User {
    private String name;
    private int age;
}

编译后，会生成一个参数为 name 和 age 的构造方法。
3. @RequiredArgsConstructor
@RequiredArgsConstructor 注解用于为类中标记为 @NonNull 的字段或 final 字段生成构造方法。构造方法的参数顺序与字段在类中声明的顺序一致。
示例：

import lombok.RequiredArgsConstructor;
import lombok.NonNull;

@RequiredArgsConstructor
public class User {
    @NonNull
    private String name;
    private final int age;
}

这里 name 被标记为 @NonNull，age 是 final 字段，所以会生成一个参数为 name 和 age 的构造方法。
（四）综合注解
@Data
@Data 注解是一个组合注解，它包含了 @Getter、@Setter、@ToString、@EqualsAndHashCode 和 @RequiredArgsConstructor 注解的功能。使用 @Data 注解可以在很大程度上简化代码，尤其适用于 POJO 类。
例如：

import lombok.Data;

@Data
public class User {
    private String name;
    private int age;
}

使用 @Data 注解后，该类会自动生成 getter、setter、toString ()、equals ()、hashCode () 以及包含所有 @NonNull 和 final 字段的构造方法（如果有的话）。
（五）其他有用的注解
@NonNull
@NonNull 注解用于标记字段或方法参数，告诉 Lombok 在生成的代码中添加非空检查。如果传入的参数为 null，会抛出 NullPointerException。
例如：

import lombok.NonNull;

public class User {
    private String name;

    public void setName(@NonNull String name) {
        this.name = name;
    }
}

编译后，setName () 方法会生成非空检查的代码：

public void setName(@NonNull String name) {
    if (name == null) {
        throw new NullPointerException("name is marked non-null but is null");
    }
    this.name = name;
}

@Builder
@Builder 注解用于为类生成构建者模式的代码，方便我们创建对象。使用构建者模式可以更灵活地设置对象的字段值，尤其是当类中的字段较多时。
示例：

import lombok.Builder;

@Builder
public class User {
    private String name;
    private int age;
}

使用时，可以通过以下方式创建 User 对象：

User user = User.builder()
        .name("张三")
        .age(20)
        .build();

三、使用 Lombok 的注意事项
虽然 Lombok 可以简化代码，但过度使用可能会导致代码可读性下降，尤其是对于一些复杂的类，开发者可能需要查看生成的代码才能理解其逻辑。
在团队开发中，需要确保团队成员都熟悉 Lombok 的使用，并且 IDE 中都安装了 Lombok 插件，否则可能会出现协作问题。
有些框架在反射时可能会依赖类中的 getter、setter 等方法，如果 Lombok 生成的方法不符合框架的要求，可能会导致错误。此时需要仔细检查并进行相应的配置。
升级 Lombok 版本时，需要注意版本兼容性问题，不同版本的 Lombok 可能会有一些功能差异或 bug 修复。

四、总结
Lombok 通过注解的方式，为 Java 开发带来了极大的便利，减少了大量重复的模板代码，提高了开发效率。本文介绍了 Lombok 中常用的注解，包括减少模板代码的注解、日志相关注解、构造器相关注解、综合注解以及其他有用的注解，并说明了使用 Lombok 的注意事项。