Logger.error方法之打印错误异常的详细堆栈信息

场景描述

使用Logger.error方法时只能打印出异常类型，无法打印出详细的堆栈信息，使得定位问题变得困难和不方便。

解决方案

Logger类下有多个不同的error方法，根据传入参数的个数及类型的不同，自动选择不同的重载方法。

当error(Object obj)只传入一个参数时会将异常对象作为Object使用，并最终当做String打印出来，
当使用两个参数error(String message, Throwable t)，且第二个参数为Throwable时，才会将完整的异常堆栈打印出来。

使用

1. 当出现异常时，调用e.printStackTrace();其实相当于什么都没做，同时也不会把异常信息输出到日志文件中
2. 使用log.error(e.getMessage());只能够输出异常信息，但是并不包括异常堆栈，所以无法追踪出错的源点。
3. 使用log.error(e);除了输出异常信息外，还能输出异常类型，但是同样不包括异常堆栈，该方法doc说明为：Logs a message object with the ERROR level.显然并不会记录异常堆栈信息
4. 其实在log4j中只需要这样调用，就可以获得异常及堆栈信息log.error(Object var1, Throwable var2);，该方法doc说明为：Logs a message at the ERROR level including the stack trace of the Throwable t passed as parameter【记录ERROR级别的消息，包括作为参数传递的Throwable的堆栈跟踪】.

// 使用逗号分隔，调用两个参数的error方法，打印错误堆栈
LOGGER.error("使用 , 号 使第二个参数作为Throwable : ", e);
LOGGER.error("", e); //不加提示信息，可以这么写
// 尝试使用分隔符,第二个参数为Throwable,会发现分隔符没有起作用，根据第二个参数的不同类型，调用不同的重载方法，会打印错误堆栈
LOGGER.error("第二个参数为Throwable，使用分隔符打印 {} : ", e);
// 尝试使用分隔符，第二个参数为Object,会发现分隔符起作用了，根据第二个参数的不同类型，调用不同的重载方法
LOGGER.error("第二个参数为Object，使用分隔符打印 {} ",123);

源码分析

根据方法重载特性，当只输入一个参数时，此对象会被当做Object进行打印输出，如果是Exception e的话，这里直接就toString()。

/**
 * Logs a message object with the {@link Level#ERROR ERROR} level.
 *
 * @param message the message object to log.
 */
void error(Object message);

根据方法重载特性，当第二个参数为Throwable时，会打印出异常信息，并且包含异常堆栈信息。

/**
 * Logs a message at the {@link Level#ERROR ERROR} level including the stack trace of the {@link Throwable}
 * <code>t</code> passed as parameter.
 *
 * @param message the message object to log.
 * @param t the exception to log, including its stack trace.
 */
void error(String message, Throwable t);　　

根据方法重载特性，当第二个参数为Object时，会根据占位符进行替换并打印出错误日志。

/**
 * Logs a message with parameters at error level.
 *
 * @param message the message to log; the format depends on the message factory.
 * @param p0 parameter to the message.
 */
void error(String message, Object p0);

参考来源：
Logger.error方法之打印错误异常的详细堆栈信息（重要！）
Log4j打印异常堆栈信息到日志