如何重写Object.toString定义对象在日志中的展示格式

陌芳君_7858

陌芳君_7858

2026-04-13

836人浏览

原创

重写 tostring() 是日志可读性的底线要求,需用 @override 标注、返回非 null 字符串、避免 io/锁/复杂计算,推荐 tostringbuilder 或 lombok @tostring 精确控制字段。

如何重写object.tostring定义对象在日志中的展示格式

Java 中重写 toString() 是最直接有效的日志展示控制方式

默认的 Object.toString() 返回的是 类名@哈希码(如 Person@1b6d3586),对调试和日志毫无信息量。重写它不是“可选优化”,而是日志可读性的底线要求。

实操建议:

  • 用 @Override 显式标注,避免拼写错误(比如写成 toStirng())导致重写失败
  • 返回值必须是非 null 字符串;若字段可能为 null,用 Objects.toString(field) 安全转换
  • 避免在 toString() 中触发复杂计算、IO 或锁 —— 日志线程卡住或死锁常源于此
  • 字段顺序按业务重要性排列,高频关注字段靠前(比如 id、status 优先于 createdAt)

用 ToStringBuilder(Apache Commons Lang)减少模板代码

手写字符串拼接易出错(漏逗号、空格不一致、null 异常),尤其字段多时。用 ToStringBuilder 能统一格式、自动处理 null、支持反射快捷生成。

示例:

public String toString() {
    return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)
        .append("id", id)
        .append("name", name)
        .append("email", email)
        .toString();
}

注意点:

  • SHORT_PREFIX_STYLE 输出形如 Person[id=123,name=Tom,email=tom@example.com],比默认更紧凑
  • 若项目已用 Lombok,@ToString 更轻量,但需确认其 exclude / include 行为是否符合日志脱敏要求(比如不打印密码字段)
  • 不要在 toString() 里调用其他对象的 toString(),除非你 100% 确认对方已安全实现 —— 循环引用会导致栈溢出

日志框架(如 Logback/Log4j2)中开启对象自动序列化需谨慎

有些日志配置允许用 {} 占位符直接传入对象,依赖框架内部调用 toString()。这看似省事,但存在隐性风险:

  • 若对象未重写 toString(),日志里只看到 Person@xxx,排查时才发现问题,代价远高于提前写好方法
  • 某些框架(如旧版 Log4j)对集合、嵌套对象的默认序列化会触发 toString() 链式调用,放大性能开销
  • JSON 日志场景下,toString() 返回的字符串会被当作文本塞进 JSON 字段,而非结构化数据 —— 此时应改用专门的序列化器(如 Jackson 的 @JsonInclude)

Spring Boot + Lombok 场景下的常见陷阱

Lombok 的 @ToString 默认包含所有非静态字段,但容易忽略两点:

  • 继承自父类的字段不会被自动包含,需显式加 callSuper = true
  • 若字段是敏感信息(如 passwordHash),仅靠 exclude = "passwordHash" 不够 —— 若该字段在父类中,Lombok 默认不处理,仍会泄露
  • 启用 @ToString(of = {"id", "name"}) 可精确控制,但每次加字段都要手动维护,不如重写方法直观
  • 测试时别只测单个对象:用 toString() 打印含循环引用的对象(如双向关联的 User ↔ Order),看是否抛 StackOverflowError
实际项目里,toString() 写得再规范,也挡不住有人在日志里直接写 log.info("user: " + user) —— 这种字符串拼接会强制触发 toString(),但一旦出错就难以定位。最稳妥的做法,是把日志语句写成 log.info("user: {}", user),并确保 user.toString() 已经可靠。
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9877

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7022

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6192

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1064

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

888

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1296

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2589

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19911

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1155

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习