使用Log4j2 log.error() 打印异常日志

参考网页：https://www.cnblogs.com/huanghuanghui/p/11775731.html、https://www.cnblogs.com/jiftle/p/10036590.html

一直使用log4j2进行打印日志，但是遇到异常的时候，还是无法正确使用。

public static void main(String[] args) {
      int a = 10;
    try {
      int i = 1/0;
    }
    catch (Exception e) {
      System.out.println("--------------------");
      e.printStackTrace();// 只能输出在控制台当中，日志文件看不到
      System.out.println("--------------------");
      log.error(e.getMessage());// 只能输出简短的错误信息，不便于排错
      System.out.println("--------------------");
      log.error(e.getStackTrace().toString());// 不能输出错误信息
      System.out.println("--------------------");
      log.error("需要在错误日志 error 之上打锚点，报错了，a-{}",a);
      //用这个去打印日志，完整的日志信息会被打印在日志之中，相当于 e.printStackTrace();
      log.error("test fail-",e);// 可以在日志中输出完整的错误信息，""里要写内容,不能在此处去打错误锚点（不能使用log.error("test fail-{},{}",a,e)）无法打出全部日志
      System.out.println("--------------------");
      log.error("test fail-{},{}",a,e);//无法打出全部日志
      System.out.println("--------------------");
      log.error(e.toString());// 只能输出简短的错误信息，不便于排错
    }
  }

运行的结果是：

log.error(“Exception”,e)

2021-06-29 23:05:41,972 [  -  ///  -  ] ERROR ****类名.***方法名 - Exception
java.lang.ArithmeticException: / by zero
    at com.***包名.***类名.方法名:(******类名.java:30)
    at ... 这后面是具体的堆栈信息
    ......
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke()Method.java:498

log.error(e.getStackTrace().toString())

2021-06-29 23:05:41,972 [  -  ///  -  ] ERROR ****类名.***方法名 -  [Ljava.lang.StackTraceElement;@1978eab7]

log.error(“test fail-{},{}”,a,e);

2021-06-29 23:05:41,972 [  -  ///  -  ] ERROR ****类名.***方法名 -  test fail-10, java.lang.ArithmeticException:  / by zero

log.error(e.toString());

2021-06-29 23:05:41,972 [  -  ///  -  ] ERROR ****类名.***方法名 - java.lang.ArithmeticException:  / by zero

---

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

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

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
/**
 * @Author: LeeChao
 * @Date: 2018/7/25
 * @Describe:
 * @Modified By:
 */
public class TestLogError {
    public static final Logger LOGGER = LogManager.getLogger(TestLogError.class);
 
    public static void main(String[] args) {
        try{
            // 模拟空指针异常
            //Integer nullInt = Integer.valueOf(null);
            int[] array = {1,2,3,4,5};
            int outBoundInt = array[5];
        }catch (Exception e){
            // 直接打印，则只输出异常类型
            LOGGER.error(e);
            // 使用字符串拼接
            LOGGER.error("使用 + 号连接直接输出 e : " + e);
            LOGGER.error("使用 + 号连接直接输出 e.getMessage() : " + e.getMessage());
            LOGGER.error("使用 + 号连接直接输出 e.toString() : " + e.toString());
            // 使用逗号分隔，调用两个参数的error方法
            LOGGER.error("使用 , 号 使第二个参数作为Throwable : ", 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(e)、Logger.error(e.getMessage())、Logger.error(“some msg” + e)、Logger.error(“some msg” + e.getMessage()) 都是调用的error(Object message)，这个方法都会将入参当作Object输出，不会打印堆栈信息。
在使用Logger.error("first param ",e)时会调用error(String message, Throwable t)，此方法会完整的打印出错误堆栈信息。