Log4j日志使用

待我称王封你为后i 2023-10-04 12:18 16阅读 0赞

## L[ogger.error方法之打印错误异常的详细堆栈信息][ogger.error] ##

## 一、问题场景 ##

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

## 二、先放出结论 ##

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

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

## 三、代码示例 ##

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 </td> 
 <td> <code>import</code>&nbsp;<code>org.apache.logging.log4j.LogManager;</code> <code>import</code>&nbsp;<code>org.apache.logging.log4j.Logger;</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>TestLogError { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>static</code>&nbsp;<code>final</code>&nbsp;<code>Logger LOGGER = LogManager.getLogger(TestLogError.</code><code>class</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>static</code>&nbsp;<code>void</code>&nbsp;<code>main(String[] args) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>try</code><code>{ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 模拟空指针异常</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//Integer nullInt = Integer.valueOf(null);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>int</code><code>[] array = { </code><code>1</code><code>,</code><code>2</code><code>,</code><code>3</code><code>,</code><code>4</code><code>,</code><code>5</code><code>};</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>int</code>&nbsp;<code>outBoundInt = array[</code><code>5</code><code>];</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code><code>catch</code>&nbsp;<code>(Exception e){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 直接打印，则只输出异常类型</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LOGGER.error(e);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 使用字符串拼接</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LOGGER.error(</code><code>"使用 + 号连接直接输出 e : "</code>&nbsp;<code>+ e);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LOGGER.error(</code><code>"使用 + 号连接直接输出 e.getMessage() : "</code>&nbsp;<code>+ e.getMessage());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LOGGER.error(</code><code>"使用 + 号连接直接输出 e.toString() : "</code>&nbsp;<code>+ e.toString());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 使用逗号分隔，调用两个参数的error方法</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LOGGER.error(</code><code>"使用 , 号 使第二个参数作为Throwable : "</code><code>, e);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 尝试使用分隔符,第二个参数为Throwable,会发现分隔符没有起作用，第二个参数的不同据，调用不同的重载方法</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LOGGER.error(</code><code>"第二个参数为Throwable，使用分隔符打印 {} : "</code><code>, e);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 尝试使用分隔符，第二个参数为Object,会发现分隔符起作用了，根据第二个参数的不同类型，调用不同的重载方法</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LOGGER.error(</code><code>"第二个参数为Object，使用分隔符打印 {} "</code><code>,</code><code>123</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

信息输出：

![19f3e996e0f217ad16fd0051313fdcf6.png][]

## 四、查看源码中的方法描述 ##

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>/**</code> <code>&nbsp;</code><code>* Logs a message object with the {@link Level#ERROR ERROR} level.</code> <code>&nbsp;</code><code>*</code> <code>&nbsp;</code><code>* @param message the message object to log.</code> <code>&nbsp;</code><code>*/</code> <code>void</code>&nbsp;<code>error(Object message);</code> </td> 
 </tr> 
 </tbody> 
</table>

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>/**</code> <code>&nbsp;</code><code>* Logs a message at the {@link Level#ERROR ERROR} level including the stack trace of the {@link Throwable}</code> <code>&nbsp;</code><code>* &lt;code&gt;t&lt;/code&gt; passed as parameter.</code> <code>&nbsp;</code><code>*</code> <code>&nbsp;</code><code>* @param message the message object to log.</code> <code>&nbsp;</code><code>* @param t the exception to log, including its stack trace.</code> <code>&nbsp;</code><code>*/</code> <code>void</code>&nbsp;<code>error(String message, Throwable t);　　</code> </td> 
 </tr> 
 </tbody> 
</table>

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>/**</code> <code>&nbsp;</code><code>* Logs a message with parameters at error level.</code> <code>&nbsp;</code><code>*</code> <code>&nbsp;</code><code>* @param message the message to log; the format depends on the message factory.</code> <code>&nbsp;</code><code>* @param p0 parameter to the message.</code> <code>&nbsp;</code><code>*/</code> <code>void</code>&nbsp;<code>error(String message, Object p0);</code> </td> 
 </tr> 
 </tbody> 
</table>

## 五、结论 ##

*  使用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)，此方法会完整的打印出错误堆栈信息。

作者：[翎野君][Link 1]  
出处：[http://www.cnblogs.com/lingyejun/][Link 1]

[ogger.error]: https://www.cnblogs.com/lingyejun/p/9366533.html
[19f3e996e0f217ad16fd0051313fdcf6.png]: https://img-blog.csdnimg.cn/img_convert/19f3e996e0f217ad16fd0051313fdcf6.png
[Link 1]: http://www.cnblogs.com/lingyejun/