Lombok 实战教程 - @Data | 整合 @ToString, @EqualsAndHashCode, @Getter,@Setter 和 @RequiredArgsConstructor

Lombok 的 @Data 注解是一个综合性的注解，结合了 @ToString、@EqualsAndHashCode、@Getter、@Setter 和 @RequiredArgsConstructor 注解。使用 @Data 可以一键生成这些注解对应的所有方法，从而使代码更加简洁和易于维护。

@Data 的基本使用

@Data 注解会自动生成以下内容：

• @ToString：生成 toString 方法。
• @EqualsAndHashCode：生成 equals 和 hashCode 方法。
• @Getter：为所有字段生成 getter 方法。
• @Setter：为所有非 final 字段生成 setter 方法。
• @RequiredArgsConstructor：生成一个包含所有 final 字段和带有 @NonNull 注解字段的构造函数。

示例

示例：

import lombok.Data;

@Data
public class Person {
    private final String name;
    private int age;
    private String address;
}

在这个例子中，Lombok 会自动生成 Person 类的以下方法：

• 一个包含 name 的构造函数。
• name、age 和 address 字段的 getter 方法。
• age 和 address 字段的 setter 方法。
• toString 方法。
• equals 和 hashCode 方法。

等价于：

import java.util.Objects;

public class Person {
    private final String name;
    private int age;
    private String address;

    public Person(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "Person(name=" + this.name + ", age=" + this.age + ", address=" + this.address + ")";
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Person person = (Person) o;
        return age == person.age && Objects.equals(name, person.name) && Objects.equals(address, person.address);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, age, address);
    }
}

安装和配置 Lombok

1. 添加 Lombok 依赖：在你的项目中添加 Lombok 依赖（例如使用 Maven 或 Gradle）。

   Maven：

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

   Gradle：

   dependencies {
       compileOnly 'org.projectlombok:lombok:1.18.20'
       annotationProcessor 'org.projectlombok:lombok:1.18.20'
   }
   

2. 在 IDE 中启用 Lombok 支持：

   • IntelliJ IDEA：安装 Lombok 插件，并在设置中启用注解处理。
   • Eclipse：安装 Lombok 插件，并在设置中启用注解处理。

结合实际案例

假设我们有一个用户类，需要各种常见的方法。

使用 @Data 注解

示例：

import lombok.Data;

@Data
public class User {
    private final String username;
    private String email;
    private String password;
}

在这个例子中，Lombok 会自动生成 User 类的以下方法：

• 一个包含 username 的构造函数。
• username、email 和 password 字段的 getter 方法。
• email 和 password 字段的 setter 方法。
• toString 方法。
• equals 和 hashCode 方法。

自定义参数

你可以通过在 @Data 注解中使用其他 Lombok 注解来自定义生成的方法。

示例：

import lombok.Data;
import lombok.ToString;
import lombok.EqualsAndHashCode;

@Data
@ToString(exclude = "password")
@EqualsAndHashCode(of = {"username", "email"})
public class User {
    private final String username;
    private String email;
    private String password;
}

在这个例子中，生成的 toString 方法会排除 password 字段，生成的 equals 和 hashCode 方法只会包含 username 和 email 字段。

通过使用 Lombok 的 @Data 注解，我们可以大大简化 Java 类中的样板代码，使代码更加简洁和易于维护。结合自定义参数，可以满足各种复杂的需求。