Java中處理異常的9個最佳實踐

Java中處理異常的9個最佳實踐
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語句，在 introduction to Java exception handling 中更詳細地說明了這一點。

如果你的資源實現了 AutoCloseable 接口，就可以使用它，這正是大多數Java標準資源所做的。當你在try子句中打開資源時，它將在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 ，避免拋出一個不具體的異常。

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. 使用描述性消息拋出異常
     這一最佳實踐的理念與前兩個相似。但這一次，你不用給調用方法的人提供信息。異常消息會被所有人讀取，同時必須瞭解在日誌文件或監視工具中報告異常時發生了什麼。

因此，應該儘可能準確地描述問題，並提供相關的信息來了解異常事件。

別誤會，你不需要寫一段文字，而是應該用1-2個簡短的句子解釋異常的原因。這可以幫助開發團隊理解問題的嚴重性，同時也使你能夠更容易地分析任何服務事件。

如果拋出一個特定的異常，它的類名很可能已經描述了這種類型的錯誤。所以，你不需要提供很多額外的信息。一個很好的例子就是，當你以錯誤的格式使用字符串時，如NumberFormatException，它就會被類 java.lang.Long的構造函數拋出。

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都可以幫助你做到這點，當你試圖捕獲不確定的異常時，它會報告一個不可到達的代碼塊。

問題是隻有第一個匹配到異常的catch語句纔會被執行，所以，如果你最先發現IllegalArgumentException，你將永遠不會到達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. 不要在catch中使用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!
}
}

7. 不要忽略Exceptions
   你是否曾經分析過只有用例的第一部分才被執行的bug報告嗎?

這通常是由一個被忽略的異常引起的。開發人員可能非常確信它不會被拋出，並添加一個無法處理或無法記錄它的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箇中所解釋的那樣，異常消息應該描述異常事件。堆棧會告訴你在哪個類、方法和行中異常被拋出。

如果你需要添加額外的信息，應該捕獲異常並將其包裝在一個自定義的信息中。但要確保遵循下面的第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. 包裝異常
   有時最好捕獲一個標準異常並將其封裝到一個定製的異常中。此類異常的典型例子是應用程序或框架特定的業務異常。這允許你添加額外的信息，並且也可以爲異常類實現一個特殊的處理。

當你這樣做時，確保引用原始的異常處理。Exception類提供了一些特定的構造函數方法，這些方法可以接受Throwable作爲參數。否則，你將丟失原始異常的堆棧跟蹤和消息，這將使你很難分析導致異常的事件。

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學習資料的也可以私信我！
祝關注我的人都：身體健康，財源廣進，福如東海,壽比南山，早生貴子，從不掉髮!