必须重写 toString(),因其默认返回类名@哈希码(如 com.example.User@1b6d3586),无法体现对象实际状态,导致日志无效、调试困难、前端展示无意义;重写需清晰可读、包含关键字段、安全处理 null、避免副作用。

Object.toString() 的默认行为是返回 类名@哈希码的十六进制表示(如 com.example.User@1b6d3586),这个哈希码由 hashCode() 方法生成,默认基于对象内存地址。它对调试和日志有一定帮助,但对业务逻辑无意义,因此绝大多数实体类都需要重写。
为什么必须重写 toString()
默认输出无法体现对象实际状态,不利于排查问题、打印日志或前端展示。比如一个 User 对象只显示 User@2a139a55,完全看不出 id 是多少、姓名是否为空。
- 日志中记录对象时,若未重写,等于白记
- 单元测试断言失败时,错误信息难以理解
- IDE 调试窗口、集合展开视图依赖 toString 展示内容
- JSON 序列化前手动拼接字符串时,常误用 toString() 替代字段访问
重写的规范与最佳实践
核心原则:清晰、可读、稳定、不含敏感信息。
当用户要求为 Java 代码添加注释、修改注释、审查注释、整理注释格式,或要求按照代码注释规范处理 Java 文件时,使用本技能。本技能用于统一生成和维护 Java 类注释模板、按 Git 对比 release 判断版本号、补充每行代码上方中文块注释、调整注释空行规则,并保持 Java 文件 UTF-8 无 BOM 编码。典型触发场景包括:补充类注释、更新 @version、检查 @author 来源、整理行尾注释、把注释放到代码上一行、检查注释是否符合规范、构建前检查 Java 注释风格。
- 包含关键业务字段(如 id、name、status),避免全量字段(尤其不暴露密码、token)
- 格式统一,推荐用
类名{field1=value1, field2=value2}结构,便于人眼快速定位 - 对 null 值做安全处理(如显示
name=null或name=<null></null>),避免 NPE 或空字符串误导 - 不调用可能抛异常或触发副作用的方法(如远程调用、数据库查询)
- 确保线程安全——toString 内部不修改对象状态,也不依赖外部可变资源
常见写法对比与推荐
手写易出错(null 判断遗漏、括号不匹配),建议优先使用工具生成:
立即学习“Java免费学习笔记(深入)”;
- IDE 自动生成:IntelliJ / Eclipse 支持选字段生成标准格式,安全可靠
-
Lombok @ToString:简洁,支持 exclude、include、callSuper 等配置,例如:
@ToString(exclude = "password") -
Apache Commons Lang3:用
ToStringBuilder.reflectionToString(this)可快速实现,但性能略低,适合临时调试 - 避免用
String.format或字符串拼接手动构造——冗长且 null 处理麻烦
特别注意:与 equals/hashCode 的一致性
虽然 toString 不参与 equals 判等,但实践中三者常协同设计:
- 如果两个对象
equals()返回 true,它们的toString()最好也相同(非强制,但利于排查) - 用于
hashCode()计算的字段,通常也应出现在toString()中,保持语义一致 - 若用 Lombok,
@EqualsAndHashCode和@ToString配合使用时,注意exclude字段是否同步

















