教妹學 Java:異常實踐經驗
“三妹啊,今天我來給你傳授幾個異常處理的最佳實踐經驗,以免你以后在開發中采坑。”我面帶著微笑對三妹說。
“好啊,二哥,我洗耳恭聽。”三妹也微微一笑,欣然接受。
“好,那哥就不廢話了。開整。”
1)盡量不要捕獲 RuntimeException
阿里出品的嵩山版 Java 開發手冊上這樣規定:
盡量不要 catch RuntimeException,比如 NullPointerException、IndexOutOfBoundsException 等等,應該用預檢查的方式來規避。
正例:
- if (obj != null) {
- //...
- }
反例:
- try {
- obj.method();
- } catch (NullPointerException e) {
- //...
- }
“哦,那如果有些異常預檢查不出來呢?”三妹問。
“的確會存在這樣的情況,比如說 NumberFormatException,雖然也屬于 RuntimeException,但沒辦法預檢查,所以還是應該用 catch 捕獲處理。”我說。
2)盡量使用 try-with-resource 來關閉資源
當需要關閉資源時,盡量不要使用 try-catch-finally,禁止在 try 塊中直接關閉資源。
反例:
- public void doNotCloseResourceInTry() {
- FileInputStream inputStream = null;
- try {
- File file = new File("./tmp.txt");
- inputStream = new FileInputStream(file);
- inputStream.close();
- } catch (FileNotFoundException e) {
- log.error(e);
- } catch (IOException e) {
- log.error(e);
- }
- }
“為什么呢?”三妹問。
“原因也很簡單,因為一旦 close() 之前發生了異常,那么資源就無法關閉。直接使用 try-with-resource 來處理是最佳方式。”我說。
- public void automaticallyCloseResource() {
- File file = new File("./tmp.txt");
- try (FileInputStream inputStream = new FileInputStream(file);) {
- } catch (FileNotFoundException e) {
- log.error(e);
- } catch (IOException e) {
- log.error(e);
- }
- }
“除非資源沒有實現 AutoCloseable 接口。”我補充道。
“那這種情況下怎么辦呢?”三妹問。
“就在 finally 塊關閉流。”我說。
- public void closeResourceInFinally() {
- FileInputStream inputStream = null;
- try {
- File file = new File("./tmp.txt");
- inputStream = new FileInputStream(file);
- } catch (FileNotFoundException e) {
- log.error(e);
- } finally {
- if (inputStream != null) {
- try {
- inputStream.close();
- } catch (IOException e) {
- log.error(e);
- }
- }
- }
- }
3)不要捕獲 Throwable
Throwable 是 exception 和 error 的父類,如果在 catch 子句中捕獲了 Throwable,很可能把超出程序處理能力之外的錯誤也捕獲了。
- public void doNotCatchThrowable() {
- try {
- } catch (Throwable t) {
- // 不要這樣做
- }
- }
“到底為什么啊?”三妹問。
“因為有些 error 是不需要程序來處理,程序可能也處理不了,比如說 OutOfMemoryError 或者 StackOverflowError,前者是因為 Java 虛擬機無法申請到足夠的內存空間時出現的非正常的錯誤,后者是因為線程申請的棧深度超過了允許的最大深度出現的非正常錯誤,如果捕獲了,就掩蓋了程序應該被發現的嚴重錯誤。”我說。
“打個比方,一匹馬只能拉一車廂的貨物,拉兩車廂可能就掛了,但一 catch,就發現不了問題了。”我補充道。
4)不要省略異常信息的記錄
很多時候,由于疏忽大意,開發者很容易捕獲了異常卻沒有記錄異常信息,導致程序上線后真的出現了問題卻沒有記錄可查。
- public void doNotIgnoreExceptions() {
- try {
- } catch (NumberFormatException e) {
- // 沒有記錄異常
- }
- }
應該把錯誤信息記錄下來。
- public void logAnException() {
- try {
- } catch (NumberFormatException e) {
- log.error("哦,錯誤竟然發生了: " + e);
- }
- }
5)不要記錄了異常又拋出了異常
這純屬畫蛇添足,并且容易造成錯誤信息的混亂。
反例:
- try {
- } catch (NumberFormatException e) {
- log.error(e);
- throw e;
- }
要拋出就拋出,不要記錄,記錄了又拋出,等于多此一舉。
反例:
- public void wrapException(String input) throws MyBusinessException {
- try {
- } catch (NumberFormatException e) {
- throw new MyBusinessException("錯誤信息描述:", e);
- }
- }
這種也是一樣的道理,既然已經捕獲了,就不要在方法簽名上拋出了。
6)不要在 finally 塊中使用 return
阿里出品的嵩山版 Java 開發手冊上這樣規定:
try 塊中的 return 語句執行成功后,并不會馬上返回,而是繼續執行 finally 塊中的語句,如果 finally 塊中也存在 return 語句,那么 try 塊中的 return 就將被覆蓋。
反例:
- private int x = 0;
- public int checkReturn() {
- try {
- return ++x;
- } finally {
- return ++x;
- }
- }
“哦,確實啊,try 塊中 x 返回的值為 1,到了 finally 塊中就返回 2 了。”三妹說。
“是這樣的。”我點點頭。
“好了,三妹,關于異常處理實踐就先講這 6 條吧,實際開發中你還會碰到其他的一些坑,自己踩一踩可能印象更深刻一些。”我說。
“那萬一到時候我工作后被領導罵了怎么辦?”三妹委屈地說。
“新人嘛,總要寫幾個 bug 才能對得起新人這個稱號嘛。”我輕描淡寫地說。
“好吧。”三妹無奈地嘆了口氣。
本文轉載自微信公眾號「沉默王二」,可以通過以下二維碼關注。轉載本文請聯系沉默王二公眾號。