在java日志记录中，记录异常堆栈的正确做法是调用日志框架提供的重载方法，将异常对象作为最后一个参数传入，而不是手动拼接字符串。这样做能让日志框架自动处理堆栈信息的格式化输出，确保堆栈轨迹完整且可读。如果直接打印异常对象或将其转换为字符串，通常只能得到异常类型和消息，而丢失了关键的调用栈信息，导致排查问题困难。
logger.error() 如何正确传递异常对象
使用SLF4J等主流日志门面时，必须利用其占位符特性并显式传入异常实例。例如，调用 logger.error("操作失败", e) 可以确保堆栈被完整记录。若只写 logger.error(e.getMessage()) 或 logger.error(String.valueOf(e))，则无法获得堆栈跟踪。以下代码展示了正确的用法及预期输出。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LogExample {
private static final Logger logger = LoggerFactory.getLogger(LogExample.class);
public void doWork() {
try {
throw new RuntimeException("Test Exception");
} catch (Exception e) {
// 正确：传入异常对象，日志框架会打印堆栈
logger.error("An error occurred during work", e);
}
}
}
运行上述代码后，日志输出将包含完整的堆栈跟踪信息，包括异常类名、消息以及每一层调用细节。这是排查运行时错误的标准方式。
为什么不能直接用 e.toString() 或 getMessage()
许多开发者误以为 System.out.println(e) 能打印堆栈，因此在日志中也尝试类似操作，但这会导致信息缺失。e.toString() 仅返回 "ClassName: Message"，而 e.getMessage() 仅返回消息部分。这两种方式都忽略了由 printStackTrace() 生成的堆栈数据。为了验证这一点，我们可以对比不同方法的输出差异。
import java.io.PrintWriter;
import java.io.StringWriter;
public class StackTraceDemo {
public static void main(String[] args) {
try {
throw new NullPointerException("Null Value");
} catch (NullPointerException e) {
System.out.println("toString: " + e.toString());
System.out.println("getMessage: " + e.getMessage());
// 模拟日志框架内部行为：获取完整堆栈
StringWriter sw = new StringWriter();
e.printStackTrace(new PrintWriter(sw));
System.out.println("Full Stack: " + sw.toString());
}
}
}
执行该程序，控制台输出显示 toString 和 getMessage 均不包含堆栈行，而 printStackTrace 捕获了完整的调用链。因此，在日志配置中，务必依赖框架的重载方法而非手动转换异常为字符串。
自定义异常时堆栈记录的注意事项
当创建自定义异常类时，必须确保调用父类的构造函数以保留原始堆栈信息。如果忽略父类构造函数的调用，新抛出的异常将失去原始的调用上下文，导致堆栈断裂。这在包装异常（Exception Wrapping）场景中尤为常见。以下代码演示了如何正确继承并保留堆栈。
public class CustomBusinessException extends RuntimeException {
public CustomBusinessException(String message, Throwable cause) {
super(message, cause); // 关键：传递cause以保留堆栈
}
public static void main(String[] args) {
try {
throw new CustomBusinessException("Business Error", new IllegalArgumentException("Root Cause"));
} catch (CustomBusinessException e) {
// 日志框架将打印包含根因的完整堆栈
System.err.println(e);
}
}
}
在此示例中，super(message, cause) 确保了 IllegalArgumentException 的堆栈信息被链接到 CustomBusinessException 中。如果不传递 cause，堆栈将只显示 CustomBusinessException 的抛出点，而丢失根本原因的位置。这种链式结构对于深入分析复杂错误至关重要。
Java免费学习笔记：立即使用
解锁 Java 大师之旅：从入门到精通的终极指南
