建站
咨詢
售后
建站咨詢
新聞中心
[[327655]]
前言
項目在運(yùn)行時出現(xiàn)異常時，如若沒有對異常進(jìn)行捕獲并處理，就會出現(xiàn)如下頁面：
創(chuàng)新互聯(lián)建站是一家集網(wǎng)站建設(shè),洪江企業(yè)網(wǎng)站建設(shè),洪江品牌網(wǎng)站建設(shè),網(wǎng)站定制,洪江網(wǎng)站建設(shè)報價,網(wǎng)絡(luò)營銷,網(wǎng)絡(luò)優(yōu)化,洪江網(wǎng)站推廣為一體的創(chuàng)新建站企業(yè)，幫助傳統(tǒng)企業(yè)提升企業(yè)形象加強(qiáng)企業(yè)競爭力?？沙浞譂M足這一群體相比中小企業(yè)更為豐富、高端、多元的互聯(lián)網(wǎng)需求。同時我們時刻保持專業(yè)、時尚、前沿，時刻以成就客戶成長自我，堅持不斷學(xué)習(xí)、思考、沉淀、凈化自己，讓我們?yōu)楦嗟钠髽I(yè)打造出實用型網(wǎng)站。
這樣顯然對用戶是極其不友好的。
后端不應(yīng)該直接返回錯誤頁面，而應(yīng)返回統(tǒng)一的錯誤信息，比如：
- {
- "code": 500,
- "data": null,
- "message": "服務(wù)異常，請稍后重試"
- }
- 復(fù)制代碼
然后，前端根據(jù)返回的信息，顯示友好的提示頁面。
Spring提供了三種方式對異常統(tǒng)一處理：
- @ExceptionHandler
- 實現(xiàn)HandlerExceptionResolver接口
- @ControllerAdvice + @ExceptionHandler
下面我們來實際操作下。
具體實現(xiàn)
@ExceptionHandler
在【統(tǒng)一基類、接口、返回對象設(shè)計】這一篇文章中， 定義了Controller的基類BaseController，所以只要在BaseController中使用@ExceptionHandler處理異常， 其它Controller繼承BaseController即可。實現(xiàn)如下：
- @Slf4j
- public abstract class BaseController {
- /**
- * BusinessException 異常處理
- */
- @ResponseBody
- @ExceptionHandler(BusinessException.class)
- public ApiResult businessExceptionHandler(BusinessException e) {
- log.error(e.getMessage(), e);
- // do something
- return ApiResult.fail(e.getMessage());
- }
- /**
- * Exception 異常處理
- */
- @ResponseBody
- @ExceptionHandler(Exception.class)
- public ApiResult exceptionHandler(Exception e) {
- log.error(e.getMessage(), e);
- return ApiResult.fail("服務(wù)異常，請稍后重試");
- }
- }
- 復(fù)制代碼
這里對異常BusinessException和Exception進(jìn)行了處理， BusinessException是約定的業(yè)務(wù)異常的基類，若是主動拋出一般都要求是BusinessException的子類，都會被businessExceptionHandler處理。 若是其它異常，可能是意想不到的異常，則會被exceptionHandler處理。
統(tǒng)一處理后，返回結(jié)果如下:
實現(xiàn)HandlerExceptionResolver接口
- @Slf4j
- @Component
- public class GlobalHandlerExceptionResolver implements HandlerExceptionResolver {
-
- @Override
- public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object o, Exception e) {
- log.error(e.getMessage(), e);
- ApiResult apiResult;
- if (e instanceof BusinessException) {
- BusinessException be = (BusinessException) e;
- // do something
- apiResult = ApiResult.fail(be.getMessage());
- } else {
- apiResult = ApiResult.fail("服務(wù)異常，請稍后重試");
- }
- WebUtils.writeJson(response, apiResult);
- return null;
- }
- }
- 復(fù)制代碼
- @Slf4j
- @Component
- public class GlobalHandlerExceptionResolver implements HandlerExceptionResolver {
- @Override
- public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object o, Exception e) {
- log.error(e.getMessage(), e);
- ApiResult apiResult;
- if (e instanceof BusinessException) {
- BusinessException be = (BusinessException) e;
- // do something
- apiResult = ApiResult.fail(be.getMessage());
- } else {
- apiResult = ApiResult.fail("服務(wù)異常，請稍后重試");
- }
- WebUtils.writeJson(response, apiResult);
- return null;
- }
- }
- 復(fù)制代碼
該方式需要實現(xiàn)HandlerExceptionResolver接口，然后將實現(xiàn)類注入到Spring容器中。
但第一種方式中，通過@ResponseBody注解，Spring就幫我們返回了json格式數(shù)據(jù)，而這需要自己實現(xiàn)。
這里實現(xiàn)了工具類WebUtils，用于返回json數(shù)據(jù)，如下：
- public class WebUtils {
- private static final Logger log = LoggerFactory.getLogger(WebUtils.class);
- private static Gson gson = new GsonBuilder().serializeNulls().create();
- /**
- * 返回json數(shù)據(jù)
- *
- * @param response
- * @param object
- */
- public static void writeJson(HttpServletResponse response, int status, Object object) {
- response.setHeader("Content-Type", "application/json;charset=UTF-8");
- response.setContentType("application/json;charset=UTF-8");
- response.setStatus(status);
- PrintWriter out = null;
- try {
- String data = object instanceof String ? (String) object : gson.toJson(object);
- out = response.getWriter();
- out.print(data);
- out.flush();
- } catch (Exception e) {
- log.error(e.getMessage(), e);
- } finally {
- if (out != null) {
- out.close();
- }
- }
- }
- /**
- * 返回json數(shù)據(jù)
- *
- * @param response
- * @param object
- */
- public static void writeJson(HttpServletResponse response, Object object) {
- writeJson(response, HttpServletResponse.SC_OK, object);
- }
- /**
- * 返回json數(shù)據(jù)
- *
- * @param response
- * @param object
- */
- public static void writeJson(ServletResponse response, Object object) {
- if (response instanceof HttpServletResponse) {
- writeJson((HttpServletResponse) response, object);
- }
- }
- }
- 復(fù)制代碼
工具類中使用了Gson，需要引用：
com.google.code.gson gson - 復(fù)制代碼
@ControllerAdvice + @ExceptionHandler
該方式與第一種方式類似，如下：
- @Slf4j
- @ControllerAdvice
- public class GlobalExceptionHandler {
- /**
- * BusinessException 異常處理
- */
- @ResponseBody
- @ExceptionHandler(BusinessException.class)
- public ApiResult businessExceptionHandler(BusinessException e) {
- log.error(e.getMessage(), e);
- // do something
- return ApiResult.fail(e.getMessage());
- }
- /**
- * Exception 異常處理
- */
- @ResponseBody
- @ExceptionHandler(Exception.class)
- public ApiResult exceptionHandler(Exception e) {
- log.error(e.getMessage(), e);
- return ApiResult.fail("服務(wù)異常，請稍后重試");
- }
- }
- 復(fù)制代碼
總結(jié)
三種方式都能很好對異常進(jìn)行統(tǒng)一處理，但是一般推薦使用@ControllerAdvice + @ExceptionHandler方式， 這樣能夠使異常處理與業(yè)務(wù)邏輯分離，并且不用自己處理Json數(shù)據(jù)返回。
源碼
github.com/zhuqianchan…
網(wǎng)頁名稱：從零搭建后端框架——異常統(tǒng)一處理的三種方式
標(biāo)題來源：http://www.dlmjj.cn/article/cdjehoc.html
