無論你是新手還是程序員,復習下異常處理的實踐總是一件好事,因為這能確保你與你的團隊在遇到問題時能夠處理得了它。
在 Java 中處理異常并不是一件易事。新手覺得處理異常難以理解,甚至是開發者也會花上好幾個小時來討論是應該拋出拋異常還是處理異常。這就是為何大多數開發團隊都擁有一套自己的異常處理規范。如果你初進團隊,你也許會發現這些規范和你曾使用的規范大相徑庭。
盡管如此,這里還是有一些被大多數團隊所遵循的實踐準則。以下9個重要的實踐方法能幫助你開始進行異常處理,或提高你的異常處理水平。
1、在 Finally 中清理資源或使用 Try-With-Resource 語句
在實際開發中會經常遇到在 try 中使用資源的情況,比如一個 InputStream ,在使用后你需要關閉它。在這種情況下,一個常見的錯誤是在 try 的尾部關閉了資源。
public void doNotCloseResourceInTry() { FileInputStream inputStream = null; try { File file = new File("./tmp.txt"); inputStream = new FileInputStream(file); // use the inputStream to read a file // do NOT do this inputStream.close(); } catch (FileNotFoundException e) { log.error(e); } catch (IOException e) { log.error(e); } } |
這種情況的問題是,只要異常沒被拋出,程序就能很好地運行。所有在 try 中的代碼都將被正常執行,資源也會被關閉。
但是,用 try 總是有原因的。當你調用一個或多個可能會拋出異常的方法或自己主動拋出異常時,程序可能會無法到達 try 的尾部。于是在,資源將不被關閉。
因為,你應該將所有清理資源的代碼放進 finally 中,或使用 try-with-resource 語句。
使用 Finally
與 try 相比,無論是 try 中的代碼被成功執行,還是在 catch 中處理了一個異常后,Finally 中的代碼總會被執行。因此,你可以確保所有已打開的資源都將被關閉。
public void closeResourceInFinally() { FileInputStream inputStream = null; try { File file = new File("./tmp.txt"); inputStream = new FileInputStream(file); // use the inputStream to read a file } catch (FileNotFoundException e) { log.error(e); } finally { if (inputStream != null) { try { inputStream.close(); } catch (IOException e) { log.error(e); } } } } |
Java 7 的 Try-With-Resource 語句
你還可以選擇 try-with-resource 語句,在我的這篇Java 異常處理入門中有更為詳細的介紹。
如果你在資源中實現了 AutoCloseable 接口的話,就可以使用 try-with-resource 語句了,這也是大多數 Java 標準資源的做法。如果你在 try-with-resource 中打開了一個資源,在 try 中的代碼被執行或異常處理后,這個資源將會被自動關閉。
public void automaticallyCloseResource() { File file = new File("./tmp.txt"); try (FileInputStream inputStream = new FileInputStream(file);) { // use the inputStream to read a file } catch (FileNotFoundException e) { log.error(e); } catch (IOException e) { log.error(e); } } |
2、拋出更具體的異常
你拋出的異常越具體、越明確越好。時刻牢記這點,特別是如果有一位并不了解你代碼的同事,或幾個月后的你需要調用自己的方法并處理異常時。
因此,你需要確保提供盡可能多的信息,這會使得你的 API 更易于理解。這樣,調用你方法的人可以更好地處理異常,從而避免額外的諸如此類的檢查。
所以,應該找到與你的異常事件的類,比如拋出一個 NumberFormatException 而不是 IllegalArgumentException (注:例如將參數轉換為數值出錯時,應該拋出具體的 NumberFormatException ,而不是籠統的 IllegalArgumentException )。請避免拋出一個不具體的異常。
public void doNotDoThis() throws Exception { ... } public void doThis() throws NumberFormatException { ... } |
3、為你的異常編寫文檔
當你在方法簽名中指定一個異常時,你也應該在 Javadoc 中記錄它。
所以,請確保在 Javadoc 中增加 @throws 聲明,并描述可能會導致異常的情況。
/** * This method does something extremely useful ... * * @param input * @throws MyBusinessException if ... happens */ public void doSomething(String input) throws MyBusinessException { ... } |
4、將描述信息與異常一同拋出
這個方法背后的思想和前兩個是類似的。但這一次,你不必給你的方法調用者提供信息。對于任何遭遇異常錯誤并需要搞清楚錯誤原因的人來說,異常信息總是在異常出現的同時,被記錄在了日志中,或打印在了屏幕上。
因此,請盡可能精確地描所以,不要在 catch 中使用 Throwable ,除非你能確保自己處于一些特定情況下,比如你自己足以處理錯誤,又或被要求處理錯誤時。述異常事件,并提供相關的信息以令其他人能夠理解發生了什么異常時。
別誤會我的意思了。你沒必要去寫上一大段的文字,但你應該用一兩句簡短的話來解釋一下異常發生的原因。這能讓你的開發團隊明白問題的嚴重性,也能讓你更容易地分析服務事故。
如果你拋出了一個特定的異常,它的類名很可能就已經描述了這是什么類型的錯誤了。所以,你不需要提供很多額外的描述信息。一個很好的例子是,當你提供了一個錯誤格式的 String 類型參數時,java.lang.Long 構造函數就會拋出 NumberFormatException 。
try { new Long("xyz"); } catch (NumberFormatException e) { log.error(e); } |
NumberFormatException 的類名已經告訴了你問題的類型。所以異常信息只需要返回導致問題的輸入字符串就行了。如果異常類的名字不能表明其含義,那么你還需要在異常信息中提供必要的解釋信息。
17:17:26,386 ERROR TestExceptionHandling:52 - java.lang.NumberFormatException: For input string: "xyz" |
5、優先捕獲具體的異常
大多數 IDE 都能幫你做到這點。當你嘗試優先捕獲不那么具體的異常時, IDE 會報告給你這是一個不能到達的代碼塊。
這個問題的原因是只有個匹配到異常的 catch 塊才會被執行。所以,如果你先 catch 了一個 IllegalArgumentException ,你將永遠無法到達處理更具體異常 NumberFormatException 的 catch 塊中,因為 NumberFormatException 是 IllegalArgumentException 的子類。
所以,請優先捕獲更具體的異常,并把不那么具體的 catch 塊放在后面。
在下面你可以看到這樣的一個 try-catch 語句示例。個 catch 處理所有的 NumberFormatExceptions 異常,第二個 catch 處理 NumberFormatException 異常以外的 illegalargumentexception 異常。
public void catchMostSpecificExceptionFirst() { try { doSomething("A message"); } catch (NumberFormatException e) { log.error(e); } catch (IllegalArgumentException e) { log.error(e) } } |
6、不要捕獲 Throwable
Throwable 是所有 exceptions 和 errors 的父類。雖然你可以在 catch 子句中使用它,但你應該永遠別這樣做!
如果你在 catch 子句中使用了 Throwable ,它將不僅捕獲所有異常,還會捕獲所有錯誤。這些錯誤是由 JVM 拋出的,用來表明不打算由應用處理的嚴重錯誤。 OutOfMemoryError 和 StackOverflowError 就是典型的例子,這兩種情況都是由一些超出應用控制范圍的情況導致的,無法處理。
所以,不要在 catch 中使用 Throwable ,除非你能確保自己處于一些特定情況下,比如你自己足以處理錯誤,又或被要求處理錯誤。
public void doNotCatchThrowable() { try { // do something } catch (Throwable t) { // don't do this! } } |
你分析過只有用例的部分代碼被執行的 bug 報告嗎?
這通常是由于忽略異常而導致的。開發者可能十分確定這個異常不會被拋出,然后添加了一個無法處理或無法記錄這個異常的 catch 。當你找到這個 catch 時,你很可能會發現這么一句的注釋: “This will never happen”。
public void doNotIgnoreExceptions() { try { // do something } catch (NumberFormatException e) { // this will never happen } } |
沒錯,你可能就是在分析一個永遠也不會發生的問題。
所以,請你務必不要忽略異常。你不知道代碼在將來會經歷怎樣的改動。有些人可能會誤刪異常事件的驗證,而完全沒意識到這會產出問題。或者拋出異常的代碼被修改了,相同的類被拋出了多個異常,而調用它們的代碼并不能阻止這些異常發生。
你至少應該把日志信息打印出來,告訴那些無意識下錯誤操作的人需要檢查這里。
public void logAnException() { try { // do something } catch (NumberFormatException e) { log.error("This should never happen: " + e); } } |
8、不要同時打印并拋出異常
這可能是本文中常被忽略的一條實踐準則了。你可以在許多代碼片段甚至庫中發現這個問題,異常被捕獲,打印,再被重新拋出。
try { new Long("xyz"); } catch (NumberFormatException e) { log.error(e); throw e; } |
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) |
額外的信息并不能提供更多的錯誤細節。如第4條準則中所述,異常信息應該準確描述異常事件。 Stack Trace (堆棧追蹤)會告訴你異常在哪個類、哪個方法、哪個行中被拋出。
如果你需要添加額外的信息,你應該將異常捕獲并包裝在自定義的的異常中,但要確保遵循下面的第9條實踐準則。
public void wrapException(String input) throws MyBusinessException { try { // do something } catch (NumberFormatException e) { throw new MyBusinessException("A message that describes the error.", e); } } |
9、包裝異常但不要丟棄原始異常
有時候將異常包裝成一個自定義異常會比捕捉一個標準異常要更好。一個典型的例子是應用或框架的特定業務異常。這允許你添加額外的信息,也能為你的異常類實現一個特定的處理方法。
當你這么做的時候,一定要確保原始的異常設為 cause 。 Exception 類提供了一系列的特定構造方法,這些方法可以接受 Throwable 作為參數(注:如Exception(String message, Throwable cause))。否則,你將會丟失原始異常的 stack trace 與信息,這會使你分析導致異常的事件變得十分困難。
public void wrapException(String input) throws MyBusinessException { try { // do something } catch (NumberFormatException e) { throw new MyBusinessException("A message that describes the error.", e); } } |
總結
如你所見,當決定該拋出還是捕獲異常時候,你需要去考慮很多方面。以上的大多數實踐準則都是為了提高你代碼和 API 的可讀性與可用性。
異常是不僅是一個錯誤處理機制,同時也是一個溝通媒介。因此,你應該與你的同事一起討論哪些是你想要應用的實踐與準則,以便所有人都能理解相關的基本概念,并用同樣的方式在實際中應用這些準則。
粵嵌科技創辦于2005年是一家IT高新技術企業,專注IT職業教育13年,主要培訓課程分別有嵌入式培訓、Java培訓、Unity游戲開發、Python人工智能、HTML5前端開發、全棧UI設計、網絡營銷、CCIE網絡等專業課程。