1. 程式人生 > >Logger.error方法之列印錯誤異常的詳細堆疊資訊

Logger.error方法之列印錯誤異常的詳細堆疊資訊

開發十年,就只剩下這套架構體系了! >>>   

一、問題場景

使用Logger.error方法時只能打印出異常型別,無法打印出詳細的堆疊資訊,使得定位問題變得困難和不方便。

二、先放出結論

Logger類下有多個不同的error方法,根據傳入引數的個數及型別的不同,自動選擇不同的過載方法。

當error(Object obj)只傳入一個引數時會將異常物件作為Object使用,並最終當做String打印出來,當使用兩個引數error(String message, Throwable t),且第二個引數為Throwable時,才會將完整的異常堆疊打印出來。

三、程式碼示例

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

29

30

31

32

33

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()。

1

2

3

4

5

6

/**

 * Logs a message object with the {@link Level#ERROR ERROR} level.

 *

 * @param message the message object to log.

 */

void error(Object message);

根據方法過載特性,當第二個引數為Throwable時,會打印出異常資訊,並且包含異常堆疊資訊。

1

2

3

4

5

6

7

8

/**

 * 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時,會根據佔位符進行替換並打印出錯誤日誌。

1

2

3

4

5

6

7

/**

 * 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),此方法會完整的打印出錯誤堆疊資訊。

 

 

 

import lombok.extern.slf4j.Slf4j;
/**
 * @Author: LeeChao
 * @Date: 2018/7/25
 * @Describe:
 * @Modified By:
 */
@Slf4j
public class TestLogError {
 
    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){
            // 直接列印,則只輸出異常型別
            log.error(e.getMessage());
            // 使用字串拼接
            log.error("使用 + 號連線直接輸出 e : " + e);
            log.error("使用 + 號連線直接輸出 e.getMessage() : " + e.getMessage());
            log.error("使用 + 號連線直接輸出 e.toString() : " + e.toString());
            // 使用逗號分隔,呼叫兩個引數的error方法
            log.error("使用 , 號 使第二個引數作為Throwable : ", e);
            // 嘗試使用分隔符,第二個引數為Throwable,會發現分隔符沒有起作用,第二個引數的不同據,呼叫不同的過載方法
            log.error("第二個引數為Throwable,使用分隔符列印 {} : ", e);
            // 嘗試使用分隔符,第二個引數為Object,會發現分隔符起作用了,根據第二個引數的不同型別,呼叫不同的過載方法
            log.error("第二個引數為Object,使用分隔符列印 {} ","123");
            
            log.error(e.getMessage(),e);
        }
    }
}




dominos-pe | 2019-03-19 18:45:43.282 | main | ERROR | c.d.cloud.pe.utils.TestLogError.main(24) | null
dominos-pe | 2019-03-19 18:45:43.288 | main | ERROR | c.d.cloud.pe.utils.TestLogError.main(26) | 使用 + 號連線直接輸出 e : java.lang.NumberFormatException: null
dominos-pe | 2019-03-19 18:45:43.288 | main | ERROR | c.d.cloud.pe.utils.TestLogError.main(27) | 使用 + 號連線直接輸出 e.getMessage() : null
dominos-pe | 2019-03-19 18:45:43.288 | main | ERROR | c.d.cloud.pe.utils.TestLogError.main(28) | 使用 + 號連線直接輸出 e.toString() : java.lang.NumberFormatException: null
dominos-pe | 2019-03-19 18:45:43.292 | main | ERROR | c.d.cloud.pe.utils.TestLogError.main(30) | 使用 , 號 使第二個引數作為Throwable : 
java.lang.NumberFormatException: null
	at java.lang.Integer.parseInt(Unknown Source)
	at java.lang.Integer.valueOf(Unknown Source)
	at com.dominos.cloud.pe.utils.TestLogError.main(TestLogError.java:18)
dominos-pe | 2019-03-19 18:45:43.293 | main | ERROR | c.d.cloud.pe.utils.TestLogError.main(32) | 第二個引數為Throwable,使用分隔符列印 {} : 
java.lang.NumberFormatException: null
	at java.lang.Integer.parseInt(Unknown Source)
	at java.lang.Integer.valueOf(Unknown Source)
	at com.dominos.cloud.pe.utils.TestLogError.main(TestLogError.java:18)
dominos-pe | 2019-03-19 18:45:43.293 | main | ERROR | c.d.cloud.pe.utils.TestLogError.main(34) | 第二個引數為Object,使用分隔符列印 123 
dominos-pe | 2019-03-19 18:45:43.297 | main | ERROR | c.d.cloud.pe.utils.TestLogError.main(36) | null
java.lang.NumberFormatException: null
	at java.lang.Integer.parseInt(Unknown Source)
	at java.lang.Integer.valueOf(Unknown Source)
	at com.dominos.cloud.pe.utils.TestLogError.main(TestLogError.java:18)