Java異常處理的9個最佳實(shí)踐
在 Java 中，異常處理是個很麻煩的事情。初學(xué)者覺得它很難理解，甚至是經(jīng)驗(yàn)豐富的開發(fā)者也要花費(fèi)很長時間決定異常是要處理掉和拋出。
所以很多開發(fā)團(tuán)隊(duì)約定一些原則處理異常。如果你是一個團(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)閉資源。
問題就是，只有沒有異常拋出的時候，這段代碼才可以正常工作。try 代碼塊內(nèi)代碼會正常執(zhí)行，并且資源可以正常關(guān)閉。但是，使用 try 代碼塊是有原因的，一般調(diào)用一個或多個可能拋出異常的方法，而且，你自己也可能會拋出一個異常，這意味著代碼可能不會執(zhí)行到 try 代碼塊的***部分。結(jié)果就是，你并沒有關(guān)閉資源。
所以，你應(yīng)該把清理工作的代碼放到 finally 里去，或者使用 try-with-resource 特性。
a、使用 Finally 代碼塊
與前面幾行 try 代碼塊不同，finally 代碼塊總是會被執(zhí)行。不管 try 代碼塊成功執(zhí)行之后還是你在 catch 代碼塊中處理完異常后都會執(zhí)行。因此，你可以確保你清理了所有打開的資源。
b、Java 7 的 Try-With-Resource 語法
另一個可選的方案是 try-with-resource 語法，我在介紹 Java 的異常處理里更詳細(xì)的介紹了它。
如果你的資源實(shí)現(xiàn)了 AutoCloseable 接口，你可以使用這個語法。大多數(shù)的 Java 標(biāo)準(zhǔn)資源都繼承了這個接口。當(dāng)你在 try 子句中打開資源，資源會在 try 代碼塊執(zhí)行后或異常處理后自動關(guān)閉。
2、優(yōu)先明確異常
你拋出的異常越明確越好，永遠(yuǎn)記住，你的同事或者幾個月之后的你，將會調(diào)用你的方法并且處理異常。
因此需要保證提供給他們盡可能多的信息。這樣你的 API 更容易被理解。你的方法的調(diào)用者能夠更好的處理異常并且避免額外的檢查。
因此，總是嘗試尋找最適合你的異常事件的類，例如，拋出一個 NumberFormatException 來替換一個 IllegalArgumentException 。避免拋出一個不明確的異常。
3、記錄指定的異常
每當(dāng)你在方法簽名中指定異常，你也應(yīng)該在 Javadoc 中記錄它。 這與上一個***實(shí)踐具有相同的目標(biāo)：盡可能多地向調(diào)用者提供信息，以便避免或處理異常。
因此，請確保向 Javadoc 添加 @throws 聲明并描述可能導(dǎo)致異常的情況。
4、使用描述性消息拋出異常
這個***實(shí)踐背后的想法與前兩個類似。但這一次，你不會將信息提供給方法的調(diào)用者。每個必須了解在日志文件或監(jiān)視工具中報(bào)告異常情況時發(fā)生了什么情況的人都可以讀取異常消息。
因此，應(yīng)該盡可能精確地描述問題，并提供最相關(guān)的信息來了解異常事件。
不要誤會我的意思，你不用去寫一段文字。但你也應(yīng)該在1-2個短句中解釋異常的原因。這有助于你的運(yùn)營團(tuán)隊(duì)了解問題的嚴(yán)重性，并且還可以讓你更輕松地分析任何服務(wù)突發(fā)事件。
如果拋出一個特定的異常，它的類名很可能已經(jīng)描述了這種錯誤。所以，你不需要提供很多額外的信息。一個很好的例子是 NumberFormatException 。當(dāng)你以錯誤的格式提供 String 時，它將被 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)這個***實(shí)踐。當(dāng)你嘗試首先捕獲較不具體的異常時，它們會報(bào)告無法訪問的代碼塊。
但問題在于，只有匹配異常的***個 catch 塊會被執(zhí)行。 因此，如果首先捕獲 IllegalArgumentException ，則永遠(yuǎn)不會到達(dá)應(yīng)該處理更具體的 NumberFormatException 的 catch 塊，因?yàn)樗?IllegalArgumentException 的子類。
總是優(yōu)先捕獲***體的異常類，并將不太具體的 catch 塊添加到列表的末尾。
你可以在下面的代碼片斷中看到這樣一個 try-catch 語句的例子。 ***個 catch 塊處理所有 NumberFormatException 異常，第二個處理所有非 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)有去分析過一個只執(zhí)行了你用例的***部分的 bug 報(bào)告嗎?
這通常是由于一個被忽略的異常造成的。開發(fā)者可能會非常肯定，它永遠(yuǎn)不會被拋出，并添加一個 catch 塊，不做處理或不記錄它。而當(dāng)你發(fā)現(xiàn)這個塊時，你很可能甚至?xí)l(fā)現(xiàn)其中有一個“這永遠(yuǎn)不會發(fā)生”的注釋。
那么，你可能正在分析一個不可能發(fā)生的問題。
所以，請不要忽略任何一個異常。 你不知道代碼將來如何改變。有人可能會在沒有意識到會造成問題的情況下，刪除阻止異常事件的驗(yàn)證。或者是拋出異常的代碼被改變，現(xiàn)在拋出同一個類的多個異常，而調(diào)用的代碼并不能阻止所有異常。
你至少應(yīng)該寫一條日志信息，告訴大家這個不可思議的事發(fā)生了，而且有人需要檢查它。
8、不要記錄日志和拋出錯誤
這可能是該文章中最常被忽略的***實(shí)踐。 你可以找到很多的其中有一個異常被捕獲的代碼片段，甚至是一些代碼庫，被記錄和重新拋出。
在發(fā)生異常時記錄異常可能會感覺很直觀，然后重新拋出異常，以便調(diào)用者可以適當(dāng)?shù)靥幚懋惓！５鼤橥粋€異常重復(fù)寫入多個錯誤消息。
- 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)該描述異常事件。 堆棧跟蹤告訴你在哪個類，方法和行中拋出異常。
如果你需要添加其他信息，則應(yīng)該捕獲異常并將其包裝在自定義的信息中。 但請務(wù)必遵循***實(shí)踐9。
所以，只捕獲你想處理的異常。 否則，在方法簽名中指定它，并讓調(diào)用者處理它。
9、封裝好的異常類而不使用
有時候，***是捕獲一個標(biāo)準(zhǔn)異常并將其封裝成一定制的異常。一個典型的例子是應(yīng)用程序或框架特定的業(yè)務(wù)異常。允許你添加些額外的信息，并且你也可以為你的異常類實(shí)現(xiàn)一個特殊的處理。
在你這樣做時，請確保將原始異常設(shè)置為原因(注：參考下方代碼 NumberFormatException e 中的原始異常 e )。Exception 類提供了特殊的構(gòu)造函數(shù)方法，它接受一個 Throwable 作為參數(shù)。另外，你將會丟失堆棧跟蹤和原始異常的消息，這將會使分析導(dǎo)致異常的異常事件變得困難。
總結(jié)
如你所見，當(dāng)你拋出或捕獲異常的時候，有很多不同的事情需要考慮，而且大部分事情都是為了改善代碼的可讀性或者 API 的可用性。
異常通常都是一種異常處理技巧，同時也是一種通信媒介。因此，為了和同事更好的合作，一個團(tuán)隊(duì)必須要制定出一個***實(shí)踐和規(guī)則，只有這樣團(tuán)隊(duì)成員才能理解這些通用概念，同時在工作中使用它。
