本文著重介紹了 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 捕捉所有潛在的異常,如下例所示:
#清單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 库中的日志实现类,真正在应用程序运行时才确定具体应用哪个特定的日志库。
其实根据不需要多层次打印日志那条原则,我们就可以简化很多原本调用日志打印代码的类。很多情况下,我们可以利用拦截器或者过滤器实现日志的打印,降低代码维护、迁移的成本。
以上是詳細介紹Java異常處理的誤解與經驗總結的詳細內容。更多資訊請關注PHP中文網其他相關文章!