Lombok 实战教程 - @ToString | 自动生成类的 ToString 方法

Lombok 提供的 @ToString 注解可以帮助我们自动生成类的 toString 方法，从而减少样板代码，使代码更加简洁和可读。@ToString 注解不仅可以生成包含类中所有字段的 toString 方法，还可以根据需要进行自定义。

@ToString 的基本使用

自动生成 toString 方法

示例：

import lombok.ToString;

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

在这个例子中，Lombok 会自动生成一个包含 name、age 和 address 字段的 toString 方法。

等价于：

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

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

排除某些字段

你可以通过设置 exclude 参数来排除某些字段不包含在 toString 方法中。

示例：

import lombok.ToString;

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

在这个例子中，address 字段不会包含在生成的 toString 方法中。

仅包含某些字段

你也可以通过设置 of 参数来仅包含某些字段在 toString 方法中。

示例：

import lombok.ToString;

@ToString(of = {"name", "age"})
public class Person {
    private String name;
    private int age;
    private String address;
}

在这个例子中，生成的 toString 方法只会包含 name 和 age 字段。

包含父类字段

如果希望在 toString 方法中包含父类的字段，可以设置 callSuper 参数。

示例：

import lombok.ToString;

@ToString(callSuper = true)
public class Employee extends Person {
    private String department;
}

在这个例子中，生成的 toString 方法会包含父类 Person 的字段。

等价于：

public class Employee extends Person {
    private String department;

    @Override
    public String toString() {
        return super.toString() + "(department=" + this.department + ")";
    }
}

安装和配置 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 插件，并在设置中启用注解处理。

结合实际案例

假设我们有一个用户管理系统，需要实现用户信息的 toString 方法。

传统 Java 代码：

public class User {
    private String username;
    private String email;
    private String password;

    @Override
    public String toString() {
        return "User(username=" + this.username + ", email=" + this.email + ")";
    }
}

使用 Lombok 的代码：

import lombok.ToString;

@ToString(exclude = "password")
public class User {
    private String username;
    private String email;
    private String password;
}

在这个例子中，使用 Lombok 的 @ToString 注解能够有效减少样板代码，自动生成 toString 方法，同时排除敏感字段 password。

进一步增强

Lombok 的 @ToString 注解还可以结合其他 Lombok 注解使用，以满足更复杂的需求。

结合 @Getter 和 @Setter

示例：

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

@Getter
@Setter
@ToString
public class Product {
    private String name;
    private double price;
    private String category;
}

在这个例子中，Product 类不仅有自动生成的 getter 和 setter 方法，还具有自动生成的 toString 方法。

结合 @EqualsAndHashCode

示例：

import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

@Getter
@Setter
@ToString
@EqualsAndHashCode
public class Customer {
    private String id;
    private String name;
    private String email;
}

在这个例子中，Customer 类不仅有自动生成的 getter 和 setter 方法，还具有自动生成的 toString 和 equals/hashCode 方法。

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