从零搭建后端框架——异常统一处理的三种方式

 [[327655]]

前言

项目在运行时出现异常时，如若没有对异常进行捕获并处理，就会出现如下页面：

创新互联建站是一家集网站建设,洪江企业网站建设,洪江品牌网站建设,网站定制,洪江网站建设报价,网络营销,网络优化,洪江网站推广为一体的创新建站企业，帮助传统企业提升企业形象加强企业竞争力。可充分满足这一群体相比中小企业更为丰富、高端、多元的互联网需求。同时我们时刻保持专业、时尚、前沿，时刻以成就客户成长自我，坚持不断学习、思考、沉淀、净化自己，让我们为更多的企业打造出实用型网站。

这样显然对用户是极其不友好的。

后端不应该直接返回错误页面，而应返回统一的错误信息，比如：

  
  
  
  
    
   
   
   
   
  1. { 
    2.    
   
   
   
  2. "code": 500, 
    3.    
   
   
   
  3. "data": null, 
    4.    
   
   
   
  4. "message": "服务异常，请稍后重试" 
    5.    
   
   
   
  5. } 
    6.    
   
   
   
  6. 复制代码 
    7.

然后，前端根据返回的信息，显示友好的提示页面。

Spring提供了三种方式对异常统一处理：

  1. @ExceptionHandler
  2. 实现HandlerExceptionResolver接口
  3. @ControllerAdvice + @ExceptionHandler

下面我们来实际操作下。

具体实现

@ExceptionHandler

在【统一基类、接口、返回对象设计】这一篇文章中， 定义了Controller的基类BaseController，所以只要在BaseController中使用@ExceptionHandler处理异常， 其它Controller继承BaseController即可。实现如下：

  
  
  
  
    
   
   
   
   
  1. @Slf4j 
    2.    
   
   
   
  2. public abstract class BaseController { 
    3.    
   
   
   
  3.  
    4.    
   
   
   
  4. /** 
    5.    
   
   
   
  5. * BusinessException 异常处理 
    6.    
   
   
   
  6. */ 
    7.    
   
   
   
  7. @ResponseBody 
    8.    
   
   
   
  8. @ExceptionHandler(BusinessException.class) 
    9.    
   
   
   
  9. public ApiResult businessExceptionHandler(BusinessException e) { 
    10.    
   
   
   
  10. log.error(e.getMessage(), e); 
    11.    
   
   
   
  11. // do something 
    12.    
   
   
   
  12. return ApiResult.fail(e.getMessage()); 
    13.    
   
   
   
  13. } 
    14.    
   
   
   
  14.  
    15.    
   
   
   
  15. /** 
    16.    
   
   
   
  16. * Exception 异常处理 
    17.    
   
   
   
  17. */ 
    18.    
   
   
   
  18. @ResponseBody 
    19.    
   
   
   
  19. @ExceptionHandler(Exception.class) 
    20.    
   
   
   
  20. public ApiResult exceptionHandler(Exception e) { 
    21.    
   
   
   
  21. log.error(e.getMessage(), e); 
    22.    
   
   
   
  22. return ApiResult.fail("服务异常，请稍后重试"); 
    23.    
   
   
   
  23. } 
    24.    
   
   
   
  24. } 
    25.    
   
   
   
  25. 复制代码 
    26.

这里对异常BusinessException和Exception进行了处理， BusinessException是约定的业务异常的基类，若是主动抛出一般都要求是BusinessException的子类，都会被businessExceptionHandler处理。 若是其它异常，可能是意想不到的异常，则会被exceptionHandler处理。

统一处理后，返回结果如下:

实现HandlerExceptionResolver接口

  
  
  
  
    
   
   
   
   
  1. @Slf4j 
    2.    
   
   
   
  2. @Component 
    3.    
   
   
   
  3. public class GlobalHandlerExceptionResolver implements HandlerExceptionResolver { 
    4.    
   
   
   
  4.  
    5.    
   
   
   
  5. @Override 
    6.    
   
   
   
  6. public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object o, Exception e) { 
    7.    
   
   
   
  7. log.error(e.getMessage(), e); 
    8.    
   
   
   
  8. ApiResult apiResult; 
    9.    
   
   
   
  9. if (e instanceof BusinessException) { 
    10.    
   
   
   
  10. BusinessException be = (BusinessException) e; 
    11.    
   
   
   
  11. // do something 
    12.    
   
   
   
  12. apiResult = ApiResult.fail(be.getMessage()); 
    13.    
   
   
   
  13. } else { 
    14.    
   
   
   
  14. apiResult = ApiResult.fail("服务异常，请稍后重试"); 
    15.    
   
   
   
  15. } 
    16.    
   
   
   
  16. WebUtils.writeJson(response, apiResult); 
    17.    
   
   
   
  17. return null; 
    18.    
   
   
   
  18. } 
    19.    
   
   
   
  19. } 
    20.    
   
   
   
  20. 复制代码 
    21.

该方式需要实现HandlerExceptionResolver接口，然后将实现类注入到Spring容器中。

但第一种方式中，通过@ResponseBody注解，Spring就帮我们返回了json格式数据，而这需要自己实现。

这里实现了工具类WebUtils，用于返回json数据，如下：

  
  
  
  
    
   
   
   
   
  1. public class WebUtils { 
    2.    
   
   
   
  2.  
    3.    
   
   
   
  3. private static final Logger log = LoggerFactory.getLogger(WebUtils.class); 
    4.    
   
   
   
  4.  
    5.    
   
   
   
  5. private static Gson gson = new GsonBuilder().serializeNulls().create(); 
    6.    
   
   
   
  6.  
    7.    
   
   
   
  7. /** 
    8.    
   
   
   
  8. * 返回json数据 
    9.    
   
   
   
  9. * 
    10.    
   
   
   
  10. * @param response 
    11.    
   
   
   
  11. * @param object 
    12.    
   
   
   
  12. */ 
    13.    
   
   
   
  13. public static void writeJson(HttpServletResponse response, int status, Object object) { 
    14.    
   
   
   
  14. response.setHeader("Content-Type", "application/json;charset=UTF-8"); 
    15.    
   
   
   
  15. response.setContentType("application/json;charset=UTF-8"); 
    16.    
   
   
   
  16. response.setStatus(status); 
    17.    
   
   
   
  17. PrintWriter out = null; 
    18.    
   
   
   
  18. try { 
    19.    
   
   
   
  19. String data = object instanceof String ? (String) object : gson.toJson(object); 
    20.    
   
   
   
  20. out = response.getWriter(); 
    21.    
   
   
   
  21. out.print(data); 
    22.    
   
   
   
  22. out.flush(); 
    23.    
   
   
   
  23. } catch (Exception e) { 
    24.    
   
   
   
  24. log.error(e.getMessage(), e); 
    25.    
   
   
   
  25. } finally { 
    26.    
   
   
   
  26. if (out != null) { 
    27.    
   
   
   
  27. out.close(); 
    28.    
   
   
   
  28. } 
    29.    
   
   
   
  29. } 
    30.    
   
   
   
  30. } 
    31.    
   
   
   
  31.  
    32.    
   
   
   
  32. /** 
    33.    
   
   
   
  33. * 返回json数据 
    34.    
   
   
   
  34. * 
    35.    
   
   
   
  35. * @param response 
    36.    
   
   
   
  36. * @param object 
    37.    
   
   
   
  37. */ 
    38.    
   
   
   
  38. public static void writeJson(HttpServletResponse response, Object object) { 
    39.    
   
   
   
  39. writeJson(response, HttpServletResponse.SC_OK, object); 
    40.    
   
   
   
  40. } 
    41.    
   
   
   
  41.  
    42.    
   
   
   
  42. /** 
    43.    
   
   
   
  43. * 返回json数据 
    44.    
   
   
   
  44. * 
    45.    
   
   
   
  45. * @param response 
    46.    
   
   
   
  46. * @param object 
    47.    
   
   
   
  47. */ 
    48.    
   
   
   
  48. public static void writeJson(ServletResponse response, Object object) { 
    49.    
   
   
   
  49. if (response instanceof HttpServletResponse) { 
    50.    
   
   
   
  50. writeJson((HttpServletResponse) response, object); 
    51.    
   
   
   
  51. } 
    52.    
   
   
   
  52. } 
    53.    
   
   
   
  53. } 
    54.    
   
   
   
  54. 复制代码 
    55.

工具类中使用了Gson，需要引用：

  
  
  
  
    
   
   
   
   
  1.  
    2.    
   
   
   
  2. com.google.code.gson 
    3.    
   
   
   
  3. gson 
    4.    
   
   
   
  4.  
    5.    
   
   
   
  5. 复制代码 
    6.

@ControllerAdvice + @ExceptionHandler

该方式与第一种方式类似，如下：

  
  
  
  
    
   
   
   
   
  1. @Slf4j 
    2.    
   
   
   
  2. @ControllerAdvice 
    3.    
   
   
   
  3. public class GlobalExceptionHandler { 
    4.    
   
   
   
  4.  
    5.    
   
   
   
  5. /** 
    6.    
   
   
   
  6. * BusinessException 异常处理 
    7.    
   
   
   
  7. */ 
    8.    
   
   
   
  8. @ResponseBody 
    9.    
   
   
   
  9. @ExceptionHandler(BusinessException.class) 
    10.    
   
   
   
  10. public ApiResult businessExceptionHandler(BusinessException e) { 
    11.    
   
   
   
  11. log.error(e.getMessage(), e); 
    12.    
   
   
   
  12. // do something 
    13.    
   
   
   
  13. return ApiResult.fail(e.getMessage()); 
    14.    
   
   
   
  14. } 
    15.    
   
   
   
  15.  
    16.    
   
   
   
  16. /** 
    17.    
   
   
   
  17. * Exception 异常处理 
    18.    
   
   
   
  18. */ 
    19.    
   
   
   
  19. @ResponseBody 
    20.    
   
   
   
  20. @ExceptionHandler(Exception.class) 
    21.    
   
   
   
  21. public ApiResult exceptionHandler(Exception e) { 
    22.    
   
   
   
  22. log.error(e.getMessage(), e); 
    23.    
   
   
   
  23. return ApiResult.fail("服务异常，请稍后重试"); 
    24.    
   
   
   
  24. } 
    25.    
   
   
   
  25. } 
    26.    
   
   
   
  26. 复制代码 
    27.

总结

三种方式都能很好对异常进行统一处理，但是一般推荐使用@ControllerAdvice + @ExceptionHandler方式， 这样能够使异常处理与业务逻辑分离，并且不用自己处理Json数据返回。

源码

github.com/zhuqianchan…

分享名称：从零搭建后端框架——异常统一处理的三种方式
分享网址：http://www.mswzjz.cn/qtweb/news13/69013.html

攀枝花网站建设、攀枝花网站运维推广公司-贝锐智能，是专注品牌与效果的网络营销公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 贝锐智能

贝锐智能技术为您推荐以下文章

响应式网站知识

分类信息网站

微信小程序公众号开发　　 　上市集团网站建设　　 　成都网站改版　　 　小程序开发　　 　网站维护　　 　资阳做网站　　 　营山母婴护理　　 　南充机房托管　　 　成都微商城　　 　网站改版　　 　成都网站制作　　 　网站运营　　 　成都未宇聚　　 　成都门户网站建设设计方案　　 　网站设计　　 　达州做网站　　 　企业网站建设公司　　 　电信机房托管　　 　轻质隔墙板　　 　手机网站制作设计