前言

Java異常是在Java應(yīng)用中的警報(bào)器，在出現(xiàn)異常的情況下，可以幫助我們程序猿們快速定位問題的類型以及位置。但是一般在我們的項(xiàng)目中，由于經(jīng)驗(yàn)閱歷等多方面的原因，依然有若干的童鞋在代碼中沒有正確的使用異常打印方法，導(dǎo)致在項(xiàng)目的后臺(tái)日志中，沒有收到日志或者日志信息不完整等情況的發(fā)生，這些都給項(xiàng)目埋下了若干隱患。本文將深入分析在異常日志打印過程中的若干情況，并給出若干的使用建議。

1. Java異常Exception的結(jié)構(gòu)分析

我們通常所說的Exception主要是繼承于Throwable而來，可以參見如下的結(jié)構(gòu)圖示：

主要的Throwable分為異常和錯(cuò)誤兩種，然后異常Exception和錯(cuò)誤Error做為基類，分別被具體個(gè)性化以及衍生出NullPointerException、EOFException等等異常信息類。

基于Java中的源代碼來分析，Error和Exception僅僅是繼承了Throwable，做了構(gòu)造函數(shù)的拓展，沒有進(jìn)行額外方法的延展；Exception輸出的主要核心方法都是定義在Throwable中的，感興趣的童鞋可以嘗試閱讀JDK的源代碼。

下面將介紹一下關(guān)鍵的幾個(gè)異常類方法：

1、getMessage(): String

輸出異常的描述信息

2、getLocalizedMessage()

輸出本地化的描述信息，一般此方法可被子類所覆蓋，缺省實(shí)現(xiàn)與getMessage()輸出信息一致

3、printStackTrace()

將異常棧打印到輸出流中，此為一類方法，默認(rèn)打印到console控制臺(tái)，也可以顯式指定輸出流。

4、fillInStackTrace()

將當(dāng)前的異常棧保存到一個(gè)Throwable中，返回這個(gè)Throwable。大部分情況下，用在保留異常棧嵌套調(diào)用的情況，嘗試保留完整的異常棧，無需使用該方法。

2. Error vs Exception

Error在Java體系中定義為不可控制的問題，往往用來描述系統(tǒng)錯(cuò)誤或者底層的問題，比如虛擬機(jī)錯(cuò)誤，例如內(nèi)存空間不足，方法調(diào)用棧溢等。我們以上圖中列舉出的內(nèi)存溢出錯(cuò)誤(StackOverflowError)為例，它是在JVM層面發(fā)生的錯(cuò)誤，已經(jīng)游離于java應(yīng)用層之外；在應(yīng)用程序?qū)用媸菬o法進(jìn)行捕獲，且無法從錯(cuò)誤中恢復(fù)的。一般一旦發(fā)了類似問題，一般都是直接宕機(jī)，應(yīng)用停止正常的工作，需要重新啟動(dòng)或者修復(fù)問題之后，方可重新正常工作。

Exception一般發(fā)生在應(yīng)用層，即在由項(xiàng)目中的Java代碼層面引發(fā)的問題，且可以嘗試進(jìn)行捕獲，此類問題不會(huì)影響到應(yīng)用程序的正常工作的，即不會(huì)導(dǎo)致宕機(jī)現(xiàn)象的發(fā)生。我們在工作或者代碼中常見的都是Exception衍生出來的各類異常。

這里需要強(qiáng)調(diào)說明一下，JVM是Java語言的運(yùn)行環(huán)境和平臺(tái)，但是并不是Java語言體系的一個(gè)部分；在JVM平臺(tái)上，還可以運(yùn)行Groovy， JPython, JRuby, Closure，Scala等等遵守Java語言規(guī)范（JavaLanguage Specification)的編程語言，故我們可以將Error理解為脫離Java應(yīng)用之外的問題。

3. Exception中的運(yùn)行時(shí)異常（RuntimeException)和受控異常(checked exception)

運(yùn)行時(shí)異常（RuntimeException)是指在運(yùn)行之時(shí)發(fā)生的異常，無需顯式地進(jìn)行捕獲；如果程序中發(fā)生類似的異常，JVM會(huì)直接拋出此類異常，并打出響應(yīng)的異常棧信息。此類異常也通常被稱為unchecked exception， 未受控異常。

受控異常（checked Exception)是我們最常見的異常種類，在代碼中使用的異常基本上都是此類異常，此類異常會(huì)在代碼編譯階段由Java編譯器進(jìn)行語法檢查，如果未顯式進(jìn)行異常捕獲，則會(huì)報(bào)出相應(yīng)的編譯異常信息。

4. 如何在代碼中正確打印異常信息

下面我們將通過一系列的例子來說明上述幾個(gè)Exception中方法的使用技巧。

Case 1: getMessage()/getLocalizedMessage()

public void testCase1() {
System.out.println("We are going to do something interesting....");
try {
throw new NullPointerException("I am an exception in the code.");
} catch (Exception e) {
System.out.println("We got unexpected:" + e.getMessage());
System.out.println("We got unexpected:" + e.getLocalizedMessage());
}
}

輸出結(jié)果：

We are going to do testing interesting....
We got unexpected in getMessage==> I am an exception in the code.
We got unexpected in getLocalizedMessage==> I am an exception in the code.

基于結(jié)果來分析， 上述兩個(gè)方法只是將異常對象中的Message打印出來，這些信息對于我們追蹤問題和調(diào)試幫助有限。

Case 2：e.printStackTrace()

public void testCase2() {
System.out.println("We are going to do something interesting....");
try {
throw new Exception("I am an exception in the code.");
} catch (Exception e) {
e.printStackTrace();
}
}

運(yùn)行結(jié)果：

運(yùn)行結(jié)果圖

printStackTrace()可以打印出整個(gè)異常棧，但是異常棧信息將輸出到默認(rèn)的輸出流中，絕大多數(shù)情況下是系統(tǒng)的控制臺(tái)，而在實(shí)際項(xiàng)目中，都是需要將異常棧輸出到日志文件的，如果不顯式指定，則會(huì)丟失異常信息，在日志文件中無從追查。

Case 3: 基于log4j/slf4j等輸出到日志文件

在實(shí)際項(xiàng)目中，一般會(huì)使用log4j/log4j2/JDK logging/slf4j/logback等日志系統(tǒng)來存放日志，那如何來講日志的異常棧存入日志文件呢，我們來看示例。

public void testCase3() {
System.out.println("We are going to do something interesting....");
try {
throw new NullPointerException("abcedfeg");
} catch (Exception e) {
logger.info("Unexpected error in ", e);
}
}

我們需要到日志文件中，找到相應(yīng)的異常信息，異常信息如下：

12:24:45.387 [main] INFO org.demo.TestException - Unexpected error in
java.lang.NullPointerException: abcedfeg
at org.demo.TestException.testCase3(TestException.java:39)
at org.demo.TestException.main(TestException.java:12)

我們可以發(fā)現(xiàn)，整個(gè)異常棧信息由兩個(gè)部分組成：

>> 異常中的message, 類似getMessage()輸出的信息，

>> 使用logger.info之類的方法，將異常信息寫入到日志流中.

以下為log4j的聲明，這里以slf4j為例來示例：

private static final Logger logger = LoggerFactory.getLogger(TestException.class); 

Case 4: fillInStackTrace()

public class FillInExceptionTest {
public static void main(String[] args) {
FillInExceptionTest fit = new FillInExceptionTest();
try {
fit.outerMehtod();
} catch (Exception e) {
System.out.println("\n==========I am the one evil separation line==============");
e.printStackTrace();
}
}
public void innerMethod() throws Exception {
throw new Exception("I got exception in an inner method.");
}
public void outerMehtod() throws Exception {
try {
innerMethod(); //invoke inner method.
} catch (Exception e) {
e.printStackTrace();
throw (Exception)e.fillInStackTrace();
}
}
}

運(yùn)行結(jié)果：

基于上述的運(yùn)行結(jié)果可知，fillInStackTrace()只提取了當(dāng)下的異常棧信息，而非完整的異常棧信息，這個(gè)就是此方法帶給我們的特殊之處。

如果我們需要在最外層將完整的異常棧打印出來，該如何做呢？ 將下述的語句:

throw (Exception)e.fillInStackTrace();

替換為:

throw e;

重新運(yùn)行程序，我們就可以在最外層得到完整的異常棧信息了。

5. 總結(jié)

在本文中，我們介紹了異常類的繼承體系，不同類型的異常區(qū)別與使用場景；并將基于代碼示例展示了如何使用Exception的若干方法，利用這些方法來保留盡可能多的日志信息，方便我們后續(xù)針對日志中的異常信息，追查和解決問題。

好了，以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作能帶來一定的幫助，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。

最新評論