在 Java 中坚俗,異常處理是個(gè)很麻煩的事情。初學(xué)者覺得它很難理解别凤,甚至是經(jīng)驗(yàn)豐富的開發(fā)者也要花費(fèi)很長時(shí)間決定異常是要處理掉和拋出偎行。
所以很多開發(fā)團(tuán)隊(duì)約定一些原則處理異常川背。如果你是一個(gè)團(tuán)隊(duì)的新成員,你可能會很驚訝蛤袒,因?yàn)樗麄兗s定的規(guī)則可能和你以前使用的規(guī)則不一樣熄云。
不過,有很多最佳實(shí)踐的規(guī)則妙真,被大部分團(tuán)隊(duì)接受缴允。這里有 9 大重要的約定,幫助你學(xué)習(xí)或者改進(jìn)異常處理珍德。
1练般、在 Finally 清理資源或者使用 Try-With-Resource 特性
大部分情況下,在 try 代碼塊中使用資源后需要關(guān)閉資源锈候,例如?InputStream?薄料。在這些情況下,一種常見的失誤就是在 try 代碼塊的最后關(guān)閉資源晴及。
問題就是都办,只有沒有異常拋出的時(shí)候嫡锌,這段代碼才可以正常工作虑稼。try 代碼塊內(nèi)代碼會正常執(zhí)行琳钉,并且資源可以正常關(guān)閉。但是蛛倦,使用 try 代碼塊是有原因的歌懒,一般調(diào)用一個(gè)或多個(gè)可能拋出異常的方法,而且溯壶,你自己也可能會拋出一個(gè)異常及皂,這意味著代碼可能不會執(zhí)行到 try 代碼塊的最后部分。結(jié)果就是且改,你并沒有關(guān)閉資源验烧。
所以,你應(yīng)該把清理工作的代碼放到 finally 里去又跛,或者使用 try-with-resource 特性碍拆。
使用 Finally 代碼塊
與前面幾行 try 代碼塊不同,finally 代碼塊總是會被執(zhí)行慨蓝。不管 try 代碼塊成功執(zhí)行之后還是你在 catch 代碼塊中處理完異常后都會執(zhí)行感混。因此,你可以確保你清理了所有打開的資源礼烈。
Java 7 的 Try-With-Resource 語法
另一個(gè)可選的方案是 try-with-resource 語法弧满,我在介紹 Java 的異常處理里更詳細(xì)的介紹了它。
如果你的資源實(shí)現(xiàn)了?AutoCloseable?接口此熬,你可以使用這個(gè)語法庭呜。大多數(shù)的 Java 標(biāo)準(zhǔn)資源都繼承了這個(gè)接口。當(dāng)你在 try 子句中打開資源犀忱,資源會在 try 代碼塊執(zhí)行后或異常處理后自動關(guān)閉疟赊。
2、優(yōu)先明確異常
你拋出的異常越明確越好峡碉,永遠(yuǎn)記住近哟,你的同事或者幾個(gè)月之后的你,將會調(diào)用你的方法并且處理異常鲫寄。
因此需要保證提供給他們盡可能多的信息吉执。這樣你的 API 更容易被理解。你的方法的調(diào)用者能夠更好的處理異常并且避免額外的檢查地来。
因此戳玫,總是嘗試尋找最適合你的異常事件的類,例如未斑,拋出一個(gè)?NumberFormatException?來替換一個(gè)?IllegalArgumentException?咕宿。避免拋出一個(gè)不明確的異常。
3、記錄指定的異常
每當(dāng)你在方法簽名中指定異常府阀,你也應(yīng)該在?Javadoc 中記錄它缆镣。 這與上一個(gè)最佳實(shí)踐具有相同的目標(biāo):盡可能多地向調(diào)用者提供信息,以便避免或處理異常试浙。
因此董瞻,請確保向 Javadoc 添加 @throws 聲明并描述可能導(dǎo)致異常的情況。
4田巴、使用描述性消息拋出異常
這個(gè)最佳實(shí)踐背后的想法與前兩個(gè)類似钠糊。但這一次,你不會將信息提供給方法的調(diào)用者壹哺。每個(gè)必須了解在日志文件或監(jiān)視工具中報(bào)告異常情況時(shí)發(fā)生了什么情況的人都可以讀取異常消息抄伍。
因此,應(yīng)該盡可能精確地描述問題管宵,并提供最相關(guān)的信息來了解異常事件截珍。
不要誤會我的意思,你不用去寫一段文字啄糙。但你也應(yīng)該在1-2個(gè)短句中解釋異常的原因笛臣。這有助于你的運(yùn)營團(tuán)隊(duì)了解問題的嚴(yán)重性,并且還可以讓你更輕松地分析任何服務(wù)突發(fā)事件隧饼。
如果拋出一個(gè)特定的異常沈堡,它的類名很可能已經(jīng)描述了這種錯誤。所以燕雁,你不需要提供很多額外的信息诞丽。一個(gè)很好的例子是 NumberFormatException 。當(dāng)你以錯誤的格式提供 String 時(shí)拐格,它將被 java.lang.Long 類的構(gòu)造函數(shù)拋出僧免。
NumberFormatException 類的名稱已經(jīng)告訴你這種問題。它的消息表示只需要提供導(dǎo)致問題的輸入字符串捏浊。如果異常類的名稱不具有表達(dá)性懂衩,則需要在消息中提供所需的信息。
17:17:26,386 ERROR TestExceptionHandling:52 - java.lang.NumberFormatException: For input string: "xyz"
5金踪、優(yōu)先捕獲最具體的異常
大多數(shù) IDE 都可以幫助你實(shí)現(xiàn)這個(gè)最佳實(shí)踐浊洞。當(dāng)你嘗試首先捕獲較不具體的異常時(shí),它們會報(bào)告無法訪問的代碼塊胡岔。
但問題在于法希,只有匹配異常的第一個(gè) catch 塊會被執(zhí)行。 因此靶瘸,如果首先捕獲 IllegalArgumentException 苫亦,則永遠(yuǎn)不會到達(dá)應(yīng)該處理更具體的 NumberFormatException 的 catch 塊毛肋,因?yàn)樗?IllegalArgumentException 的子類。
總是優(yōu)先捕獲最具體的異常類屋剑,并將不太具體的 catch 塊添加到列表的末尾润匙。
你可以在下面的代碼片斷中看到這樣一個(gè) try-catch 語句的例子。 第一個(gè) catch 塊處理所有 NumberFormatException 異常饼丘,第二個(gè)處理所有非 NumberFormatException 異常的 IllegalArgumentException 異常趁桃。
6辽话、不要捕獲 Throwable 類
Throwable?是所有異常和錯誤的超類肄鸽。你可以在 catch 子句中使用它,但是你永遠(yuǎn)不應(yīng)該這樣做油啤!
如果在 catch 子句中使用 Throwable 典徘,它不僅會捕獲所有異常,也將捕獲所有的錯誤慧妄。JVM 拋出錯誤初澎,指出不應(yīng)該由應(yīng)用程序處理的嚴(yán)重問題损话。 典型的例子是?OutOfMemoryError?或者?StackOverflowError?。 兩者都是由應(yīng)用程序控制之外的情況引起的梅鹦,無法處理。
所以冗锁,最好不要捕獲 Throwable 齐唆,除非你確定自己處于一種特殊的情況下能夠處理錯誤。
7冻河、不要忽略異常
你曾經(jīng)有去分析過一個(gè)只執(zhí)行了你用例的第一部分的 bug 報(bào)告嗎箍邮?
這通常是由于一個(gè)被忽略的異常造成的。開發(fā)者可能會非尺缎穑肯定锭弊,它永遠(yuǎn)不會被拋出,并添加一個(gè) catch 塊擂错,不做處理或不記錄它味滞。而當(dāng)你發(fā)現(xiàn)這個(gè)塊時(shí),你很可能甚至?xí)l(fā)現(xiàn)其中有一個(gè)“這永遠(yuǎn)不會發(fā)生”的注釋钮呀。
那么剑鞍,你可能正在分析一個(gè)不可能發(fā)生的問題。
所以行楞,請不要忽略任何一個(gè)異常攒暇。 你不知道代碼將來如何改變。有人可能會在沒有意識到會造成問題的情況下子房,刪除阻止異常事件的驗(yàn)證形用【驮或者是拋出異常的代碼被改變,現(xiàn)在拋出同一個(gè)類的多個(gè)異常田度,而調(diào)用的代碼并不能阻止所有異常妒御。
你至少應(yīng)該寫一條日志信息,告訴大家這個(gè)不可思議的事發(fā)生了镇饺,而且有人需要檢查它乎莉。
8、不要記錄日志和拋出錯誤
這可能是該文章中最常被忽略的最佳實(shí)踐奸笤。 你可以找到很多的其中有一個(gè)異常被捕獲的代碼片段惋啃,甚至是一些代碼庫,被記錄和重新拋出监右。
在發(fā)生異常時(shí)記錄異潮呙穑可能會感覺很直觀,然后重新拋出異常健盒,以便調(diào)用者可以適當(dāng)?shù)靥幚懋惓H奘荨5鼤橥粋€(gè)異常重復(fù)寫入多個(gè)錯誤消息。
17:44:28,945 ERROR TestExceptionHandling:65 - java.lang.NumberFormatException: For input string: "xyz"
Exception in thread "main" java.lang.NumberFormatException: For input string: "xyz"
at java.lang.NumberFormatException.forInputString(NumberFormatException.java:65)
at java.lang.Long.parseLong(Long.java:589)
at java.lang.Long.(Long.java:965)
at com.stackify.example.TestExceptionHandling.logAndThrowException(TestExceptionHandling.java:63)
at com.stackify.example.TestExceptionHandling.main(TestExceptionHandling.java:58)
附加消息也不會添加任何信息扣癣。正如在最佳實(shí)踐#4中所解釋的那樣惰帽,異常消息應(yīng)該描述異常事件。 堆棧跟蹤告訴你在哪個(gè)類父虑,方法和行中拋出異常该酗。
如果你需要添加其他信息,則應(yīng)該捕獲異常并將其包裝在自定義的信息中频轿。 但請務(wù)必遵循最佳實(shí)踐9垂涯。
所以,只捕獲你想處理的異常航邢。 否則耕赘,在方法簽名中指定它,并讓調(diào)用者處理它膳殷。
9操骡、封裝好的異常類而不使用
有時(shí)候,最好是捕獲一個(gè)標(biāo)準(zhǔn)異常并將其封裝成一定制的異常赚窃。一個(gè)典型的例子是應(yīng)用程序或框架特定的業(yè)務(wù)異常册招。允許你添加些額外的信息,并且你也可以為你的異常類實(shí)現(xiàn)一個(gè)特殊的處理勒极。
在你這樣做時(shí)是掰,請確保將原始異常設(shè)置為原因(注:參考下方代碼 NumberFormatException e 中的原始異常 e )。Exception?類提供了特殊的構(gòu)造函數(shù)方法辱匿,它接受一個(gè)?Throwable?作為參數(shù)键痛。另外炫彩,你將會丟失堆棧跟蹤和原始異常的消息,這將會使分析導(dǎo)致異常的異常事件變得困難絮短。
總結(jié)
如你所見江兢,當(dāng)你拋出或捕獲異常的時(shí)候,有很多不同的事情需要考慮丁频,而且大部分事情都是為了改善代碼的可讀性或者 API 的可用性杉允。
異常通常都是一種異常處理技巧,同時(shí)也是一種通信媒介席里。因此叔磷,為了和同事更好的合作,一個(gè)團(tuán)隊(duì)必須要制定出一個(gè)最佳實(shí)踐和規(guī)則胁勺,只有這樣團(tuán)隊(duì)成員才能理解這些通用概念世澜,同時(shí)在工作中使用它独旷。