給出如下異常信息:
java.lang.RuntimeException: level 2 exception
at com.msh.demo.exceptionStack.Test.fun2(Test.java:17)
at com.msh.demo.exceptionStack.Test.main(Test.java:24)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:498)
at com.intellij.rt.execution.application.AppMain.main(AppMain.java:147)
Caused by: java.io.IOException: level 1 exception
at com.msh.demo.exceptionStack.Test.fun1(Test.java:10)
at com.msh.demo.exceptionStack.Test.fun2(Test.java:15)
... 6 more
學(xué)這么多年Java,你真的會(huì)閱讀Java的異常信息嗎?你能說(shuō)清楚異常拋出過(guò)程中的事件順序嗎?
需要內(nèi)化的內(nèi)容
寫一個(gè)demo測(cè)試
上述異常信息在由一個(gè)demo產(chǎn)生:
packagecom.msh.demo.exceptionStack;importjava.io.IOException;/**
* Created by monkeysayhi on 2017/10/1.
*/publicclassTest{privatevoidfun1()throwsIOException{thrownewIOException("level 1 exception");? }privatevoidfun2(){try{? ? ? fun1();? ? }catch(IOException e) {thrownewRuntimeException("level 2 exception", e);? ? }? }publicstaticvoidmain(String[] args){try{newTest().fun2();? ? }catch(Exception e) {? ? ? e.printStackTrace();? ? }? }}
這次我復(fù)制了完整的文件內(nèi)容,使文章中的代碼行號(hào)和實(shí)際行號(hào)一一對(duì)應(yīng)。
根據(jù)上述異常信息,異常拋出過(guò)程中的事件順序是:
在Test.java的第10行,拋出了一個(gè)IOExceotion("level 1 exception") e1
異常e1被逐層向外拋出,直到在Test.java的第15行被捕獲
在Test.java的第17行,根據(jù)捕獲的異常e1,拋出了一個(gè)RuntimeException("level 2 exception", e1) e2
異常e2被逐層向外拋出,直到在Test.java的第24行被捕獲
后續(xù)沒有其他異常信息,經(jīng)過(guò)必要的框架后,由程序自動(dòng)或用戶主動(dòng)調(diào)用了e2.printStackTrace()方法
如何閱讀異常信息
那么,如何閱讀異常信息呢?有幾點(diǎn)你需要認(rèn)識(shí)清楚:
異常棧以FILO的順序打印,位于打印內(nèi)容最下方的異常最早被拋出,逐漸導(dǎo)致上方異常被拋出。位于打印內(nèi)容最上方的異常最晚被拋出,且沒有再被捕獲。從上到下數(shù),第i+1個(gè)異常是第i個(gè)異常被拋出的原因cause,以“Caused by”開頭。
異常棧中每個(gè)異常都由異常名+細(xì)節(jié)信息+路徑組成。異常名從行首開始(或緊隨"Caused by"),緊接著是細(xì)節(jié)信息(為增強(qiáng)可讀性,需要提供恰當(dāng)?shù)募?xì)節(jié)信息),從下一行開始,跳過(guò)一個(gè)制表符,就是路徑中的一個(gè)位置,一行一個(gè)位置。
路徑以FIFO的順序打印,位于打印內(nèi)容最上方的位置最早被該異常經(jīng)過(guò),逐層向外拋出。最早經(jīng)過(guò)的位置即是異常被拋出的位置,逆向debug時(shí)可從此處開始;后續(xù)位置一般是方法調(diào)用的入口,JVM捕獲異常時(shí)可以從方法棧中得到。對(duì)于cause,其可打印的路徑截止到被包裝進(jìn)下一個(gè)異常之前,之后打印“... 6 more”,表示cause作為被包裝異常,在這之后還逐層向外經(jīng)過(guò)了6個(gè)位置,但這些位置與包裝異常的路徑重復(fù),所以在此處省略,而在包裝異常的路徑中打印。“... 6 more”的信息不重要,可以忽略。
現(xiàn)在,回過(guò)頭再去閱讀示例的異常信息,是不是相當(dāng)簡(jiǎn)單?
為了幫助理解,我盡可能通俗易懂的描述了異常信息的結(jié)構(gòu)和組成元素,可能會(huì)引入一些紕漏。閱讀異常信息是Java程序猿的基本技能,希望你能內(nèi)化它,忘掉這些冗長(zhǎng)的描述。
如果還不理解,建議你親自追蹤一次異常的創(chuàng)建和打印過(guò)程,使用示例代碼即可,它很簡(jiǎn)單但足夠。難點(diǎn)在于異常是JVM提供的機(jī)制,你需要了解JVM的實(shí)現(xiàn);且底層調(diào)用了很多native方法,而追蹤native代碼沒有那么方便。
擴(kuò)展
為什么有時(shí)我在日志中只看到異常名"java.lang.NullPointerException",卻沒有異常棧
示例的異常信息中,異常名、細(xì)節(jié)信息、路徑三個(gè)元素都有,但是,由于JVM的優(yōu)化,細(xì)節(jié)信息和路徑可能會(huì)被省略。
這經(jīng)常發(fā)生于服務(wù)器應(yīng)用的日志中,由于相同異常已被打印多次,如果繼續(xù)打印相同異常,JVM會(huì)省略掉細(xì)節(jié)信息和路徑隊(duì)列,向前翻閱即可找到完整的異常信息。
猴哥之前使用Yarn的Timeline Server時(shí)遇到過(guò)該問題。你能體會(huì)那種感覺嗎?臥槽,為什么只有異常名沒有異常棧?沒有異常棧怎么老子怎么知道哪里拋出的異常?線上服務(wù)老子又不能停,全靠日志了啊喂!
如何在異常類中添加成員變量
為了恰當(dāng)?shù)谋磉_(dá)一個(gè)異常,我們有時(shí)候需要自定義異常,并添加一些成員變量,打印異常棧時(shí),自動(dòng)補(bǔ)充打印必要的信息。
追蹤打印異常棧的代碼:
...publicvoidprintStackTrace(){? ? ? ? printStackTrace(System.err);? ? }...publicvoidprintStackTrace(PrintStream s){? ? ? ? printStackTrace(newWrappedPrintStream(s));? ? }...privatevoidprintStackTrace(PrintStreamOrWriter s){// Guard against malicious overrides of Throwable.equals by// using a Set with identity equality semantics.Set dejaVu =? ? ? ? ? ? Collections.newSetFromMap(newIdentityHashMap());? ? ? ? dejaVu.add(this);synchronized(s.lock()) {// Print our stack traces.println(this);? ? ? ? ? ? StackTraceElement[] trace = getOurStackTrace();for(StackTraceElement traceElement : trace)? ? ? ? ? ? ? ? s.println("\tat "+ traceElement);// Print suppressed exceptions, if anyfor(Throwable se : getSuppressed())? ? ? ? ? ? ? ? se.printEnclosedStackTrace(s, trace, SUPPRESSED_CAPTION,"\t", dejaVu);// Print cause, if anyThrowable ourCause = getCause();if(ourCause !=null)? ? ? ? ? ? ? ? ourCause.printEnclosedStackTrace(s, trace, CAUSE_CAPTION,"", dejaVu);? ? ? ? }? ? }...
暫不關(guān)心同步問題,可知,打印異常名和細(xì)節(jié)信息的代碼為:
s.println(this);
JVM在運(yùn)行期通過(guò)動(dòng)態(tài)綁定實(shí)現(xiàn)this引用上的多態(tài)調(diào)用。繼續(xù)追蹤的話,最終會(huì)調(diào)用this實(shí)例的toString()方法。所有異常的最低公共祖先類是Throwable類,它提供了默認(rèn)的toString()實(shí)現(xiàn),大部分常見的異常類都沒有覆寫這個(gè)實(shí)現(xiàn),我們自定義的異常也可以直接繼承這個(gè)實(shí)現(xiàn):
...publicStringtoString(){? ? ? ? String s = getClass().getName();? ? ? ? String message = getLocalizedMessage();return(message !=null) ? (s +": "+ message) : s;? ? }...publicStringgetLocalizedMessage(){returngetMessage();? ? }...publicStringgetMessage(){returndetailMessage;? ? }...
顯然,默認(rèn)實(shí)現(xiàn)的打印格式就是示例的異常信息格式:異常名(全限定名)+細(xì)節(jié)信息。detailMessage由用戶創(chuàng)建異常時(shí)設(shè)置,因此,如果有自定義的成員變量,我們通常在toString()方法中插入這個(gè)變量。參考com.sun.javaws.exceptions包中的BadFieldException,看看它如何插入自定義的成員變量field和value:
publicStringtoString(){returnthis.getValue().equals("https")?"BadFieldException[ "+this.getRealMessage() +"]":"BadFieldException[ "+this.getField() +","+this.getValue() +"]";? }
嚴(yán)格的說(shuō),BadFieldException的toString中并沒有直接插入field成員變量。不過(guò)這不影響我們理解,感興趣的讀者可自行翻閱源碼。
總結(jié)
根據(jù)異常信息debug是程序員的基本技能,這里圍繞異常信息的閱讀和打印過(guò)程作了初步探索,后續(xù)還會(huì)整理一下常用的異常類,結(jié)合程序猿應(yīng)該記住的幾條基本規(guī)則,更好的理解如何用異常幫助我們寫出clean code。??如果你在學(xué)習(xí)Java的過(guò)程中或者在工作中遇到什么問題都可以來(lái)群里提問,阿里Java高級(jí)大牛直播講解知識(shí)點(diǎn),分享知識(shí),多年工作經(jīng)驗(yàn)的梳理和總結(jié),帶著大家全面、科學(xué)地建立自己的技術(shù)體系和技術(shù)認(rèn)知!可以加群找我要課堂鏈接 注意:是免費(fèi)的 沒有開發(fā)經(jīng)驗(yàn)誤入哦! 非喜勿入!?學(xué)習(xí)交流QQ群:478052716