Java中的異常提供了一種識別和相應(yīng)錯誤情況的一致性機(jī)制。有效處理異常能使得你的程序更加健壯和易于調(diào)試。異常之所以是一種強(qiáng)大的調(diào)試手段,是因?yàn)樗麄兓卮鹆讼旅嫒齻€問題:
- 什么出了錯?
- 哪里出了錯?
- 為什么出了錯?
當(dāng)有效使用異常的的時候,
異常類型
解決了什么出了錯,異常堆棧
回答了哪里出了錯,異常信息
回答了為什么出錯。如若你發(fā)現(xiàn)你的異常沒有回答這三個問題,很可能你沒有有效使用異常。下面這三條原則將幫助你在調(diào)試的時候更好的使用異常:
- 具體明確
- 及早拋出
- 延遲捕獲
為了闡述有效異常處理的這三個原則,本文通過杜撰個人財務(wù)管理器類JCheckbook進(jìn)行討論,JCheckbook用于記錄及追蹤諸如存取款,票據(jù)開具之類的銀行賬戶活動。
具體明確
Java定義的異常類集成關(guān)系。從Throwable
開始,它被 Error
和 Exception
繼承。Exception
再被RuntimeException
繼承。如下圖所示
這四個類是泛化的,并不提供多少出錯信息,雖然實(shí)例化這幾個類是語法上合法的(如:new Throwable()),但是最好還是把它們當(dāng)虛基類看,使用它們更加特化的子類。Java已經(jīng)提供了大量異常子類,如需更加具體,你也可以定義自己的異常類。
例 如:java.io package包中定義了Exception類的子類IOException,更加特化確的是 FileNotFoundException,EOFException和ObjectStreamException這些IOException的子 類。每一種都描述了一類特定的I/O錯誤:分別是文件丟失,異常文件結(jié)尾和錯誤的序列化對象流.異常越具體,我們的程序就能更好地回答”什么出了錯”這個 問題。
捕 獲異常時盡量明確也很重要。例如:JCheckbook可以通過重新詢問用戶文件名來處理FileNotFoundException,對于 EOFException,它可以根據(jù)異常拋出前讀取的信息繼續(xù)運(yùn)行。如果拋出的是ObjectStreamException,則程序應(yīng)該提示用戶文件 已損壞,應(yīng)當(dāng)使用備份文件或者其他文件。
Java讓明確捕獲異常變得容易,因?yàn)槲覀兛梢詫ν籺ry塊定義多個catch塊,從而對每種異常分別進(jìn)行恰當(dāng)?shù)奶幚怼?/p>
File prefsFile = new File(prefsFilename);
try {
readPreferences(prefsFile);
} catch (FileNotFoundException e) {
// alert the user that the specified file does not exist
} catch (EOFException e) {
// alert the user that the end of the file // was reached
} catch (ObjectStreamException e) {
// alert the user that the file is corrupted
} catch (IOException e) {
// alert the user that some other I/O // error occurred
}
JCheckbook 通過使用多個catch塊來給用戶提供捕獲到異常的明確信息。舉例來說:如果捕獲了FileNotFoundException,它可以提示用戶指定另一 個文件,某些情況下多個catch塊帶來的額外編碼工作量可能是非必要的負(fù)擔(dān),但在這個例子中,額外的代碼的確幫助程序提供了對用戶更友好的響應(yīng)。
除前三個catch塊處理的異常之外,最后一個catch塊在IOException拋出時給用戶提供了更泛化的錯誤信息.這樣一來,程序就可以盡可能提供具體的信息,但也有能力處理未預(yù)料到的其他異常。
有時開發(fā)人員會捕獲范化異常,并顯示異常類名稱或者打印堆棧信息以求"具體"。千萬別這么干!用戶看到j(luò)ava.io.EOFException或者堆棧信息只會頭疼而不是獲得幫助。應(yīng)當(dāng)捕獲具體的異常并且用"人話"給用戶提示確切的信息。不過,異常堆棧倒是可以在你的日志文件里打印。記住,異常和堆棧信息是用來幫助開發(fā)人 員而不是用戶的。
最后,應(yīng)該注意到JCheckbook并沒有在readPreferences()中捕獲異常,而是將捕獲和處理異常留到用戶界面層來做,這樣就能用對話框或其他方式來通知用戶。這被稱為"延遲捕獲",下文就會談到。
及早拋出
異常堆棧信息提供了導(dǎo)致異常出現(xiàn)的方法調(diào)用鏈的精確順序,包括每個方法調(diào)用的類名,方法名,代碼文件名甚至行數(shù),以此來精確定位異常出現(xiàn)的現(xiàn)場。
java.lang.NullPointerException
at java.io.FileInputStream.open(Native Method)
at java.io.FileInputStream.<init>(FileInputStream.java:103)
at jcheckbook.JCheckbook.readPreferences(JCheckbook.java:225)
at jcheckbook.JCheckbook.startup(JCheckbook.java:116)
at jcheckbook.JCheckbook.<init>(JCheckbook.java:27)
at jcheckbook.JCheckbook.main(JCheckbook.java:318)
以 上展示了FileInputStream類的open()方法拋出NullPointerException的情況。不過注意 FileInputStream.close()是標(biāo)準(zhǔn)Java類庫的一部分,很可能導(dǎo)致這個異常的問題原因在于我們的代碼本身而不是Java API。所以問題很可能出現(xiàn)在前面的其中一個方法,幸好它也在堆棧信息中打印出來了。
不幸的是,NullPointerException是Java中信息量最少的(卻也是最常遭遇且讓人崩潰的)異常。它壓根不提我們最關(guān)心的事情:到底哪里是null。所以我們不得不回退幾步去找哪里出了錯。
通過逐步回退跟蹤堆棧信息并檢查代碼,我們可以確定錯誤原因是向readPreferences()傳入了一個空文件名參數(shù)。既然readPreferences()知道它不能處理空文件名,所以馬上檢查該條件:
public void readPreferences(String filename)
throws IllegalArgumentException{
if (filename == null){
throw new IllegalArgumentException("filename is null");
} //if
//...perform other operations...
InputStream in = new FileInputStream(filename);
//...read the preferences file...
}
通過提早拋出異常(又稱"迅速失敗"),異常得以清晰又準(zhǔn)確。堆棧信息立即反映出什么出了錯(提供了非法參數(shù)值),為什么出錯(文件名不能為空值),以及哪里出的錯(readPreferences()的前部分)。這樣我們的堆棧信息就能如實(shí)提供:
java.lang.IllegalArgumentException: filename is null
at jcheckbook.JCheckbook.readPreferences(JCheckbook.java:207)
at jcheckbook.JCheckbook.startup(JCheckbook.java:116)
at jcheckbook.JCheckbook.<init>(JCheckbook.java:27)
at jcheckbook.JCheckbook.main(JCheckbook.java:318)
另外,其中包含的異常信息("文件名為空")通過明確回答什么為空這一問題使得異常提供的信息更加豐富,而這一答案是我們之前代碼中拋出的NullPointerException所無法提供的。
通過在檢測到錯誤時立刻拋出異常來實(shí)現(xiàn)迅速失敗,可以有效避免不必要的對象構(gòu)造或資源占用,比如文件或網(wǎng)絡(luò)連接。同樣,打開這些資源所帶來的清理操作也可以省卻。
延遲捕獲
菜鳥和高手都可能犯的一個錯是,在程序有能力處理異常之前就捕獲它。Java編譯器通過要求檢查出的異常必須被捕獲或拋出而間接助長了這種行為。自然而然的做法就是立即將代碼用try塊包裝起來,并使用catch捕獲異常,以免編譯器報錯。
問題在于,捕獲之后該拿異常怎么辦?最不該做的就是什么都不做。空的catch塊等于把整個異常丟進(jìn)黑洞,能夠說明何時何處為何出錯的所有信息都會永遠(yuǎn)丟失。把異常寫到日志中還稍微好點(diǎn),至少還有記錄可查。但我們總不能指望用戶去閱讀或者理解日志文件和異常信息。讓readPreferences()顯示錯誤信息對話框也不合適,因?yàn)殡m然JCheckbook目前是桌面應(yīng)用程序,但我們還計劃將它變成基于HTML的Web應(yīng)用。那樣的話,顯示錯誤對話框顯然不是個選擇。同時,不管HTML還是C/S版本,配置信息都是在服務(wù)器上讀取的,而錯誤信息需要顯示給Web瀏覽器或者客戶端程序。 readPreferences()應(yīng)當(dāng)在設(shè)計時將這些未來需求也考慮在內(nèi)。適當(dāng)分離用戶界面代碼和程序邏輯可以提高我們代碼的可重用性。
在有條件處理異常之前過早捕獲它,通常會導(dǎo)致更嚴(yán)重的錯誤和其他異常。例如,如果上文的readPreferences()方法在調(diào)用FileInputStream構(gòu)造方法時立即捕獲和記錄可能拋出的FileNotFoundException,代碼會變成下面這樣:
public void readPreferences(String filename){
//...
InputStream in = null;
// DO NOT DO THIS!!!
try{
in = new FileInputStream(filename);
}
catch (FileNotFoundException e){
logger.log(e);
}
in.read(...);
//...
}
上 面的代碼在完全沒有能力從FileNotFoundException中恢復(fù)過來的情況下就捕獲了它。如果文件無法找到,下面的方法顯然無法讀取它。如果 readPreferences()被要求讀取不存在的文件時會發(fā)生什么情況?當(dāng)然,F(xiàn)ileNotFoundException會被記錄下來,如果我們 當(dāng)時去看日志文件的話,就會知道。然而當(dāng)程序嘗試從文件中讀取數(shù)據(jù)時會發(fā)生什么?既然文件不存在,變量in就是空的,一個 NullPointerException就會被拋出。
調(diào)試程序時,本能告訴我們要看日志最后面的信息。那將會是NullPointerException,非常讓人討厭的是這個異常非常不具體。錯誤信息不僅誤導(dǎo)我們什么出了錯(真正的錯誤是FileNotFoundException而不是NullPointerException),還誤導(dǎo)了錯誤的出處。真正 的問題出在拋出NullPointerException處的數(shù)行之外,這之間有可能存在好幾次方法的調(diào)用和類的銷毀。我們的注意力被這條小魚從真正的錯誤處吸引了過來,一直到我們往回看日志才能發(fā)現(xiàn)問題的源頭。
既然readPreferences() 真正應(yīng)該做的事情不是捕獲這些異常,那應(yīng)該是什么?看起來有點(diǎn)有悖常理,通常最合適的做法其實(shí)是什么都不做,不要馬上捕獲異常。把責(zé)任交給 readPreferences()的調(diào)用者,讓它來研究處理配置文件缺失的恰當(dāng)方法,它有可能會提示用戶指定其他文件,或者使用默認(rèn)值,實(shí)在不行的話也 許警告用戶并退出程序。
把異常處理的責(zé)任往調(diào)用鏈的上游傳遞的辦法,就是在方法的throws子句聲明異常。在聲明可能拋出的異常時,注意越具體越好。這用于標(biāo)識出調(diào)用你方法的程序需要知曉并且準(zhǔn)備處理的異常類型。例如,“延遲捕獲”版本的readPreferences()可能是這樣的:
public void readPreferences(String filename)
throws IllegalArgumentException,
FileNotFoundException, IOException{
if (filename == null){
throw new IllegalArgumentException("filename is null");
} //if
//...
InputStream in = new FileInputStream(filename);
//...
}
技 術(shù)上來說,我們唯一需要聲明的異常是IOException,但我們明確聲明了方法可能拋出FileNotFoundException。 IllegalArgumentException不是必須聲明的,因?yàn)樗欠菣z查性異常(即RuntimeException的子類)。然而聲明它是為 了文檔化我們的代碼(這些異常也應(yīng)該在方法的JavaDocs中標(biāo)注出來)。
當(dāng) 然,最終你的程序需要捕獲異常,否則會意外終止。但這里的技巧是在合適的層面捕獲異常,以便你的程序要么可以從異常中有意義地恢復(fù)并繼續(xù)下去,而不導(dǎo)致更 深入的錯誤;要么能夠?yàn)橛脩籼峁┟鞔_的信息,包括引導(dǎo)他們從錯誤中恢復(fù)過來。如果你的方法無法勝任,那么就不要處理異常,把它留到后面捕獲和在恰當(dāng)?shù)膶用嫣幚怼?/p>
結(jié)論
經(jīng)驗(yàn)豐富的開發(fā)人員都知道,調(diào)試程序的最大難點(diǎn)不在于修復(fù)缺陷,而在于從海量的代碼中找出缺陷的藏身之處。只要遵循本文的三個原則,就能讓你的異常協(xié)助你跟蹤和消滅缺陷,使你的程序更加健壯,對用戶更加友好。