Java 異常處理的誤區和經驗總結

誤區一、異常的選擇

圖 1. 異常分類

圖 1 描述了異常的結構，其實我們都知道異常分檢測異常和非檢測異常，但是在實際中又混淆了這兩種異常的應用。由於非檢測異常使用方便，很多開發人員就認爲檢測異常沒什麼用處。其實異常的應用情景可以概括爲以下：

一、調用代碼不能繼續執行，需要立即終止。出現這種情況的可能性太多太多，例如服務器連接不上、參數不正確等。這些時候都適用非檢測異常，不需要調用代碼的顯式捕捉和處理，而且代碼簡潔明瞭。

二、調用代碼需要進一步處理和恢復。假如將 SQLException 定義爲非檢測異常，這樣操作數據時開發人員理所當然的認爲 SQLException 不需要調用代碼的顯式捕捉和處理，進而會導致嚴重的 Connection 不關閉、Transaction 不回滾、DB 中出現髒數據等情況，正因爲 SQLException 定義爲檢測異常，纔會驅使開發人員去顯式捕捉，並且在代碼產生異常後清理資源。當然清理資源後，可以繼續拋出非檢測異常，阻止程序的執行。根據觀察和理解，檢測異常大多可以應用於工具類中。

誤區二、將異常直接顯示在頁面或客戶端。

將異常直接打印在客戶端的例子屢見不鮮，以 JSP 爲例，一旦代碼運行出現異常，默認情況下容器將異常堆棧信息直接打印在頁面上。其實從客戶角度來說，任何異常都沒有實際意義，絕大多數的客戶也根本看不懂異常信息，軟件開發也要儘量避免將異常直接呈現給用戶。

清單 1

 package com.ibm.dw.sample.exception;
/**
 * 自定義 RuntimeException
 * 添加錯誤代碼屬性
 */
public class RuntimeException extends java.lang.RuntimeException { 
     //默認錯誤代碼 
    public static final Integer GENERIC = 1000000; 
    //錯誤代碼
    private Integer errorCode; 
     public RuntimeException(Integer errorCode, Throwable cause) {
            this(errorCode, null, cause);
     }
     public RuntimeException(String message, Throwable cause) {
            //利用通用錯誤代碼
            this(GENERIC, message, cause);
     }
     public RuntimeException(Integer errorCode, String message, Throwable cause) {
            super(message, cause);
            this.errorCode = errorCode;
     }
     public Integer getErrorCode() {
            return errorCode;
     } 
}

正如示例代碼所示，在異常中引入錯誤代碼，一旦出現異常，我們只要將異常的錯誤代碼呈現給用戶，或者將錯誤代碼轉換成更通俗易懂的提示。其實這裏的錯誤代碼還包含另外一個功能，開發人員亦可以根據錯誤代碼準確的知道了發生了什麼類型異常。

誤區三、對代碼層次結構的污染

我們經常將代碼分 Service、Business Logic、DAO 等不同的層次結構，DAO 層中會包含拋出異常的方法，如清單 2 所示：

清單 2

public Customer retrieveCustomerById(Long id) throw SQLException {
 //根據 ID 查詢數據庫
}

上面這段代碼咋一看沒什麼問題，但是從設計耦合角度仔細考慮一下，這裏的 SQLException 污染到了上層調用代碼，調用層需要顯式的利用 try-catch 捕捉，或者向更上層次進一步拋出。根據設計隔離原則，我們可以適當修改成：

清單 3

public Customer retrieveCustomerById(Long id) {
     try{
            //根據 ID 查詢數據庫
     }catch(SQLException e){
            //利用非檢測異常封裝檢測異常，降低層次耦合
            throw new RuntimeException(SQLErrorCode, e);
     }finally{
            //關閉連接，清理資源
     }
}

誤區四、忽略異常

如下異常處理只是將異常輸出到控制檯，沒有任何意義。而且這裏出現了異常並沒有中斷程序，進而調用代碼繼續執行，導致更多的異常。

清單 4

 public void retrieveObjectById(Long id){
   try{
       //..some code that throws SQLException
    }catch(SQLException ex){
     /**
       *瞭解的人都知道，這裏的異常打印毫無意義，僅僅是將錯誤堆棧輸出到控制檯。
       * 而在 Production 環境中，需要將錯誤堆棧輸出到日誌。
       * 而且這裏 catch 處理之後程序繼續執行，會導致進一步的問題*/

          ex.printStacktrace();
     }
}

可以重構成：

清單 5

public void retrieveObjectById(Long id){
 try{
    //..some code that throws SQLException
 }
 catch(SQLException ex){
    throw new RuntimeException(“Exception in retieveObjectById”, ex);
 }
 finally{
    //clean up resultset, statement, connection etc
 }
}

這個誤區比較基本，一般情況下都不會犯此低級錯誤。

誤區五、將異常包含在循環語句塊中

如下代碼所示，異常包含在 for 循環語句塊中。

清單 6

for(int i=0; i<100; i++){
    try{
    }catch(XXXException e){
         //….
    }
}

我們都知道異常處理佔用系統資源。一看，大家都認爲不會犯這樣的錯誤。換個角度，類 A 中執行了一段循環，循環中調用了 B 類的方法，B 類中被調用的方法卻又包含 try-catch 這樣的語句塊。褪去類的層次結構，代碼和上面如出一轍。

誤區六、利用 Exception 捕捉所有潛在的異常

一段方法執行過程中拋出了幾個不同類型的異常，爲了代碼簡潔，利用基類 Exception 捕捉所有潛在的異常，如下例所示：

清單 7

public void retrieveObjectById(Long id){
    try{
        //…拋出 IOException 的代碼調用
        //…拋出 SQLException 的代碼調用
    }catch(Exception e){
        //這裏利用基類 Exception 捕捉的所有潛在的異常，如果多個層次這樣捕捉，會丟失原始異常的有效信息
        throw new RuntimeException(“Exception in retieveObjectById”, e);
    }
}

可以重構成

清單 8

public void retrieveObjectById(Long id){
    try{
        //..some code that throws RuntimeException, IOException, SQLException
    }catch(IOException e){
        //僅僅捕捉 IOException
        throw new RuntimeException(/*指定這裏 IOException 對應的錯誤代碼*/code,“Exception in retieveObjectById”, e);
    }catch(SQLException e){
        //僅僅捕捉 SQLException
        throw new RuntimeException(/*指定這裏 SQLException 對應的錯誤代碼*/code,“Exception in retieveObjectById”, e);
    }
}

誤區七、多層次封裝拋出非檢測異常

如果我們一直堅持不同類型的異常一定用不同的捕捉語句，那大部分例子可以繞過這一節了。但是如果僅僅一段代碼調用會拋出一種以上的異常時，很多時候沒有必要每個不同類型的 Exception 寫一段 catch 語句，對於開發來說，任何一種異常都足夠說明了程序的具體問題。

清單 9

try{
    //可能拋出 RuntimeException、IOExeption 或者其它；
    //注意這裏和誤區六的區別，這裏是一段代碼拋出多種異常。以上是多段代碼，各自拋出不同的異常
}catch(Exception e){
    //一如既往的將 Exception 轉換成 RuntimeException，但是這裏的 e 其實是 RuntimeException 的實例，已經在前段代碼中封裝過
    throw new RuntimeException(/**/code, /**/, e);
}

如果我們如上例所示，將所有的 Exception 再轉換成 RuntimeException，那麼當 Exception 的類型已經是 RuntimeException 時，我們又做了一次封裝。將 RuntimeException 又重新封裝了一次，進而丟失了原有的 RuntimeException 攜帶的有效信息。

解決辦法是我們可以在 RuntimeException 類中添加相關的檢查，確認參數 Throwable 不是 RuntimeException 的實例。如果是，將拷貝相應的屬性到新建的實例上。或者用不同的 catch 語句塊捕捉 RuntimeException 和其它的 Exception。個人偏好方式一，好處不言而喻。

誤區八、多層次打印異常

我們先看一下下面的例子，定義了 2 個類 A 和 B。其中 A 類中調用了 B 類的代碼，並且 A 類和 B 類中都捕捉打印了異常。

清單 10

 public class A {
 private static Logger logger = LoggerFactory.getLogger(A.class);
 public void process(){
     try{
     //實例化 B 類，可以換成其它注入等方式
     B b = new B();
     b.process();
     //other code might cause exception
    } catch(XXXException e){
       //如果 B 類 process 方法拋出異常，異常會在 B 類中被打印，在這裏也會被打印，從而會打印 2 次
       logger.error(e);
       throw new RuntimeException(/* 錯誤代碼 */ errorCode, /*異常信息*/msg, e);
       }
    }
}
public class B{
 private static Logger logger = LoggerFactory.getLogger(B.class);
    public void process(){
        try{
            //可能拋出異常的代碼
        }
        catch(XXXException e){
            logger.error(e);
            throw new RuntimeException(/* 錯誤代碼 */ errorCode, /*異常信息*/msg, e);
        }
 }
}

同一段異常會被打印 2 次。如果層次再複雜一點，不去考慮打印日誌消耗的系統性能，僅僅在異常日誌中去定位異常具體的問題已經夠頭疼的了。

其實打印日誌只需要在代碼的最外層捕捉打印就可以了，異常打印也可以寫成 AOP，織入到框架的最外層。

誤區九、異常包含的信息不能充分定位問題

異常不僅要能夠讓開發人員知道哪裏出了問題，更多時候開發人員還需要知道是什麼原因導致的問題，我們知道 java .lang.Exception 有字符串類型參數的構造方法，這個字符串可以自定義成通俗易懂的提示信息。

簡單的自定義信息開發人員只能知道哪裏出現了異常，但是很多的情況下，開發人員更需要知道是什麼參數導致了這樣的異常。這個時候我們就需要將方法調用的參數信息追加到自定義信息中。下例只列舉了一個參數的情況，多個參數的情況下，可以單獨寫一個工具類組織這樣的字符串。

清單 11

public void retieveObjectById(Long id){
    try{
        //..some code that throws SQLException
   }catch(SQLException ex){
        //將參數信息添加到異常信息中
        throw new RuntimeException(“Exception in retieveObjectById with Object Id :”+ id, ex);
   }
}

誤區十、不能預知潛在的異常

在寫代碼的過程中，由於對調用代碼缺乏深層次的瞭解，不能準確判斷是否調用的代碼會產生異常，因而忽略處理。在產生了 Production Bug 之後纔想起來應該在某段代碼處添加異常補捉，甚至不能準確指出出現異常的原因。這就需要開發人員不僅知道自己在做什麼，而且要去儘可能的知道別人做了什麼，可能會導致什麼結果，從全局去考慮整個應用程序的處理過程。這些思想會影響我們對代碼的編寫和處理。

誤區十一、混用多種第三方日誌庫

現如今 Java 第三方日誌庫的種類越來越多，一個大項目中會引入各種各樣的框架，而這些框架又會依賴不同的日誌庫的實現。最麻煩的問題倒不是引入所有需要的這些日誌庫，問題在於引入的這些日誌庫之間本身不兼容。如果在項目初期可能還好解決，可以把所有代碼中的日誌庫根據需要重新引入一遍，或者換一套框架。但這樣的成本不是每個項目都承受的起的，而且越是隨着項目的進行，這種風險就越大。

怎麼樣纔能有效的避免類似的問題發生呢，現在的大多數框架已經考慮到了類似的問題，可以通過配置 Properties 或 xml 文件、參數或者運行時掃描 Lib 庫中的日誌實現類，真正在應用程序運行時才確定具體應用哪個特定的日誌庫。

其實根據不需要多層次打印日誌那條原則，我們就可以簡化很多原本調用日誌打印代碼的類。很多情況下，我們可以利用攔截器或者過濾器實現日誌的打印，降低代碼維護