Java9个异常处理的最佳实践
在本文中,作者介紹了9個(gè)處理異常的最佳方法與實(shí)踐,以舉例與代碼展示結(jié)合的方式,讓開發(fā)者更好的理解這9種方式,并指導(dǎo)讀者在不同情況下選擇不同的異常處理方式。
以下為譯文:
Java中的異常處理不是一個(gè)簡單的話題。初學(xué)者很難理解,甚至有經(jīng)驗(yàn)的開發(fā)人員也會花幾個(gè)小時(shí)來討論應(yīng)該如何拋出或處理這些異常。
這就是為什么大多數(shù)開發(fā)團(tuán)隊(duì)都有自己的異常處理的規(guī)則和方法。如果你是一個(gè)團(tuán)隊(duì)的新手,你可能會驚訝于這些方法與你之前使用過的那些方法有多么不同。
然而,有幾種異常處理的最佳方法被大多數(shù)開發(fā)團(tuán)隊(duì)所使用。下面是幫助改進(jìn)異常處理的9個(gè)最重要的方法。
1. 在Finally中清理資源或者使用Try-With-Resource語句
通常情況下,你在try中使用了一個(gè)資源,比如InputStream,之后需要關(guān)閉它。在這種情況下,一個(gè)常見的錯(cuò)誤是在try的末尾關(guān)閉了資源。
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | 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); ????} } |
問題是,只要不拋出異常,這種方法就可以很好地運(yùn)行。try內(nèi)的所有語句都將被執(zhí)行,資源也會被關(guān)閉。
但是你在try里調(diào)用了一個(gè)或多個(gè)可能拋出異常的方法,或者自己拋出異常。這意味著可能無法到達(dá)try的末尾。因此,將不會關(guān)閉這些資源。
所以應(yīng)該將清理資源的代碼放入Finally中,或者使用Try-With-Resource語句。
使用Finally
相比于try,無論是在成功執(zhí)行try里的代碼后,或是在catch中處理了一個(gè)異常后,Finally里的內(nèi)容是一定會被執(zhí)行的。因此,可以確保清理所有已打開的資源。
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | 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語句
另一個(gè)選擇是Try-With-Resource語句,在introduction to Java exception handling中更詳細(xì)地說明了這一點(diǎn)。
如果你的資源實(shí)現(xiàn)了AutoCloseable接口,就可以使用它,這正是大多數(shù)Java標(biāo)準(zhǔn)資源所做的。當(dāng)你在try子句中打開資源時(shí),它將在try被執(zhí)行后自動(dòng)關(guān)閉,或者處理一個(gè)異常。
| 1 2 3 4 5 6 7 8 9 10 | 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. 給出準(zhǔn)確的異常處理信息
你拋出的異常越具體越好。一定要記住,一個(gè)不太了解你代碼的同事,也許幾個(gè)月后,需要調(diào)用你的方法,并且處理這個(gè)異常。
因此,請確保提供盡可能多的信息,這會使你的API更容易理解。因此,你方法的調(diào)用者將能夠更好地處理異常,或者通過額外的檢查來避免它。
所以,要盡量能更好地描述你的異常處理信息,比如用NumberFormatException代替IllegalArgumentException,避免拋出一個(gè)不具體的異常。
| 1 2 3 4 5 6 | public void doNotDoThis() throws Exception { ????... } public void doThis() throws NumberFormatException { ????... } |
3. 記錄你所指定的異常
當(dāng)你在方法中指定一個(gè)異常時(shí),你應(yīng)該在Javadoc中記錄下它。這與前面提到的方法有著相同的目標(biāo):為調(diào)用者提供盡可能多的信息,這樣他們就可以避免異常或者更容易地處理異常。
因此,請確保在Javadoc中添加一個(gè)@throws 聲明,并描述可能導(dǎo)致的異常情況。
| 1 2 3 4 5 6 7 8 9 | /** ?* This method does something extremely useful ... ?* ?* @param input ?* @throws MyBusinessException if ... happens ?*/ public void doSomething(String input) throws MyBusinessException { ????... } |
4. 使用描述性消息拋出異常
這一最佳實(shí)踐的理念與前兩個(gè)相似。但這一次,你不用給調(diào)用方法的人提供信息。異常消息會被所有人讀取,同時(shí)必須了解在日志文件或監(jiān)視工具中報(bào)告異常時(shí)發(fā)生了什么。
因此,應(yīng)該盡可能準(zhǔn)確地描述問題,并提供相關(guān)的信息來了解異常事件。
別誤會,你不需要寫一段文字,而是應(yīng)該用1-2個(gè)簡短的句子解釋異常的原因。這可以幫助開發(fā)團(tuán)隊(duì)理解問題的嚴(yán)重性,同時(shí)也使你能夠更容易地分析任何服務(wù)事件。
如果拋出一個(gè)特定的異常,它的類名很可能已經(jīng)描述了這種類型的錯(cuò)誤。所以,你不需要提供很多額外的信息。一個(gè)很好的例子就是,當(dāng)你以錯(cuò)誤的格式使用字符串時(shí),如NumberFormatException,它就會被類 java.lang.Long的構(gòu)造函數(shù)拋出。
| 1 2 3 4 5 | try { ????new Long("xyz"); } catch (NumberFormatException e) { ????log.error(e); } |
NumberFormatException已經(jīng)告訴你問題的類型,所以只需要提供導(dǎo)致問題的輸入字符串。如果異常類的名稱不具有表達(dá)性,那么就需要提供必要的解釋信息。
| 1 | 17:17:26,386 ERROR TestExceptionHandling:52 - java.lang.NumberFormatException: For input string: "xyz" |
5. 最先捕獲特定的異常
大多數(shù)IDE都可以幫助你做到這點(diǎn),當(dāng)你試圖捕獲不確定的異常時(shí),它會報(bào)告一個(gè)不可到達(dá)的代碼塊。
問題是只有第一個(gè)匹配到異常的catch語句才會被執(zhí)行,所以,如果你最先發(fā)現(xiàn)IllegalArgumentException,你將永遠(yuǎn)不會到達(dá)catch里處理更具體的NumberFormatException,因?yàn)樗荌llegalArgumentException的一個(gè)子類。
所以要首先捕獲特定的異常類,并在末尾添加一些處理不是很具體異常的catch語句。
你可以在下面的代碼片段中看到這樣一個(gè)try-catch語句的示例。第一個(gè)catch處理所有NumberFormatExceptions異常,第二個(gè)catch 處理NumberFormatException異常以外的illegalargumentexception異常。
| 1 2 3 4 5 6 7 8 9 | public void catchMostSpecificExceptionFirst() { ????try { ????????doSomething("A message"); ????} catch (NumberFormatException e) { ????????log.error(e); ????} catch (IllegalArgumentException e) { ????????log.error(e) ????} } |
6. 不要在catch中使用Throwable
Throwable是exceptions 和 errors的父類。當(dāng)然,你可以在catch子句中使用它,但其實(shí)你不應(yīng)該這樣做。
如果你在catch子句中使用Throwable,它將不僅捕獲所有的異常,還會捕獲所有錯(cuò)誤。JVM會拋出錯(cuò)誤,這是應(yīng)用程序不打算處理的嚴(yán)重問題。典型的例子是OutOfMemoryError或StackOverflowError。這兩種情況都是由應(yīng)用程序控制之外的情況引起的,無法處理。
所以,最好不要在catch中使用Throwable,除非你完全確定自己處于一個(gè)特殊的情況下,并且你需要處理一個(gè)錯(cuò)誤。
| 1 2 3 4 5 6 7 | public void doNotCatchThrowable() { ????try { ????????// do something ????} catch (Throwable t) { ????????// don't do this! ????} } |
7. 不要忽略Exceptions
你是否曾經(jīng)分析過只有用例的第一部分才被執(zhí)行的bug報(bào)告嗎?
這通常是由一個(gè)被忽略的異常引起的。開發(fā)人員可能非常確信它不會被拋出,并添加一個(gè)無法處理或無法記錄它的catch語句。當(dāng)你發(fā)現(xiàn)它的時(shí)候,你很可能就會明白一句著名的話“This will never happen”。
| 1 2 3 4 5 6 7 | public void doNotIgnoreExceptions() { ????try { ????????// do something ????} catch (NumberFormatException e) { ????????// this will never happen ????} } |
是的,你可能在分析一個(gè)不可能發(fā)生的問題。
所以,請千萬不要忽略一個(gè)例外。你不會知道代碼在將來會發(fā)生什么變化。有些人可能會刪除阻止異常事件的驗(yàn)證,而沒有意識到這造成了問題。或者拋出異常的代碼被更改,現(xiàn)在拋出了同一個(gè)類的多個(gè)異常,而調(diào)用的代碼并不能阻止所有這些異常。
你至少應(yīng)該寫一個(gè)日志信息,告訴每個(gè)人,需要檢查一下這個(gè)問題。
| 1 2 3 4 5 6 7 | public void logAnException() { ????try { ????????// do something ????} catch (NumberFormatException e) { ????????log.error("This should never happen: " + e); ????} } |
8. 不要記錄和拋出一個(gè)異常
這可能是最常被忽略的。你可以在許多代碼片段或者庫文件里發(fā)現(xiàn),有異常會被捕獲、記錄和重新拋出。
| 1 2 3 4 5 6 | try { ????new Long("xyz"); } catch (NumberFormatException e) { ????log.error(e); ????throw e; } |
當(dāng)它發(fā)生時(shí)記錄一個(gè)異常,然后重新拋出它,以便調(diào)用者能夠適當(dāng)?shù)靥幚硭?#xff0c;這可能會很直觀。但是它會為同一個(gè)異常寫多個(gè)錯(cuò)誤消息。
| 1 2 3 4 5 6 7 | 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個(gè)中所解釋的那樣,異常消息應(yīng)該描述異常事件。堆棧會告訴你在哪個(gè)類、方法和行中異常被拋出。
如果你需要添加額外的信息,應(yīng)該捕獲異常并將其包裝在一個(gè)自定義的信息中。但要確保遵循下面的第9條。
| 1 2 3 4 5 6 7 | public void wrapException(String input) throws MyBusinessException { ????try { ????????// do something ????} catch (NumberFormatException e) { ????????throw new MyBusinessException("A message that describes the error.", e); ????} } |
因此,只需要捕獲一個(gè)你想要處理的異常,在方法中指定它,并讓調(diào)用者處理它。
9. 包裝異常
有時(shí)最好捕獲一個(gè)標(biāo)準(zhǔn)異常并將其封裝到一個(gè)定制的異常中。此類異常的典型例子是應(yīng)用程序或框架特定的業(yè)務(wù)異常。這允許你添加額外的信息,并且也可以為異常類實(shí)現(xiàn)一個(gè)特殊的處理。
當(dāng)你這樣做時(shí),確保引用原始的異常處理。Exception類提供了一些特定的構(gòu)造函數(shù)方法,這些方法可以接受Throwable作為參數(shù)。否則,你將丟失原始異常的堆棧跟蹤和消息,這將使你很難分析導(dǎo)致異常的事件。
| 1 2 3 4 5 6 7 | public void wrapException(String input) throws MyBusinessException { ????try { ????????// do something ????} catch (NumberFormatException e) { ????????throw new MyBusinessException("A message that describes the error.", e); ????} } |
為了讓學(xué)習(xí)變得輕松、高效,今天給大家免費(fèi)分享一套Java入門教學(xué)資源。幫助大家在成為Java架構(gòu)師的道路上披荊斬棘。需要資料的歡迎加入學(xué)習(xí)交流群:9285,05736
總結(jié)
以上是生活随笔為你收集整理的Java9个异常处理的最佳实践的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Java学习路线,你值得了解
- 下一篇: 曾辉机器人_武昌理工学子在2020年中国