一、背景
寫這邊文章源于有朋友問過java中的checked exception和unchecked exception有啥區別，當時我對其的回答是：我編程時僅用RuntimeException。其實，我說句話我是有前提的，確切的應該這么說：在成熟的開發框架下編寫業務代碼，我只使用或關注RuntimeException。因為，由于框架往往將異常的處理統一封裝，這樣以便程序員更好的關注業務代碼，而業務的一些錯誤通常是在系統運行期間發生的，因此業務的異常通常被設計為RuntimeException的子類。
我的回答顯然不能讓朋友滿意！因為，不管是任何一個初學java的都知道，在我們學習IO類和JDBC編程的時候，我們用了大量的try...catch...，這種反復重復的try...catch會讓我們對java的異常記憶深刻！初學者往往不清楚java的異常為什么會設計成這個樣子，他們通常會對異常只進行簡單的處理——在catch塊里面簡單的把異常打印出來，用的最多的就是這個語句：
|
1
|
e.printStackTrace()。 |
我們還與一些記憶，比如數組越界這類的異常：
|
1
|
java.lang.ArrayIndexOutOfBoundsException: 6 |
這也會使我們記憶猶新，因為在我們調試程序的時候，它經常出現！我們會發現這類異常并不需要在代碼里用try...catch...去捕獲它。
上面兩個例子，其實就是朋友問到的checked exception和unchecked exception，需要try...catch...的異常是checked exception，不需要的則是unchecked exception。如果要說他們的區別，我說他們一個要try...catch...，一個不需要，這樣的回答行嗎？我認為這樣的回答是蒼白的。有同學會進一步說，try...catch很顯然，是強制要求拋出異常的方法調用者顯式的處理異常，那e.printStackTrace()算不算處理了異常，我認為那只算是一種簡單懶惰的處理方式吧！那什么樣的處理方式算是高明的，java語言設計者其實是期望發生異常后，調用者能夠在catch里將異常恢復回來，使得程序能夠繼續執行下去。但是，“聰明的程序員都是懶惰的”呵呵，大多數情況下我們選擇異常出現后只進行記錄日志和UI用戶提示，后面我會結合jersey框架，說說其中的統一異常處理。讀到這里，有人會說，那checked exception和unchecked exception異常的區別就是，一個需要處理，一個不需要處理。這個回答正確嗎？我認為是錯誤的！我的觀點是：無論是checked exception還是unchecked exception，我們都要進行處理！
上一段，我們似乎還是沒有解決checked exception和unchecked exception的區別，我認為如何給出答案并不重要，重要的是我們怎么去處理這些異常，以及我們如何在開發時使用異常。
我的觀點是（Web系統開發）：
1、在框架層面封裝checked exception，將其轉化為unchecked exception，避免開發過程中編寫繁冗的try...catch代碼。
2、業務層面的開發，根據程序代碼職責定義不同的RuntimeException(它就是unchecked exception，一般定義為RuntimeException的子類)
3、通過前兩個觀點，系統中自定義的異常將只存在unchecked exception，系統只在于客戶端交換數據的上層，設置統一異常處理機制，并將一些異常轉化為用戶所能理解的信息傳達給用戶。
4、其他如業務層，數據持久層，等底層只負責將異常拋出即可，但要注意不要丟失掉異常堆棧（這一點是初學者容易犯的一個錯誤）。
背景說的夠長了！讓我們進入正題吧，看看Jersey框架的統一異常處理器是怎樣使用的！
二、jersey框架的統一異常處理機制
有如下約定：
1、示例采用jersey1.x版本
2、spring版本為2.5
3、為了簡單起見，示例項目不采用Maven機制
示例的業務場景說明：
1、我們通過讀取一個properties配置文件，配置文件的內容為：
|
1
2
|
key1=hello key2=iteye.com |
2、發起一個http://localhost:8888/a/resources/test?n=11的GET請求，要求n為數字，且必須小于10，如果n錯誤，將產生一個unchecked exception錯誤。
3、本示例中數據訪問層將讀取一個文件，讀取文件錯誤將會產生checked exception錯誤。
示例項目結構設計
代碼片段說明
1、數據存儲文件：test.properties
|
1
2
|
key1=hello key2=iteye.com |
這就是我們要讀取的文件，為了簡單起見，它是一個properties文件。
2、數據訪問類：TestDao.java
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
package com.iteye.redhacker.jersey.dao;import java.io.IOException;import java.io.InputStream;import java.net.URL;import java.util.Properties;import org.springframework.stereotype.Component;import com.iteye.redhacker.jersey.exception.DaoException;import com.iteye.redhacker.jersey.exception.ExceptionCode;@Componentpublic class TestDao { public String sayHello() { ClassLoader classLoader = TestDao.class.getClassLoader(); String iniFile = "com/iteye/redhacker/jersey/dao/test.properties"; URL url = classLoader.getResource(iniFile); InputStream is; try { is = url.openStream(); } catch (IOException e) { throw new DaoException(e, ExceptionCode.READ_FILE_FAILED); } Properties proper = null; try { if (proper == null) { proper = new Properties(); } proper.load(url.openStream()); } catch (IOException e) { throw new DaoException(e, ExceptionCode.READ_CONFIG_FAILED); } finally { if (is != null) { try { is.close(); is = null; } catch (IOException e) { throw new DaoException(e, ExceptionCode.COLSE_FILE_FAILED); } } } return proper.getProperty("key1") + "," + proper.getProperty("key2"); }} |
在該類中，將checked exception全部轉化為unchecked exception（我們自定義的exception），調用sayHello()方法時，不再需要try...catch...
3、業務實現類：TestService.java
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
package com.iteye.redhacker.jersey.service;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Component;import com.iteye.redhacker.jersey.dao.TestDao;import com.iteye.redhacker.jersey.exception.ExceptionCode;import com.iteye.redhacker.jersey.exception.ServiceException;@Componentpublic class TestService { @Autowired private TestDao testDao; public String sayHello(int n) { // 業務上規定n不能大于10 if (n > 10) { throw new ServiceException(ExceptionCode.MUST_BE_LESS_THAN_10); } return testDao.sayHello(); } /** * @param testDao the testDao to set */ public void setTestDao(TestDao testDao) { this.testDao = testDao; }} |
在該類中，我們拋出了一個自己的業務異常，它是一個unchecked exception。
注意：我們使用@Autowired注入了TestDao類，@Autowired是Spring提供的一個注解；我們必須提供一個要注解屬性的Set方法，否則注解將失敗。
4、請求接入類：TestResources.java
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
package com.iteye.redhacker.jersey.delegate;import javax.ws.rs.GET;import javax.ws.rs.Path;import javax.ws.rs.Produces;import javax.ws.rs.QueryParam;import javax.ws.rs.core.MediaType;import com.iteye.redhacker.jersey.service.TestService;import com.sun.jersey.api.spring.Autowire;@Path("/test")@Autowirepublic class TestResources { private TestService testService; @GET @Produces(MediaType.TEXT_PLAIN) public String sayHello(@QueryParam("n") int n) { return testService.sayHello(n); } /** * @param testService the testService to set */ public void setTestService(TestService testService) { this.testService = testService; } } |
這里是jersey定義的一個資源，我們可以這樣訪問這個資源:發起GET請求，訪問URI為/resources/test，可以傳遞一個查詢參數n，例如：/resources/test?n=1
注意：我們使用了@Autowire并不是Spring的一個注解，它是jersey-srping集成包的一個注解；我們必須提供一個要注解屬性的Set方法，否則注解將失敗。
5、統一異常處理器類：ExceptionMapperSupport.java
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
package com.iteye.redhacker.jersey.jaxrs;import javax.servlet.ServletContext;import javax.servlet.http.HttpServletRequest;import javax.ws.rs.core.Context;import javax.ws.rs.core.MediaType;import javax.ws.rs.core.Response;import javax.ws.rs.core.Response.Status;import javax.ws.rs.ext.ExceptionMapper;import javax.ws.rs.ext.Provider;import org.apache.log4j.Logger;import org.springframework.web.context.WebApplicationContext;import com.iteye.redhacker.jersey.exception.BaseException;import com.iteye.redhacker.jersey.exception.ExceptionCode;import com.sun.jersey.api.NotFoundException;/** * 統一異常處理器 */@Providerpublic class ExceptionMapperSupport implements ExceptionMapper<Exception> { private static final Logger LOGGER = Logger .getLogger(ExceptionMapperSupport.class); private static final String CONTEXT_ATTRIBUTE = WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE; @Context private HttpServletRequest request; @Context private ServletContext servletContext; /** * 異常處理 * * @param exception * @return 異常處理后的Response對象 */ public Response toResponse(Exception exception) { String message = ExceptionCode.INTERNAL_SERVER_ERROR; Status statusCode = Status.INTERNAL_SERVER_ERROR; WebApplicationContext context = (WebApplicationContext) servletContext .getAttribute(CONTEXT_ATTRIBUTE); // 處理unchecked exception if (exception instanceof BaseException) { BaseException baseException = (BaseException) exception; String code = baseException.getCode(); Object[] args = baseException.getValues(); message = context.getMessage(code, args, exception.getMessage(), request.getLocale()); } else if (exception instanceof NotFoundException) { message = ExceptionCode.REQUEST_NOT_FOUND; statusCode = Status.NOT_FOUND; } // checked exception和unchecked exception均被記錄在日志里 LOGGER.error(message, exception); return Response.ok(message, MediaType.TEXT_PLAIN).status(statusCode) .build(); }} |
在這個類里面我們處理了我們定義的unchecked exception異常，還處理了系統未知的exception(包括未知的unchecked exception和checked exception)。我們的處理方式是：a、記錄異常日志；b、向客戶端拋一個標準的http標準錯誤狀態碼和錯誤消息，由客戶端對錯誤信息進行自行處理，值得說明的是，這種處理方式是REST所提倡的，它恰當的使用了HTTP標準狀態碼；
在這個類中我們還使用了spring的國際化配置組件，用于對系統拋出的錯誤key進行國際化轉換，這有利于我們的項目國際化升級。
6、自定義異常基類：BaseException.java
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
package com.iteye.redhacker.jersey.exception;/** * 異常基類，各個模塊的運行期異常均繼承與該類 */public class BaseException extends RuntimeException { /** * the serialVersionUID */ private static final long serialVersionUID = 1381325479896057076L; /** * message key */ private String code; /** * message params */ private Object[] values; /** * @return the code */ public String getCode() { return code; } /** * @param code the code to set */ public void setCode(String code) { this.code = code; } /** * @return the values */ public Object[] getValues() { return values; } /** * @param values the values to set */ public void setValues(Object[] values) { this.values = values; } public BaseException(String message, Throwable cause, String code, Object[] values) { super(message, cause); this.code = code; this.values = values; }} |
這個類定義了項目異常類的基本模板，其他異常繼承與它。值得注意的是，它巧妙的利用了國際化配置的一些特征，甚至可以拋出下面這樣定義的一個錯誤消息，通過傳遞參數的方式，復用錯誤信息：
第{0}個{1}參數錯誤
7、其他異常基本差不多，只是類型不同，我們看一下DaoException.java
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
package com.iteye.redhacker.jersey.exception;public class DaoException extends BaseException { /** * Constructors * * @param code * 錯誤代碼 */ public DaoException(String code) { super(code, null, code, null); } /** * Constructors * * @param cause * 異常接口 * @param code * 錯誤代碼 */ public DaoException(Throwable cause, String code) { super(code, cause, code, null); } /** * Constructors * * @param code * 錯誤代碼 * @param values * 一組異常信息待定參數 */ public DaoException(String code, Object[] values) { super(code, null, code, values); } /** * Constructors * * @param cause * 異常接口 * @param code * 錯誤代碼 * @param values * 一組異常信息待定參數 */ public DaoException(Throwable cause, String code, Object[] values) { super(code, null, code, values); } private static final long serialVersionUID = -3711290613973933714L;} |
它繼承了BaseException，當拋出這個異常時，我們就從異常名字上直接初步判斷出，錯誤出自Dao層。
8、errMsg.properties用于定義異常信息，來看一下：
|
1
2
3
4
5
6
|
read.file.failed=讀取文件失敗read.config.failed=讀取配置項失敗must.be.less.than.10=參數必須小于10colse.file.failed=關閉文件失敗request.not.found=沒有找到相應的服務internal.server.error=服務器內部錯誤 |
三、部署及測試
你可以在本文附件里下載到源碼。導入eclipse后，查看源碼。
部署很簡單，只要將你的tomcat/config/server.xml里加入：
|
1
2
3
4
5
|
<Host>...<Context path="/a" reloadable="true" docBase="D:/workspace/test/JerseyExceptionMapperTest/web" /></Host> |
啟動tomcat就可以了！
做兩個測試：
1、
2、
第1個測試，還可以在log中看到如下異常錯誤：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
[2013-08-15 00:25:55] [ERROR] 參數必須小于10com.iteye.redhacker.jersey.exception.ServiceException: must.be.less.than.10 at com.iteye.redhacker.jersey.service.TestService.sayHello(TestService.java:20) at com.iteye.redhacker.jersey.delegate.TestResources.sayHello(TestResources.java:21) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25) at java.lang.reflect.Method.invoke(Method.java:597) at com.sun.jersey.spi.container.JavaMethodInvokerFactory$1.invoke(JavaMethodInvokerFactory.java:60) at com.sun.jersey.server.impl.model.method.dispatch.AbstractResourceMethodDispatchProvider$TypeOutInvoker._dispatch(AbstractResourceMethodDispatchProvider.java:185) at com.sun.jersey.server.impl.model.method.dispatch.ResourceJavaMethodDispatcher.dispatch(ResourceJavaMethodDispatcher.java:75) at com.sun.jersey.server.impl.uri.rules.HttpMethodRule.accept(HttpMethodRule.java:288) at com.sun.jersey.server.impl.uri.rules.ResourceClassRule.accept(ResourceClassRule.java:108) at com.sun.jersey.server.impl.uri.rules.RightHandPathRule.accept(RightHandPathRule.java:147) at com.sun.jersey.server.impl.uri.rules.RootResourceClassesRule.accept(RootResourceClassesRule.java:84) at com.sun.jersey.server.impl.application.WebApplicationImpl._handleRequest(WebApplicationImpl.java:1483) at com.sun.jersey.server.impl.application.WebApplicationImpl._handleRequest(WebApplicationImpl.java:1414) at com.sun.jersey.server.impl.application.WebApplicationImpl.handleRequest(WebApplicationImpl.java:1363) at com.sun.jersey.server.impl.application.WebApplicationImpl.handleRequest(WebApplicationImpl.java:1353) |
關于其他的一些測試，大家可以去嘗試一下，比如故意把test.properties刪除，當找不到要讀取的文件時，checked exception是如何轉化為我們自己定義個unchecked exception，并記錄下了日志，返回給客戶端標準的http錯誤狀態碼和錯誤信息。
四、總結
1、通過jersey框架我們不難看出，在web項目開發來講，對于checked exception和unchecked exception的處理我們盡可能在框架層面就進行了統一處理，以便我們更加關注與業務的實現。
2、如果是非web項目，我想，程序架構設計者也應當盡量統一的處理異常；如果不做統一處理，當遇到checked exception，我們應當對其進行恰當的異常處理，而不是不是簡單的做一個e.printStackTrace()的處理；如果我們不能恢復異常，那我們至少要將異常的錯誤信息完整的記錄到日志文件中去，以便后續的程序出現故障時進行錯誤排查。
全文（完）
