Lombok @ToString 注解：快速打印对象

更新时间 2023-08-02 16:48:37

本小节中，我们将学习如何使用 @ToString 注解，一键实现对象的打印。

1. 什么是 `@ToString`？

@ToString 是 Lombok 提供的一个注解，通过它我们可以自动地为 Java 类生成一个 toString 方法。这样你就不需要手动去重写这个方法了。toString 方法在日常开发中是十分常用的，它可以帮助我们快速查看对象的状态。但是，手动编写却很容易出错，还很繁琐。有了 @ToString，这些都不再是问题了。

2. 如何使用 `@ToString`？

使用 @ToString 就像使用其他 Lombok 注解一样简单。你只需要类上添加这个注解，Lombok 就会自动为你生成 toString 方法。示例代码如下：

import lombok.ToString;

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

这样，当你创建了一个 Student 对象并调用其 toString 方法时，会得到类似这样的输出：Student(name=小明, age=18)。简单明了，有木有？

3. 自定义 `@ToString`

Lombok 为 @ToString 提供了一些选项，让你可以进一步自定义生成的 toString 方法。让我们来看看这些选项：

includeFieldNames：是否在输出中包含字段名，默认为 true。
exclude：排除某些字段，不在 toString 的输出中显示。
callSuper：是否调用超类的 toString 方法，默认为 false。
of：明确要在 toString 的输出中显示的字段。

下面这个例子，使用了这些选项：

import lombok.ToString;

@ToString(includeFieldNames = false, callSuper = true, exclude = "age")
public class Student extends Person {
    private String name;
    private int age;
}

这样，Student 对象的 toString 方法会调用超类 Person 的 toString 方法，并且只会输出 name 字段，不会输出 age 字段。

4. 结语

看看，是不是感觉 Lombok 的 @ToString 注解让打印对象变得更容易了呢？它可以帮我们自动化生成那些常规但又易错的代码，让我们可以将更多的精力投入到业务逻辑的实现上。

1. 什么是 @ToString？

2. 如何使用 @ToString？

3. 自定义 @ToString

4. 结语

1. 什么是 `@ToString`？

2. 如何使用 `@ToString`？

3. 自定义 `@ToString`