应使用日志框架的logger.error(String, Throwable)记录异常,而非System.out.println或e.printStackTrace(),因其能保留完整堆栈、添加时间戳/线程名/级别等上下文,并支持持久化、过滤与路由。

为什么不能直接用 System.out.println 打异常堆栈
它只输出到控制台,进程重启就丢;不带时间戳、线程名、日志级别,排查时分不清是 INFO 还是 ERROR;更关键的是——System.out 不会自动捕获异常的完整堆栈,e.printStackTrace() 看似能打全,但实际可能被重定向或截断,且无法按模块隔离。日志框架(如 Logback、Log4j2)的核心价值不是“多打几行字”,而是让每条日志自带上下文、可路由、可过滤、可持久化。
Logger.error(String, Throwable) 是记录异常的正确姿势
别再把 e.toString() 或 e.getMessage() 拼进字符串里手动打印——这会丢失堆栈。所有主流日志框架都提供带 Throwable 参数的重载方法,底层自动调用 printStackTrace 到内部缓冲区,并格式化为结构化输出。
实操建议:
- 用 SLF4J + Logback 组合最稳妥:
Logger logger = LoggerFactory.getLogger(MyClass.class); - 记录异常必须传两个参数:
logger.error("查询用户失败,user_id={}", userId, e);—— 第三个参数是Throwable,不能省 - 避免写成
logger.error("查询用户失败:" + e);,这会调用e.toString(),堆栈消失 - 如果只有异常没额外消息,直接用
logger.error("操作失败", e);,第一个参数不能为空字符串或null,否则某些版本会 NPE
Logback 配置里必须启用 %ex 或 %xEx 才能显示堆栈
很多人配了日志框架,但文件里还是看不到堆栈,问题出在 pattern 配置。默认的 %msg 只输出日志消息,异常堆栈需显式声明。
典型错误配置:%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n → 堆栈不会出现
正确写法(加 %ex):%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n%ex
注意点:
-
%ex输出完整堆栈(包括 cause 链),%xEx会带上 MDC 上下文信息,调试分布式链路时更实用 - 如果用了
AsyncAppender,确保其includeCallerData设为false(默认),否则高并发下性能暴跌 - 生产环境建议关闭
%class和%method,反射获取调用位置开销大,且日志量激增
捕获异常后不要“吞掉”再 System.out 补一刀
常见反模式:try { ... } catch (IOException e) { e.printStackTrace(); logger.error("IO异常", e); } —— 控制台那行 e.printStackTrace() 是冗余且危险的:它绕过日志框架的异步/限流/滚动策略,可能在磁盘满时阻塞主线程,还污染标准输出,干扰容器日志采集(比如 Kubernetes 的 stdout 收集器只会看到乱序文本)。
应统一为:
- 只保留
logger.error(..., e)一行 - 确保该 logger 的 appender 已正确定义(比如
RollingFileAppender写入app.log,ConsoleAppender仅开发环境开启) - 若需告警,通过日志框架的
SMTPAppender或对接 ELK/Splunk 的 hook,而非手写邮件代码
真正难的从来不是“怎么打日志”,而是让每条 logger.error 调用背后,都有匹配的 appender、合理的 pattern、受控的输出目标——少一个环节,异常就可能静默消失。

















