javadoc 参考通用 toString - Java

在 Java 中，对象的 toString() 方法用于返回对象的字符串表示形式。这种字符串表示形式可以用于日志记录、调试以及显示给最终用户。在本文章中，我们将介绍 javadoc 中提供的通用 toString() 方法。

通用 toString() 方法

Java 中的通用 toString() 方法是在类中覆盖 Object 类中的 toString() 方法来实现的。Object 类中的 toString() 方法返回一个字符串，该字符串包含对象的类名和对象的散列码。因此，通过重写该方法，我们可以返回我们想要的字符串格式。在 javadoc 中，通用 toString() 方法提供了一种便捷的方法来为你的类生成 toString() 方法。该方法会按照指定的格式生成一个字符串，该字符串表示类的属性和其对应的值。

以下是使用 javadoc 通用 toString() 方法的示例代码：

/**
 * Represents a user in the system.
 */
public class User {
    private String name;
    private String email;

    /**
     * Initializes a new instance of the User class.
     * @param name The name of the user.
     * @param email The email address of the user.
     */
    public User(String name, String email) {
        this.name = name;
        this.email = email;
    }

    /**
     * Returns a string representation of the object.
     * @return A string representation of the object.
     */
    @Override
    public String toString() {
        return new ToStringBuilder(this)
                .append("name", name)
                .append("email", email)
                .toString();
    }
}

使用通用 toString() 方法

在上述示例代码中，我们使用了 org.apache.commons.lang3.builder.ToStringBuilder 类。这是 Apache Commons Lang 库的一部分，该库提供了各种 String、Array 和 Object 上的实用工具方法。这个类的主要作用是生成包含一个或多个字段及其值的字符串。在上面的示例中，我们使用了 append() 方法向 ToStringBuilder 对象中添加属性及其对应的值，并最终使用 toString() 方法生成最终字符串。

您可以根据需要自定义 ToStringBuilder。例如，您可能希望在 toString() 中包含对象的父级的 toString()。

@Override
    public String toString() {
        return new ToStringBuilder(this)
                .appendSuper(super.toString())
                .append("name", name)
                .append("email", email)
                .toString();
    }

总结

通用 toString() 方法使类在打印和输出时更易于阅读，并提供了一种快速生成字符串的方法。它还可以帮助您减少编写模版代码的时间。此外，通过使用通用 toString() 方法，您还可以更轻松地在日志文件和调试输出中查看和分析对象的属性。