如何用Logger.error打印错误异常的详细堆栈信息

最新推荐文章于 2024-05-20 11:35:16 发布

原创最新推荐文章于 2024-05-20 11:35:16 发布 · 3.5k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#java

管理工具专栏收录该内容

32 篇文章

订阅专栏

本文介绍了Log4j中记录错误日志的最佳实践，包括不同error方法的使用方式和区别，以及如何通过合理的方法调用来获取更详细的错误堆栈信息。

推荐用法

LOGGER.error("xxxx error:{}|", e.getMessage(), e);

LOGGER.error("xxxx error:",  e);

使用说明

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;

public class TestLogError {

  public static final Logger LOGGER = LogManager.getLogger(TestLogError.class);

  public static void main(String[] args) {

    try{
      int[] array={1,2,3,4};
      System.out.println(array[5]);
    }
    catch (Exception e){
      /**
       * LOGGER.error("错误信息："+e)
       * 输出：
       * 错误信息：java.lang.ArrayIndexOutOfBoundsException: 5
       */
      LOGGER.error("错误信息："+e);
      /**
       * LOGGER.error("错误信息：",e)
       * 输出：
       *  错误信息：
       *  java.lang.ArrayIndexOutOfBoundsException: 5
       *  at com.syf.com.learn.TestLogError.main(TestLogError.java:14) [classes/:?]
       */
      LOGGER.error("错误信息：",e);
      /**
       *  LOGGER.error("错误信息：{}",e);
       *  只有一个参数时，占位符被吞掉
       *  输出：
       *  错误信息：{}
       *  java.lang.ArrayIndexOutOfBoundsException: 5
       *  at com.syf.com.learn.TestLogError.main(TestLogError.java:14) [classes/:?]
       */
      LOGGER.error("错误信息：{}",e);
      /**
       * LOGGER.error("错误信息：{}",e,e);
       * 输出
       * 错误信息：java.lang.ArrayIndexOutOfBoundsException: 5
       * java.lang.ArrayIndexOutOfBoundsException: 5
       * at com.syf.com.learn.TestLogError.main(TestLogError.java:14) [classes/:?]
       */
     LOGGER.error("错误信息：{}",e,e);
      /**推荐用法：
       * LOGGER.error("错误信息：{}",e.getMessage(),e);
       * 输出：
       * 错误信息：5
       * java.lang.ArrayIndexOutOfBoundsException: 5
       * at com.syf.com.learn.TestLogError.main(TestLogError.java:14) [classes/:?]
       */
      LOGGER.error("错误信息：{}",e.getMessage(),e);
    }
  }
}

查看源码中的方法描述

根据方法重载特性，当只输入一个参数时，此对象会被当做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.
     * @param p1 parameter to the message.
     */
    void error(String message, Object p0, Object p1);

结论

使用LOGGER.error("xxx："+e);是调用的error(Object message)，这个方法都会将入参当作Object输出，不会打印堆栈信息。

在使用

LOGGER.error("：{}",e.getMessage(),e);

LOGGER.error("findError：",e);

时会调用error(String message, Throwable t)，此方法会完整的打印出错误堆栈信息。

以上就是本文的全部内容，希望对大家的学习有所帮助。