在 Java 中,異常處理是個很麻煩的事情。初學者覺得它很難理解,甚至是經驗豐富的開發者也要花費很長時間決定異常是要處理掉和拋出。
所以很多開發團隊約定一些原則處理異常。如果你是一個團隊的新成員,你可能會很驚訝,因爲他們約定的規則可能和你以前使用的規則不一樣。
不過,有很多最佳實踐的規則,被大部分團隊接受。這裏有 9 大重要的約定,幫助你學習或者改進異常處理。
1
在 Finally 清理資源或者使用 Try-With-Resource 特性
大部分情況下,在 try 代碼塊中使用資源後需要關閉資源,例如 InputStream 。在這些情況下,一種常見的失誤就是在 try 代碼塊的最後關閉資源。
問題就是,只有沒有異常拋出的時候,這段代碼纔可以正常工作。try 代碼塊內代碼會正常執行,並且資源可以正常關閉。但是,使用 try 代碼塊是有原因的,一般調用一個或多個可能拋出異常的方法,而且,你自己也可能會拋出一個異常,這意味着代碼可能不會執行到 try 代碼塊的最後部分。結果就是,你並沒有關閉資源。
所以,你應該把清理工作的代碼放到 finally 裏去,或者使用 try-with-resource 特性。
使用 Finally 代碼塊
與前面幾行 try 代碼塊不同,finally 代碼塊總是會被執行。不管 try 代碼塊成功執行之後還是你在 catch 代碼塊中處理完異常後都會執行。因此,你可以確保你清理了所有打開的資源。
Java 7 的 Try-With-Resource 語法
另一個可選的方案是 try-with-resource 語法,我在介紹 Java 的異常處理裏更詳細的介紹了它。
如果你的資源實現了 AutoCloseable 接口,你可以使用這個語法。大多數的 Java 標準資源都繼承了這個接口。當你在 try 子句中打開資源,資源會在 try 代碼塊執行後或異常處理後自動關閉。
2
優先明確異常
你拋出的異常越明確越好,永遠記住,你的同事或者幾個月之後的你,將會調用你的方法並且處理異常。
因此需要保證提供給他們儘可能多的信息。這樣你的 API 更容易被理解。你的方法的調用者能夠更好的處理異常並且避免額外的檢查。
因此,總是嘗試尋找最適合你的異常事件的類,例如,拋出一個 NumberFormatException 來替換一個 IllegalArgumentException 。避免拋出一個不明確的異常。
3
記錄指定的異常
每當你在方法簽名中指定異常,你也應該在 Javadoc 中記錄它。 這與上一個最佳實踐具有相同的目標:儘可能多地向調用者提供信息,以便避免或處理異常。
因此,請確保向 Javadoc 添加 @throws 聲明並描述可能導致異常的情況。
4
使用描述性消息拋出異常
這個最佳實踐背後的想法與前兩個類似。但這一次,你不會將信息提供給方法的調用者。每個必須瞭解在日誌文件或監視工具中報告異常情況時發生了什麼情況的人都可以讀取異常消息。
因此,應該儘可能精確地描述問題,並提供最相關的信息來了解異常事件。
不要誤會我的意思,你不用去寫一段文字。但你也應該在1-2個短句中解釋異常的原因。這有助於你的運營團隊瞭解問題的嚴重性,並且還可以讓你更輕鬆地分析任何服務突發事件。
如果拋出一個特定的異常,它的類名很可能已經描述了這種錯誤。所以,你不需要提供很多額外的信息。一個很好的例子是 NumberFormatException 。當你以錯誤的格式提供 String 時,它將被 java.lang.Long 類的構造函數拋出。
NumberFormatException 類的名稱已經告訴你這種問題。它的消息表示只需要提供導致問題的輸入字符串。如果異常類的名稱不具有表達性,則需要在消息中提供所需的信息。
17:17:26,386 ERROR TestExceptionHandling:52 - java.lang.NumberFormatException: For input string: "xyz"
5
優先捕獲最具體的異常
大多數 IDE 都可以幫助你實現這個最佳實踐。當你嘗試首先捕獲較不具體的異常時,它們會報告無法訪問的代碼塊。
但問題在於,只有匹配異常的第一個 catch 塊會被執行。 因此,如果首先捕獲 IllegalArgumentException ,則永遠不會到達應該處理更具體的 NumberFormatException 的 catch 塊,因爲它是 IllegalArgumentException 的子類。
總是優先捕獲最具體的異常類,並將不太具體的 catch 塊添加到列表的末尾。
你可以在下面的代碼片斷中看到這樣一個 try-catch 語句的例子。 第一個 catch 塊處理所有 NumberFormatException 異常,第二個處理所有非 NumberFormatException 異常的 IllegalArgumentException 異常。
6
不要捕獲 Throwable 類
Throwable 是所有異常和錯誤的超類。你可以在 catch 子句中使用它,但是你永遠不應該這樣做!
如果在 catch 子句中使用 Throwable ,它不僅會捕獲所有異常,也將捕獲所有的錯誤。JVM 拋出錯誤,指出不應該由應用程序處理的嚴重問題。 典型的例子是 OutOfMemoryError 或者 StackOverflowError 。 兩者都是由應用程序控制之外的情況引起的,無法處理。
所以,最好不要捕獲 Throwable ,除非你確定自己處於一種特殊的情況下能夠處理錯誤。
7
不要忽略異常
你曾經有去分析過一個只執行了你用例的第一部分的 bug 報告嗎?
這通常是由於一個被忽略的異常造成的。開發者可能會非常肯定,它永遠不會被拋出,並添加一個 catch 塊,不做處理或不記錄它。而當你發現這個塊時,你很可能甚至會發現其中有一個“這永遠不會發生”的註釋。
那麼,你可能正在分析一個不可能發生的問題。
所以,請不要忽略任何一個異常。 你不知道代碼將來如何改變。有人可能會在沒有意識到會造成問題的情況下,刪除阻止異常事件的驗證。或者是拋出異常的代碼被改變,現在拋出同一個類的多個異常,而調用的代碼並不能阻止所有異常。
你至少應該寫一條日誌信息,告訴大家這個不可思議的事發生了,而且有人需要檢查它。
8
不要記錄日誌和拋出錯誤
這可能是該文章中最常被忽略的最佳實踐。 你可以找到很多的其中有一個異常被捕獲的代碼片段,甚至是一些代碼庫,被記錄和重新拋出。
在發生異常時記錄異常可能會感覺很直觀,然後重新拋出異常,以便調用者可以適當地處理異常。但它會爲同一個異常重複寫入多個錯誤消息。
附加消息也不會添加任何信息。正如在最佳實踐#4中所解釋的那樣,異常消息應該描述異常事件。 堆棧跟蹤告訴你在哪個類,方法和行中拋出異常。
如果你需要添加其他信息,則應該捕獲異常並將其包裝在自定義的信息中。 但請務必遵循最佳實踐9。
所以,只捕獲你想處理的異常。 否則,在方法簽名中指定它,並讓調用者處理它。
9
封裝好的異常類而不使用
有時候,最好是捕獲一個標準異常並將其封裝成一定製的異常。一個典型的例子是應用程序或框架特定的業務異常。允許你添加些額外的信息,並且你也可以爲你的異常類實現一個特殊的處理。
在你這樣做時,請確保將原始異常設置爲原因(注:參考下方代碼 NumberFormatException e 中的原始異常 e )。Exception 類提供了特殊的構造函數方法,它接受一個 Throwable 作爲參數。
另外,你將會丟失堆棧跟蹤和原始異常的消息,這將會使分析導致異常的異常事件變得困難。
10
總結
如你所見,當你拋出或捕獲異常的時候,有很多不同的事情需要考慮,而且大部分事情都是爲了改善代碼的可讀性或者 API 的可用性。
異常通常都是一種異常處理技巧,同時也是一種通信媒介。因此,爲了和同事更好的合作,一個團隊必須要制定出一個最佳實踐和規則,只有這樣團隊成員才能理解這些通用概念,同時在工作中使用它。
-END-