Java 處理 Exception 的 9 個最佳實踐!

2021-02-19 漫話編程

在Java中處理異常並不是一個簡單的事情。不僅僅初學者很難理解,即使一些有經驗的開發者也需要花費很多時間來思考如何處理異常,包括需要處理哪些異常,怎樣處理等等。這也是絕大多數開發團隊都會制定一些規則來規範對異常的處理的原因。而團隊之間的這些規範往往是截然不同的。

本文給出幾個被很多團隊使用的異常處理最佳實踐。

1. 在Finally塊中清理資源或者使用try-with-resource語句

當使用類似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);
}
}

上述代碼在沒有任何exception的時候運行是沒有問題的。但是當try塊中的語句拋出異常或者自己實現的代碼拋出異常,那麼就不會執行最後的關閉語句,從而資源也無法釋放。

合理的做法則是將所有清理的代碼都放到finally塊中或者使用try-with-resource語句。

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);
}
}
}
}

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. 指定具體的異常

儘可能的使用最具體的異常來聲明方法,這樣才能使得代碼更容易理解。

public void doNotDoThis() throws Exception {
...
}
public void doThis() throws NumberFormatException {
...
}

如上,NumberFormatException字面上即可以看出是數字格式化錯誤。

3. 對異常進行文檔說明

當在方法上聲明拋出異常時,也需要進行文檔說明。和前面的一點一樣,都是為了給調用者提供儘可能多的信息,從而可以更好地避免/處理異常。異常處理的 10 個最佳實踐,這篇也推薦看下。

在Javadoc中加入throws聲明,並且描述拋出異常的場景。

/**
* This method does something extremely useful ...
*
* @param input
* @throws MyBusinessException if ... happens
*/
public void doSomething(String input) throws MyBusinessException {
...
}

4. 拋出異常的時候包含描述信息

在拋出異常時,需要儘可能精確地描述問題和相關信息,這樣無論是列印到日誌中還是監控工具中,都能夠更容易被人閱讀,從而可以更好地定位具體錯誤信息、錯誤的嚴重程度等。

但這裡並不是說要對錯誤信息長篇大論,因為本來Exception的類名就能夠反映錯誤的原因,因此只需要用一到兩句話描述即可。

try {
new Long("xyz");
} catch (NumberFormatException e) {
log.error(e);
}

NumberFormatException即告訴了這個異常是格式化錯誤,異常的額外信息只需要提供這個錯誤字符串即可。當異常的名稱不夠明顯的時候,則需要提供儘可能具體的錯誤信息。

5. 首先捕獲最具體的異常

現在很多IDE都能智能提示這個最佳實踐,當你試圖首先捕獲最籠統的異常時,會提示不能達到的代碼。當有多個catch塊中,按照捕獲順序只有第一個匹配到的catch塊才能執行。因此,如果先捕獲IllegalArgumentException,那麼則無法運行到對NumberFormatException的捕獲。

public void catchMostSpecificExceptionFirst() {
try {
doSomething("A message");
} catch (NumberFormatException e) {
log.error(e);
} catch (IllegalArgumentException e) {
log.error(e)
}
}

6. 不要捕獲Throwable

Throwable是所有異常和錯誤的父類。你可以在catch語句中捕獲,但是永遠不要這麼做。如果catch了throwable,那麼不僅僅會捕獲所有exception,還會捕獲error。而error是表明無法恢復的jvm錯誤。因此除非絕對肯定能夠處理或者被要求處理error,不要捕獲throwable。

public void doNotCatchThrowable() {
try {
// do something
} catch (Throwable t) {
// don't do this!
}
}

7. 不要忽略異常

很多時候,開發者很有自信不會拋出異常,因此寫了一個catch塊,但是沒有做任何處理或者記錄日誌。

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)

如上所示,後面的日誌也沒有附加更有用的信息。如果想要提供更加有用的信息,那麼可以將異常包裝為自定義異常。

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有構造方法可以傳入cause)。否則,丟失了原始的異常信息會讓錯誤的分析變得困難。

public void wrapException(String input) throws MyBusinessException {
try {
// do something
} catch (NumberFormatException e) {
throw new MyBusinessException("A message that describes the error.", e);
}
}

總結

綜上可知,當拋出或者捕獲異常時,有很多不一樣的東西需要考慮。其中的許多點都是為了提升代碼的可閱讀性或者api的可用性。異常不僅僅是一個錯誤控制機制,也是一個溝通媒介,因此與你的協作者討論這些最佳實踐並制定一些規範能夠讓每個人都理解相關的通用概念並且能夠按照同樣的方式使用它們。


相關焦點

  • Java 處理 Exception 的 9 個最佳實踐
    best-practices-to-handle-exceptions-in-java 譯文:http://www.rowkey.me/blog/2017/09/17/java-exception/在Java中處理異常並不是一個簡單的事情。
  • Java處理Exception的9個最佳實踐
    不僅僅初學者很難理解,即使一些有經驗的開發者也需要花費很多時間來思考如何處理異常,包括需要處理哪些異常,怎樣處理等等。這也是絕大多數開發團隊都會制定一些規則來規範對異常的處理的原因。而團隊之間的這些規範往往是截然不同的。本文給出幾個被很多團隊使用的異常處理最佳實踐。1.
  • Java 中 9 個處理 Exception 的最佳實踐
    不僅僅初學者很難理解,即使一些有經驗的開發者也需要花費很多時間來思考如何處理異常,包括需要處理哪些異常,怎樣處理等等。這也是絕大多數開發團隊都會制定一些規則來規範對異常的處理的原因。而團隊之間的這些規範往往是截然不同的。本文給出幾個被很多團隊使用的異常處理最佳實踐。1.
  • 9 個 Java 處理 Exception 的最佳實踐!好用~
    這也是絕大多數開發團隊都會制定一些規則來規範對異常的處理的原因。而團隊之間的這些規範往往是截然不同的。本文給出幾個被很多團隊使用的異常處理最佳實踐。1.首先捕獲最具體的異常現在很多IDE都能智能提示這個最佳實踐,當你試圖首先捕獲最籠統的異常時,會提示*不能達到的代碼*。當有多個catch塊中,按照捕獲順序只有第一個匹配到的catch塊才能執行。
  • Java 中處理 Exception 的最佳實踐
    在Java中處理異常並不是一個簡單的事情。不僅僅初學者很難理解,即使一些有經驗的開發者也需要花費很多時間來思考如何處理異常,包括需要處理哪些異常,怎樣處理等等。這也是絕大多數開發團隊都會制定一些規則來規範對異常的處理的原因。而團隊之間的這些規範往往是截然不同的。本文給出幾個被很多團隊使用的異常處理最佳實踐。 1.
  • Java 處理 Exception 的 9 個最佳實踐,你做對了嗎?
    本文給出幾個被很多團隊使用的異常處理最佳實踐。1. 在Finally塊中清理資源或者使用try-with-resource語句當使用類似InputStream這種需要使用後關閉的資源時,一個常見的錯誤就是在try塊的最後關閉資源。
  • Java中異常處理的9個最佳實踐
    導致每個開發團隊都會自己定製一套特有的異常處理規則,這使得新加入團隊的成員都經歷一段痛苦的適應期。儘管如此,前輩們依然總結了幾個最佳實踐可以遵循,這些實踐被絕大多數的團隊所採用,本文將為你列出9個最常用且最重要的實踐來幫助你提升異常處理的技能。
  • Java 異常處理的 9 個最佳實踐
    所以很多開發團隊約定一些原則處理異常。如果你是一個團隊的新成員,你可能會很驚訝,因為他們約定的規則可能和你以前使用的規則不一樣。不過,有很多最佳實踐的規則,被大部分團隊接受。這裡有 9 大重要的約定,幫助你學習或者改進異常處理。
  • Java 如何優雅處理 Exception? 看完這 9 個示例你秒懂
    和前面的一點一樣,都是為了給調用者提供儘可能多的信息,從而可以更好地避免/處理異常。異常處理的 10 個最佳實踐,這篇也推薦看下。在Javadoc中加入throws聲明,並且描述拋出異常的場景。首先捕獲最具體的異常現在很多IDE都能智能提示這個最佳實踐,當你試圖首先捕獲最籠統的異常時,會提示不能達到的代碼。當有多個catch塊中,按照捕獲順序只有第一個匹配到的catch塊才能執行。因此,如果先捕獲IllegalArgumentException,那麼則無法運行到對NumberFormatException的捕獲。
  • 處理 Exception 的幾種實踐,很優雅,被很多團隊採納!
    本文給出幾個被很多團隊使用的異常處理最佳實踐。和前面的一點一樣,都是為了給調用者提供儘可能多的信息,從而可以更好地避免/處理異常。異常處理的 10 個最佳實踐,這篇也推薦看下。在Javadoc中加入throws聲明,並且描述拋出異常的場景。
  • 面試被問 Exception 的處理方法,有點懵了!
    這也是絕大多數開發團隊都會制定一些規則來規範對異常的處理的原因。而團隊之間的這些規範往往是截然不同的。本文給出幾個被很多團隊使用的異常處理最佳實踐。和前面的一點一樣,都是為了給調用者提供儘可能多的信息,從而可以更好地避免/處理異常。異常處理的 10 個最佳實踐,這篇也推薦看下。在Javadoc中加入throws聲明,並且描述拋出異常的場景。
  • java基礎:Error和Exception
    繼承關係如下圖所示:其實Error和Exception就是java語言設計Throwable時的兩個大的分類:Error一般是比較嚴重的問題,不應該被catch,比如出現了OutOfMemoryError,StackOverFlowError這些錯誤,程式設計師是無能為力的;而Exception是程式設計師可以幹預的,可以被catch。看下java源碼的注釋。
  • 編程思想之異常處理:C++、Java、JavaScript中的異常處理(Exception)
    當throw出的對象類型與e的類型相同時,則捕獲到異常,進行catch代碼塊中的異常處理。4.第二個catch括號中的」...」表示任意類型,可以捕獲任意類型的異常。假設有三個異常類,ExceptionC是ExceptionB的子類,ExceptionB是ExceptionA的子類,try...catch...就寫成:try{//可能拋出異常的語句}catch (ExceptionC c){//處理ExceptionC異常}catch (
  • Java 異常處理的十個建議
    前言Java異常處理的十個建議,希望對大家有幫助~本文已上傳github:https://github.com/whx123/JavaHome公眾號:撿田螺的小男孩一、儘量不要使用只要實現了java.lang.AutoCloseable接口或者java.io.Closeable接口的對象,都OK。
  • 十個 JDBC 的最佳實踐
    如有好文章投稿,請點擊 → 這裡了解詳情JDBC是Java為多種關係型資料庫提供的統一的訪問接口,以下是我長期使用JDBC總結的十個最佳實踐。使用ConnectionPool(連接池)使用連接池作為最佳實踐幾乎都成了公認的標準。一些框架已經提供了內建的連接池支持, 例如Spring中的Database Connection Pool,如果你的應用部署在JavaEE的應用伺服器中, 例如JBoss,WAS,這些伺服器也會有內建的連接池支持,例如DBCP。
  • IBM Cognos 11連結Hadoop最佳實踐
    大數據標誌著業務分析的新時代到來,各商業組織現在有機會就數據在容量、速度和多樣性的傳統處理能力不足問題上作出更加明智的決策。
  • Java的最佳實踐
    而 Java 事實上還算是一門不錯的語言,隨著 Java 8 最近的問世,我決定編制一個庫,實踐和工具的清單,匯集 Java 的一些最佳實踐。本文被放到了 Github 上。你可以隨意地提交貢獻,並加入自己的有關 Java 方面的建議和最佳實踐。
  • Android 存儲空間的最佳實踐 (上)
    分區存儲改變了應用在外置存儲中保存和訪問文件的方式,為了幫您遷移應用並支持分區存儲,我們概括了常見用例的最佳實踐並分享給大家。本文分為上下兩篇,分別為您介紹處理媒體文件和非媒體文件的用例和最佳實踐,供您參考。這部分內容描述了處理媒體文件 (如視頻、圖片、音頻文件) 的一些常見用例,並概要說明了應用可以使用的方法。
  • Java 性能優化之最佳實踐
    另外,我們還會介紹一些常見的 Java 代碼級優化以及編程的最佳實踐。最後,我將介紹 JVM和體系結構的特定調優方法,以提高 Java 應用程式的性能。當然,性能優化是一個很寬很廣的主題,這只是在 JVM 上探索一個起點。
  • Java異常處理和設計
    一個程序的異常處理框架的好壞直接影響到整個項目的代碼質量以及後期維護成本和難度。試想一下,如果一個項目從頭到尾沒有考慮過異常處理,當程序出錯從哪裡尋找出錯的根源?但是如果一個項目異常處理設計地過多,又會嚴重影響到代碼質量以及程序的性能。因此,如何高效簡潔地設計異常處理是一門藝術,本文下面先講述Java異常機制最基礎的知識,然後給出在進行Java異常處理設計時的幾個建議。