大多數(shù)團(tuán)隊(duì)都使用了幾種最佳實(shí)踐。以下是幫助你入門或改進(jìn)異常處理的9個(gè)最重要的內(nèi)容。

1.在finally塊中清理資源或使用Try-With-Resource語句

在try塊中使用資源是很頻繁的，比如InputStream，之后需要關(guān)閉它。這些情況中的一個(gè)常見錯(cuò)誤是在try塊結(jié)束時(shí)關(guān)閉資源。

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塊中的所有語句都將被執(zhí)行，資源將被關(guān)閉。

但是你添加了try塊是有原因的。你調(diào)用一個(gè)或多個(gè)可能拋出異常的方法，或者你自己拋出異常。這意味著你可能無法到達(dá)try塊的末尾。因此，你將不會(huì)關(guān)閉資源。

因此，你應(yīng)該將所有清理代碼放入finally塊或使用try-with-resource語句。

使用Finally塊

與try塊的最后幾行相比，finally塊始終執(zhí)行。這可以在成功執(zhí)行try塊之后或在catch塊中處理異常之后發(fā)生。因此，你可以確保清理所有已打開的資源。

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異常處理的介紹中對(duì)此進(jìn)行了更詳細(xì)的解釋。

如果資源實(shí)現(xiàn)AutoCloseable接口，則可以使用它。這就是大多數(shù)Java標(biāo)準(zhǔn)資源所做的事情。當(dāng)你在try子句中打開資源時(shí)，它將在try塊執(zhí)行后自動(dòng)關(guān)閉，或者處理異常。

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.特定異常

拋出的異常越具體越好。請(qǐng)記住，不明白你代碼的同事，或者你可能在幾個(gè)月后需要調(diào)用你的方法并處理異常。

因此，請(qǐng)務(wù)必提供盡可能多的信息。這使你的API更易于理解。因此，你的方法的調(diào)用者將能夠更好地處理異?；蛲ㄟ^額外的檢查來避免它。

因此，總是嘗試找到最適合你的異常事件的類，例如拋出NumberFormatException而不是IllegalArgumentException。并避免拋出非特定的異常。

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

3.記錄你聲明的異常

無論何時(shí)在方法簽名中指定異常，都應(yīng)該在Javadoc中記錄它。這與以前的最佳實(shí)踐具有相同的目標(biāo)：為調(diào)用者提供盡可能多的信息，以便他可以避免或處理異常。

因此，請(qǐng)確保向Javadoc 添加@throws聲明并描述可能導(dǎo)致異常的情況。

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

4.使用描述信息拋出異常

這種最佳實(shí)踐背后的想法類似于前兩種實(shí)踐。但是這次，你不向調(diào)用方提供有關(guān)方法的信息。每個(gè)必須了解在日志文件或監(jiān)視工具中拋出異常時(shí)發(fā)生了什么的人都會(huì)讀取異常的消息。

因此，它應(yīng)該盡可能準(zhǔn)確地描述問題，并提供最相關(guān)的信息來理解異常事件。

別誤會(huì)我的意思; 你不應(yīng)該寫一段文字。但是你應(yīng)該用1-2個(gè)簡短的句子來解釋這個(gè)例外的原因。這有助于你的運(yùn)營團(tuán)隊(duì)了解問題的嚴(yán)重性，還可以讓你更輕松地分析任何服務(wù)事件。

如果拋出一個(gè)特定的異常，它的類名很可能已經(jīng)描述了那種錯(cuò)誤。因此，你無需提供大量其他信息。一個(gè)很好的例子是NumberFormatException。它會(huì)被類java.lang.Long的構(gòu)造函數(shù)拋出，當(dāng)你以錯(cuò)誤的格式提供String參數(shù)。

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

NumberFormatException類的名稱已經(jīng)告訴你問題的類型。它的消息只需要提供導(dǎo)致問題的輸入字符串。如果異常類的名稱不具有表現(xiàn)力，則需要在消息中提供所需的信息。

17:17:26,386 ERROR TestExceptionHandling:52 - java.lang.NumberFormatException: For input string: "xyz"

5.優(yōu)先捕獲最具體的異常

大多數(shù)IDE都可以幫助你實(shí)現(xiàn)這一最佳實(shí)踐。當(dāng)你嘗試首先捕獲不太具體的異常時(shí)，它們提示無法訪問的代碼塊。

問題是只有匹配異常的第一個(gè)catch塊才會(huì)被執(zhí)行。因此，如果首先捕獲IllegalArgumentException，則永遠(yuǎn)不會(huì)到達(dá)應(yīng)該處理更具體的NumberFormatException的catch塊，因?yàn)樗荌llegalArgumentException的子類。

始終優(yōu)先捕獲最具體的異常類，并將不太具體的catch塊添加到列表的末尾。

你可以在以下代碼段中看到此類try-catch語句的示例。第一個(gè)catch塊處理所有的NumberFormatException，第二個(gè)處理所有不是NumberFormatException的IllegalArgumentException 異常。

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

6.Don't Catch Throwable

Throwable是所有異常和錯(cuò)誤的超類。你可以在catch子句中使用它，但你永遠(yuǎn)不應(yīng)該這樣做！

如果在catch子句中使用Throwable，它不僅會(huì)捕獲所有異常; 它還會(huì)捕獲所有錯(cuò)誤。JVM拋出錯(cuò)誤以指示應(yīng)用程序無法處理的嚴(yán)重問題。典型的例子是OutOfMemoryError或StackOverflowError。兩者都是由應(yīng)用程序無法控制的情況引起的，無法處理。

所以，最好不要抓住Throwable，除非你完全確定你處于一個(gè)特殊情況，你可以或者需要處理錯(cuò)誤。

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

7.Don't Ignore Exceptions

你是否曾經(jīng)分析過只有用例第一部分被執(zhí)行的錯(cuò)誤報(bào)告？

這通常是由忽略的異常引起的。開發(fā)人員可能非常確定它永遠(yuǎn)不會(huì)被拋出并添加了一個(gè)不處理或記錄它的catch塊。當(dāng)你找到這個(gè)代碼塊時(shí)，你很可能甚至?xí)l(fā)現(xiàn)一個(gè)著名的“This will never happen

”的評(píng)論。

public void doNotIgnoreExceptions() {
 try {
 // do something
 } catch (NumberFormatException e) {
 // this will never happen
 }
}

好吧，你可能正在分析一個(gè)不可能發(fā)生的問題。

所以，請(qǐng)永遠(yuǎn)不要忽視異常。你不知道代碼將來會(huì)如何變化。有人可能會(huì)刪除阻止異常事件的驗(yàn)證而不會(huì)認(rèn)識(shí)到這會(huì)產(chǎn)生問題。或者拋出異常的代碼會(huì)被更改，現(xiàn)在拋出同一個(gè)類的多個(gè)異常，并且調(diào)用代碼不會(huì)阻止所有這些異常。

你至少應(yīng)該寫一條日志消息，告訴大家不可思議的事情剛剛發(fā)生，而且有人需要檢查它。

public void logAnException() {
 try {
 // do something
 } catch (NumberFormatException e) {
 log.error("This should never happen: " + e);
 }
}

8.Don't Log and Throw

這可能是此列表中最常被忽略的最佳做法。你可以找到許多代碼片段，甚至是catch，log和重新throw異常的庫。

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

在發(fā)生異常時(shí)記錄異?？赡軙?huì)感覺很直接，然后重新拋出它以便調(diào)用者可以適當(dāng)?shù)靥幚硭?。但它?huì)為同一個(gè)異常寫出多條錯(cuò)誤消息。

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)

其他消息也不添加任何信息。如最佳實(shí)踐＃4中所述，異常消息應(yīng)描述異常事件。堆棧跟蹤告訴你拋出異常的類，方法和行。

如果需要添加其他信息，則應(yīng)捕獲異常并將其包裝在自定義異常中。但請(qǐng)務(wù)必遵循最佳做法9。

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

因此，如果你想要處理它，只捕獲異常。否則，在方法簽名中指定它并讓調(diào)用者處理它。

9.在沒有消費(fèi)的情況下包裝異常

有時(shí)候捕獲標(biāo)準(zhǔn)異常并將其包裝成自定義異常會(huì)更好。此類異常的典型示例是應(yīng)用程序或框架特定的業(yè)務(wù)異常。這允許你添加其他信息，還可以為異常類實(shí)現(xiàn)特殊處理。

執(zhí)行此操作時(shí)，請(qǐng)確保將原始異常設(shè)置為cause。該異常類提供了接受一個(gè)特定的構(gòu)造方法的Throwable作為參數(shù)。否則，你將丟失原始異常的堆棧跟蹤和消息，這將導(dǎo)致難以分析導(dǎo)致異常的異常事件。

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

總結(jié)

正如所看到的，當(dāng)你拋出或捕獲異常時(shí)，你應(yīng)該考慮許多不同的事情。其中大多數(shù)都旨在提高代碼的可讀性或API的可用性。

異常通常同時(shí)是錯(cuò)誤處理機(jī)制和通信媒介。因此，您應(yīng)該確保與同事討論要應(yīng)用的最佳實(shí)踐和規(guī)則，以便每個(gè)人都能理解通用概念并以相同的方式使用它們。

以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論