Java中處理異常的9個最佳實踐,你必須要知道!

2021-12-28 程式設計師編程
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的可用性。異常不僅僅是一個錯誤控制機制,也是一個溝通媒介,因此與你的協作者討論這些最佳實踐並制定一些規範能夠讓每個人都理解相關的通用概念並且能夠按照同樣的方式使用它們。https://blog.csdn.net/oschina2017/article/details/79268255

獲取更多學習資料

視頻 | 面試 | 技術 | 電子書 

程式設計師編程:javaje

小編微信:BW22266688

相關焦點

  • Java 中處理異常的 9 個最佳實踐
    作者介紹了9個處理異常的最佳方法與實踐,以舉例與代碼展示結合的方式,讓開發者更好的理解這9種方式,並指導讀者在不同情況下選擇不同的異常處理方式。以下為譯文:Java中的異常處理不是一個簡單的話題。初學者很難理解,甚至有經驗的開發人員也會花幾個小時來討論應該如何拋出或處理這些異常。這就是為什麼大多數開發團隊都有自己的異常處理的規則和方法。如果你是一個團隊的新手,你可能會驚訝於這些方法與你之前使用過的那些方法有多麼不同。然而,有幾種異常處理的最佳方法被大多數開發團隊所使用。
  • Java 異常處理的 9 個最佳實踐
    在 Java 中處理異常並不是一件易事。新手覺得處理異常難以理解,甚至是資深開發者也會花上好幾個小時來討論是應該拋出拋異常還是處理異常。這就是為何大多數開發團隊都擁有一套自己的異常處理規範。如果你初進團隊,你也許會發現這些規範和你曾使用的規範大相逕庭。儘管如此,這裡還是有一些被大多數團隊所遵循的最佳實踐準則。
  • Java中處理異常的9條最佳實踐!快看你有沒有搞錯!
    Java中對於異常處理並不簡單。初學者很難去理解其中奧義,即使是有經驗的開發人員也可能會花幾個小時討論應該如何拋出或處理哪些異常。這就是為什麼大多數開發團隊對如何處理異常都會有自己的一套規則的原因。如果你是一個團隊中的新手,你可能會因這些規則和你以前使用過的有很大的不同而感到吃驚。不過,大多數團隊都會使用一些異常處理的最佳方法。
  • 9 個 Java 處理 Exception 的最佳實踐!好用~
    在Finally塊中清理資源或者使用try-with-resource語句在Java中處理異常並不是一個簡單的事情。不僅僅初學者很難理解,即使一些有經驗的開發者也需要花費很多時間來思考如何處理異常,包括需要處理哪些異常,怎樣處理等等。
  • 處理Java異常的10個最佳實踐
    在需要的地方聲明特定的受檢異常 public void foo() throws Exception { //錯誤做法  }一定要儘量避免上面的代碼,因為他的調用者完全不知道錯誤的原因到底是什麼。在方法聲明中,可以由方法拋出一些特定受檢異常。如果有多個,那就分別拋出多個,這樣這個方法的使用者才會分別針對每個異常做特定的處理,從而避免發生故障。
  • Java 中的異常和處理詳解
    這種行為叫做異常的冒泡,異常的冒泡是為了在當前發生異常的函數或者這個函數的caller中找到最近的異常處理程序。由於這個例子中沒有使用任何異常處理機制,因此異常最終由main函數拋給JRE,導致程序終止。上面的代碼不使用異常處理機制,也可以順利編譯,因為2個異常都是非檢查異常。但是下面的例子就必須使用異常處理機制,因為異常是檢查異常。
  • Java中的異常處理概念以及異常處理方法
    2、 沒有給對象開闢內存空間時會出現空指針異常(NullPointerException)。 3、 找不到文件異常(FileNotFoundException)。    所以在程序設計時,必須考慮到可能發生的異常事件,並做出相應的處理。這樣才能保證程序可以正常運行。 Java 的異常處理機制也秉承著面向對象的基本思想。
  • 基礎 | Java 中的異常捕獲及處理
    在程序中,錯誤可能產生於程式設計師沒有預料到的各種情況,或者超出程式設計師可控範圍的環境,例如用戶的壞數據、試圖 不存在的文件等。為了能夠及時有效地處理程序中的運行錯誤,Java 專門引入了異常類。Throwable 類是所有異常和錯誤的超類,下面有 Error 和 Exception 兩個子類分別表示錯誤和異常。
  • 你必須掌握的 21 個 Java 核心技術!
    為什麼強調要知道這個呢,知道了java最純粹的啟動方式之後,你才能在啟動出問題的時候,去分析當時啟動的目錄多少,執行命名如何,參數如何,是否有缺失等。這樣有利於你真正開發中去解決那些奇奇怪怪的可能和環境相關的問題。
  • 有效處理 Java 異常三原則
    異常之所以是一種強大的調試手段,在於其回答了以下三個問題:在有效使用異常的情況下,異常類型回答了「什麼」被拋出,異常堆棧跟蹤回答了「在哪「拋出,異常信息回答了「為什麼「會拋出,如果你的異常沒有回答以上全部問題,那麼可能你沒有很好地使用它們。
  • Java項目中常見的異常產生原因及處理辦法
    異常:直接派生自Exception的異常類,必須被捕獲或再次聲明拋出Runtime異常:派生自RuntimeException的異常類。但是如果字符型數據中包含了非數字型的字符,如123#56,此時轉換為數值型時就會出現異常。系統就會捕捉到這個異常,並進行處理。
  • Java異常面試問題
    java異常處理中使用了四個關鍵字。throw:有時我們明確要創建異常對象然後拋出它來停止程序的正常處理。throw關鍵字用於向運行時拋出異常來處理它。throws:當我們在方法中拋出任何已檢查的異常而不處理它時,我們需要在方法籤名中使用throws關鍵字讓調用者程序知道該方法可能拋出的異常。調用方法可以處理這些異常或使用throws關鍵字將其傳播給它的調用方法。我們可以在throws子句中提供多個異常,也可以與main()方法一起使用。try-catch:我們在代碼中使用try-catch塊進行異常處理。
  • Java異常的十大問題總結
    本文總結了有關Java異常的十大常見問題。1.已檢查與未檢查簡而言之,必須在方法中顯式捕獲已檢查的異常或在方法的throws子句中聲明該異常。未檢查的異常是由無法解決的問題引起的,例如被零除,空指針等。
  • Java字符串拼接效率分析及最佳實踐
    本文來源於問題 Java字符串連接最佳實踐? java連接字符串有多種方式,比如+操作符,StringBuilder.append方法,這些方法各有什麼優劣(可以適當說明各種方式的實現細節)? 按照高效的原則,那麼java中字符串連接的最佳實踐是什麼? 有關字符串處理,都有哪些其他的最佳實踐?
  • java NullPointerException異常處理
    java語言與其他程式語言不同,它有嚴格的異常處理機制,如果需要拋出異常的代碼塊中沒有捕獲異常,程序將不會成功編譯,換言之:未使用異常捕獲、異常捕獲方式不正確等,都將導致代碼不能被jvm編譯。java標準庫,內建了大量的異常處理類,這些類以Throwable 設計為最頂層類。
  • Java 異常處理的十個建議
    只要實現了java.lang.AutoCloseable接口或者java.io.Closeable接口的對象,都OK。雖然一個正常情況都不會發生的異常,但是如果你捕獲到它,就不要忽略呀,至少打個日誌吧~七、注意異常對你的代碼層次結構的侵染(早發現早處理)反例:public UserInfo queryUserInfoByUserId(Long userid) throw
  • Java 異常處理的 10 個良心建議!
    ");}try{ // do what you want }catch(Exception e){ log.info("你的程序有異常啦,{}",e);}反例中,並沒有把exception出來,到時候排查問題就不好查了啦,到底是SQl寫錯的異常還是IO異常,還是其他呢?
  • JAVA異常及其異常處理方式
    前言異常處理異常是程序中的一些錯誤,但並不是所有的錯誤都是異常比如說,你的代碼少了一個分號,那麼運行出來結果是提示是錯誤 java.lang.Error;如果你用System.out.println(100/0),那麼你是因為你用0做了除數,會拋出 java.lang.ArithmeticException 的異常。
  • 異常處理不規矩,線上定位bug兩行淚
    ", LOG_NAME);}很多程式設計師為了偷懶,用一個 大catch 蓋住所有異常,這是一個非常粗糙的異常處理,程序汪剛工作時很喜歡這樣寫代碼。寫代碼的人是爽了,可是定位線上問題的人就苦逼了。JAVA的良苦用心,儘量細化你的異常java運行時異常,RuntimeExecption在java.lang包下提供了大量類1、ClassCastException(類轉換異常)2、IndexOutOfBoundsException(數組越界)3、NullPointerException(空指針,最討厭的異常)
  • 兩萬字詳解Java異常,面試再也不怕被問到!
    在Java應用中,異常的處理機制分為聲明異常,拋出異常和捕獲異常。聲明異常通常,應該捕獲那些知道如何處理的異常,將不知道如何處理的異常繼續傳遞下去。傳遞異常可以在方法籤名處使用 throws 關鍵字聲明可能會拋出的異常。