17370845950

toString方法用于让对象以清晰有意义的字符串形式呈现，避免默认的“类名@哈希值”；必须重写以支持打印、字符串拼接和日志记录；应简洁可读、含关键字段、过滤敏感信息、避免副作用与NPE。

toString 方法的作用是让对象能以字符串形式被清晰、有意义地表示出来，避免打印出无用的内存地址。 默认情况下，Object 类的 toString 返回的是“类名@哈希值”，比如 Person@1b6d3586，这对调试和日志毫无帮助。重写 toString 就是为了告诉 Java：“这个对象，应该长这样”。

为什么必须重写 toString？

Java 在打印对象（如 System.out.println(obj)）、拼接字符串（"info: " + obj）、记录日志时，会自动调用 toString。若不重写，你看到的永远是一串无法理解的标识符，排查问题困难，协作效率低。

• 调试时一眼看不出对象状态，得逐个 get 字段
• 单元测试中 assertEquals 验证对象输出失败，因默认值无业务含义
• 日志里记录的是 User@2a139a55，而不是 User{id=101, name='张三', age=28}

怎么写一个合格的 toString？

核心原则是：简洁、可读、包含关键业务字段，不暴露敏感信息或大体积数据（如 byte[]、JSON 字符串体）。

• 用 IDE 自动生成（IntelliJ 快捷键 Alt+Insert → toString；Eclipse 是 Alt+Shift+S → Generate toString）
• 手动编写推荐格式：ClassName{field1=value1, field2=value2}，字段顺序建议与构造参数或数据库字段一致
• 对 null 值做安全处理，例如用 Objects.toString(name, "null") 或三元判断，避免 NPE
• 集合类字段可简写为大小（orders.size=5），而非展开全部内容

常见误区和注意事项

toString 不是格式化工具，也不该有副作用。

• 不要在 toString 里抛异常、修改对象状态、访问数据库或远程服务
• 避免递归调用引发 StackOverflow（比如 A.toString 调 B.toString，B 又反向引用 A）
• 不要返回空字符串或纯空格，这会让日志难以分辨是否真为空对象
• 若对象含敏感字段（密码、token），务必过滤，哪怕只是打码显示为 password='***'

配合 Lombok 让它更省心

如果项目允许使用 Lombok，加个 @ToString 注解就能自动生成。支持排除字段（exclude = {"password", "rawData"}）、调用 getter（callSuper = true）、自定义顺序等。

例如：

@ToString(exclude = "password")
public class User {
    private Long id;
    private String name;
    private String password;
}

生成结果类似：User(id=101, name="张三") —— 安全又干净。