Lombok @ToString 注解及其自定义配置

# 1. 了解 Lombok 库

在现代 Java 开发中，Lombok 库扮演着重要的角色。它是一个通过注解方式来简化 Java 代码的工具，能够帮助开发者减少冗长的样板代码，提高代码的可读性和可维护性。Lombok的使用并不需要额外的学习成本，只需在项目中引入相应的依赖即可。通过使用Lombok，我们可以轻松地添加 Getters、Setters、Constructors 等方法，同时还能避免手动编写繁琐的 toString、equals 和 hashCode 方法，让开发变得更加高效。总的来说，Lombok能够让Java开发更加愉快和高效，是值得每位Java开发者了解和掌握的利器。

# 2. 理解 @ToString 注解

在 Java 开发中，@ToString 注解是 Lombok 提供的一个方便且实用的注解之一。通过 @ToString 注解，我们可以自动为类生成 toString 方法，从而方便地输出对象的字符串表示形式。下面将详细介绍 @ToString 注解的作用以及使用注意事项。

### 2.1 @ToString 注解的作用

#### 2.1.1 默认行为

当在类上使用 @ToString 注解时，Lombok会在编译时自动生成 toString 方法，该方法会按照类的字段顺序生成对象的字符串表示形式，格式为“ClassName(field1=value1, field2=value2, ...)”。这使得输出对象的内容变得更加简洁明了。

#### 2.1.2 如何自定义 toString 方法的行为

除了使用默认行为外，@ToString 注解还支持一些参数，例如 includeFieldNames 和 callSuper，可以通过这些参数来定制生成的 toString 方法。

### 2.2 使用 @ToString 注解的注意事项

#### 2.2.1 避免循环引用问题

在类之间存在相互引用的情况下，使用 @ToString 注解可能会导致无限递归调用 toString 方法，因此需要避免循环引用问题，否则会导致栈溢出异常。

#### 2.2.2 处理敏感信息安全问题

在输出对象内容时，应当注意处理敏感信息，避免将敏感信息直接暴露在 toString 方法中。可以考虑通过特定方式处理敏感信息，如用"*"代替、只输出部分信息等。

@Data
public class User {
    private Long id;
    private String username;
    @Override
    public String toString() {
        return "User{id=" + id + ", username='" + username.charAt(0) + "***" + "'}";
    }
}

上述代码片段展示了如何在 toString 方法中处理敏感信息，只输出部分用户名信息，保护用户隐私。

#### 2.2.3 在生成 toString 方法时注意字段的顺序，应确保字段的顺序与业务逻辑一致，以便更好地理解生成的字符串表示形式。

@Data
public class Person {
    private String name;
    private int age;
    @Override
    public String toString() {
        return "Person{age=" + age + ", name='" + name + "'}";
    }
}

在上述代码中，通过自定义 toString 方法，调整了字段的输出顺序，使得年龄在姓名之前显示，便于阅读。

综上所述，了解 @ToString 注解的作用以及注意事项对于提高代码的可读性和安全性具有重要意义。正确使用 @ToString 注解可以大大简化代码编写，提高开发效率。

# 3. 探索 @ToString 注解的用法