|
Exception 處理之最佳實踐
原文：http://www.onjava.com/pub/a/onjava/2003/11/19/exceptions.html
作者：Gunjan Doshi 2003-11-19 譯者注：本文算是一篇學習筆記，僅供學習參考使用，有不妥之處，還請指出。2003-12-04
“本文是Exception處理的一篇不錯的文章，從Java Exception的概念介紹起，依次講解了Exception的類型（Checked/Unchecked），Exception處理的最佳實現： 1． 選擇Checked還是Unchecked的幾個經典依據 2． Exception的封裝問題 3． 如無必要不要創建自己得Exception 4． 不要用Exception來作流程控制 5． 不要輕易的忽略捕獲的Except ion 6． 不要簡單地捕獲頂層的Exception” ——選自JAVADigest.Net對原文的介紹
“JAVADigest.Net這個站點不知道大家是否經常上，就像它的名字一樣，它讓我們更加有效的消化Java，或者它就像箇中轉站一樣，至少對我是這樣的，有些好的可以說是非常經典的技術文章，我都是通過它第一次獲得，更多的時候我是爲了偷懶才上JAVADigest.Net，因爲如果是近期比較經典的文章，它上邊都有介紹文字和原文連接。” ——小插曲並非常榮幸地推薦JAVADigest.Net給你
關於異常處理的一個問題就是要對何時（when）和如何（how）使用它們做到瞭然於心。在本文中我將介紹一些關於異常處理的最佳實踐，同時我也會涉及到最近爭論十分激烈的checked Exception的使用問題。 作爲開發員，我們都希望能寫出解決問題並且是高質量的代碼。不幸的是，一些副作用（side effects）伴隨着異常在我們的代碼中慢慢滋生。無庸置疑，沒有人喜歡副作用（side effects）,所以我們很快就用我們自己的方式來避免它，我曾經看到一些聰明的程序員用下面的方式來處理異常：
上邊的代碼有什麼問題麼？
在回答以前讓我們想想怎樣纔是正確的？是的，一旦程序碰到異常，它就該掛起程序而“做”點什麼。那麼上邊的代碼是這樣子的麼？看吧，它隱瞞了什麼？它把所有的“苦水”往肚裏咽（在控制檯打印出異常信息），然後一切繼續，從表面上看就像什麼都沒有發生過一樣……，很顯然，上邊代碼達到的效果並不是我們所期望的。
後來又怎樣？
上邊的代碼又有什麼問題？
很明顯，上邊的方法體是空的，它不實現任何的功能（沒有一句代碼），試問一個空方法體能拋出什麼異常？當然Java並不阻止你這麼幹。最近，我也遇到類似的情景，方法聲明會拋出異常，但是代碼中並沒有任何“機會”來“展示”異常。當我問開發員爲什麼要這樣做的時候，他回答我說“我知道，它確實有點那個，但我以前就是這麼幹的並且它確實能爲我工作。”
在C++社區曾經花了數年實踐來實踐如何使用異常，關於此類的爭論在java社區纔剛剛開始。我曾經看到許多Java程序員針對使用異常的問題進行爭論。如果對於異常處理不當的話，異常可以大大減慢應用程序的執行速度，因爲它將消耗內存和CPU來創建、拋出並捕獲異常。如果過分的依賴異常處理，代碼對易讀和易使用這兩方面產生影響，以至於會讓我們寫出上邊兩處“糟糕”代碼。
異常原理
大體上說，有三種不同的“情景”會導致異常的拋出： l & #160; 編程錯誤導致異常（Exception due Programming errors）: 這種情景下，異常往往處於編程錯誤（如：NullPointerException 或者 IllegalArgumentException）,這時異常一旦拋出，客戶端將變得無能爲力。 l 客戶端代碼錯誤導致異常（Exception due client code errors）: 說白點就是客戶端試圖調用API不允許的操作。 l 資源失敗導致異常（Exception due to resource failures）: 如內存不足或網絡連接失敗導致出現異常等。這些異常的出現客戶端可以採取相應的措施來恢復應用程序的繼續運行。
Java中異常的類型
Java 中定義了兩類異常： l Checked exception: 這類異常都是Exception的子類 l Unchecked exception: 這類異常都是RuntimeException的子類，雖然RuntimeException同樣也是Exception的子類，但是它們是特殊的，它們不能通過client code來試圖解決，所以稱爲Unchecked exception 舉個例子，下圖爲NullPointerException的繼承關係：
Figure 1. Sample exception hierarchy
圖中，NullPointerException繼承自RuntimeException，所以它是Unchecked exception.
以往我都是應用checked exception多於Unchecked exception，最近，在java社區激起了一場關於checked exception和使用它們的價值的爭論。這場爭論起源於JAVA是第一個擁有Checked exception的主流OO語言這樣一個事實，而C++和C#都是根本沒有Checked exception，它們所有的異常都是unchecked。
一個checked exception強迫它的客戶端可以拋出並捕獲它，一旦客戶端不能有效地處理這些被拋出的異常就會給程序的執行帶來不期望的負擔。
Checked exception還可能帶來封裝泄漏，看下面的代碼：
上邊的方法拋出兩個異常。客戶端必須顯示的對這兩種異常進行捕獲和處理即使是在完全不知道這種異常到底是因爲文件還是數據庫操作引起的情況下。因此，此時的異常處理將導致一種方法和調用之間不合適的耦合。
接下來我會給出幾種設計異常的最佳實踐 （ Best Practises for Designing the API）
1． 當要決定是採用checked exception還是Unchecked exception的時候，你要問自己一個問題，“如果這種異常一旦拋出，客戶端會做怎樣的補救？” [原文：When deciding on checked exceptions vs. unchecked exceptions, ask yourself, "What action can the client code take when the exception occurs?"] 如果客戶端可以通過其他的方法恢復異常，那麼這種異常就是checked exception；如果客戶端對出現的這種異常無能爲力，那麼這種異常就是Unchecked exception；從使用上講，當異常出現的時候要做一些試圖恢復它的動作而不要僅僅的打印它的信息，總來的來說，看下錶：
此外，儘量使用unchecked exception來處理編程錯誤：因爲unchecked exception不用使客戶端代碼顯示的處理它們，它們自己會在出現的地方掛起程序並打印出異常信息。Java API中提供了豐富的unchecked excetpion，譬如：NullPointerException , IllegalArgumentException 和 IllegalStateException等，因此我一般使用這些標準的異常類而不願親自創建新的異常類，這樣使我的代碼易於理解並避免的過多的消耗內存。
2． 保護封裝性（Preserve encapsulation）
不要讓你要拋出的checked exception升級到較高的層次。例如，不要讓SQLException延伸到業務層。業務層並不需要（不關心？）SQLException。你有兩種方法來解決這種問題： l 轉變SQLException爲另外一個checked exception，如果客戶端並不需要恢復這種異常的話； l 轉變SQLException爲一個unchecked exception，如果客戶端對這種異常無能爲力的話； 多數情況下，客戶端代碼都是對SQLException無能爲力的，因此你要毫不猶豫的把它轉變爲一個unchecked exception，看看下邊的代碼：
上邊的catch塊緊緊打印異常信息而沒有任何的直接操作，這是情有可原的，因爲對於SQLException你還奢望客戶端做些什麼呢？（但是顯然這種就象什麼事情都沒發生一樣的做法是不可取的）那麼有沒有另外一種更加可行的方法呢？
|
||||||||||
|
上邊的做法是把SQLException轉換爲RuntimeException，一旦SQLException被拋出，那麼程序將拋出RuntimeException,此時程序被掛起並返回客戶端異常信息。
如果你有足夠的信心恢復它當SQLException被拋出的時候，那麼你也可以把它轉換爲一個有意義的checked exception, 但是我發現在大多時候拋出RuntimeException已經足夠用了。
3． 不要創建沒有意義的異常（Try not to create new custom exceptions if they do not have useful information for client code.）
看看下面的代碼有什麼問題？
|
它除了有一個“意義明確”的名字以外沒有任何有用的信息了。不要忘記Exception跟其他的Java類一樣，客戶端可以調用其中的方法來得到更多的信息。
我們可以爲其添加一些必要的方法，如下：
|
在新的代碼中有兩個有用的方法：reqeuestedUsername(),客戶但可以通過它得到請求的名稱；availableNames(),客戶端可以通過它得到一組有用的usernames。這樣客戶端在得到其返回的信息來明確自己的操作失敗的原因。但是如果你不想添加更多的信息，那麼你可以拋出一個標準的Exception:
|
更甚的情況，如果你認爲客戶端並不想用過多的操作而僅僅想看到異常信息，你可以拋出一個unchecked exception:
|
另外，你可以提供一個方法來驗證該username是否被佔用。
很有必要再重申一下，checked exception應該讓客戶端從中得到豐富的信息。要想讓你的代碼更加易讀，請傾向於用unchecked excetpion來處理程序中的錯誤（Prefer unchecked exceptions for all programmatic errors）。
&# 160;
4． Document exceptions.
你可以通過Javadoc’s @throws 標籤來說明（document）你的API中要拋出checked exception或者unchecked exception。然而，我更傾向於使用來單元測試來說明（document）異常。不管你採用哪中方式，你要讓客戶端代碼知道你的API中所要拋出的異常。這裏有一個用單元測試來測試IndexOutOfBoundsException的例子：
|
上邊的代碼在請求blankList.get(10)的時候會拋出IndexOutOfBoundsException,如果沒有被拋出，將fail("Should raise an IndexOutOfBoundsException")顯示說明該測試失敗。通過書寫測試異常的單元測試，你不但可以看到異常是怎樣的工作的，而且你可以讓你的代碼變得越來越健壯。
下面作者將介紹界中使用異常的最佳實踐（Best Practices for Using Exceptions）
1． 總是要做一些清理工作（Always clean up after yourself）
如果你使用一些資源例如數據庫連接或者網絡連接，請記住要做一些清理工作（如關閉數據庫連接或者網絡連接），如果你的API拋出Unchecked exception，那麼你要用try-finally來做必要的清理工作：
|
DBUtil是一個工具類來關閉Connection.有必要的說的使用的finally的重要性是不管程序是否碰到異常，它都會被執行。在上邊的例子中，finally中關閉連接，如果在關閉連接的時候出現錯誤就拋出RuntimeException.
2． 不要使用異常來控制流程（Never use exceptions for flow control）
下邊代碼中，MaximumCountReachedException被用於控制流程：
|
上邊的useExceptionsForFlowControl()用一個無限循環來增加count直到拋出異常，這種做法並沒有說讓代碼不易讀，但是它是程序執行效率降低。
記住，只在要會拋出異常的地方進行異常處理。
3． 不要忽略異常
當有異常被拋出的時候，如果你不想恢復它，那麼你要毫不猶豫的將其轉換爲unchecked exception，而不是用一個空的catch塊或者什麼也不做來忽略它，以至於從表面來看象是什麼也沒有發生一樣。
4． 不要捕獲頂層的Exception
unchecked exception都是RuntimeException的子類，RuntimeException又繼承Exception,因此，如果單純的捕獲Exception,那麼你同樣也捕獲了RuntimeException,如下代碼：
|
一旦你寫出了上邊的代碼（注意catch塊是空的），它將忽略所有的異常，包括unchecked exception.
5． Log exceptions just once
Logging the same exception stack trace more than once can confuse the programmer examining the stack trace about the original source of exception. So just log it once.
總結
這裏給出了一些關於異常處理的一些最佳實踐，我並不想開始另一輪的關於checked exception 和 unchecked exception的爭論。你可以根據自己的實際情況定製自己異常處理，我堅信我們將有更好的辦法來處理我們代碼中的異常。
在此，我將感謝Bruce Eckel, Joshua Kerievsky, 和Somik Raha對於寫這篇文章所給於我的支持。
參考資源：
Related Resources
- "Does Java need Checked Exceptions?" by Bruce Eckel
- "Exceptional Java," by Alan Griffiths
- "The trouble with checked exceptions: A conversation with Anders Hejlsberg, Part II" on Artima.com
- "Checked exceptions are of dubious value," on C2.com
- Conversation with James Gosling by Bill Venners
關於作者：
Gunjan Doshi works with agile methodologies and its practices and is a Sun certified Java programmer.
2003年12月4日星期四 Jplateau 譯於精博
http://plateau.sicool.com