Spring Cloud 如何统一异常处理？写得太好了！

汕尾海湾  金牌会员 | 2022-6-24 10:14:53 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 554|帖子 554|积分 1662

作者： BNDong
链接： https://www.cnblogs.com/bndong/p/10135370.html
前言

在启动应用时会发现在控制台打印的日志中出现了两个路径为 {[/error]} 的访问地址，当系统中发送异常错误时，Spring Boot 会根据请求方式分别跳转到以 JSON 格式或以界面显示的 /error 地址中显示错误信息。
  1. 2018-12-18 09:36:24.627  INFO 19040 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error]}" ...
  2. 2018-12-18 09:36:24.632  INFO 19040 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],produces=[text/html]}" ...
复制代码
Spring Boot 基础就不介绍了，推荐下这个实战教程：
https://github.com/javastacks/spring-boot-best-practice
默认异常处理

使用 AJAX 方式请求时返回的 JSON 格式错误信息。
  1. {
  2.     "timestamp": "2018-12-18T01:50:51.196+0000",
  3.     "status": 404,
  4.     "error": "Not Found",
  5.     "message": "No handler found for GET /err404",
  6.     "path": "/err404"
  7. }
复制代码
使用浏览器请求时返回的错误信息界面。

自定义异常处理

引入依赖
  1. <dependency>
  2.     <groupId>com.alibaba</groupId>
  3.     <artifactId>fastjson</artifactId>
  4.     <version>1.2.54</version>
  5. </dependency>
  6. <dependency>
  7.     <groupId>org.springframework.boot</groupId>
  8.     <artifactId>spring-boot-starter-freemarker</artifactId>
  9. </dependency>
复制代码
fastjson 是 JSON 序列化依赖， spring-boot-starter-freemarker 是一个模板引擎，用于我们设置错误输出模板。
增加配置
  1. # 出现错误时, 直接抛出异常(便于异常统一处理，否则捕获不到404)
  2. spring.mvc.throw-exception-if-no-handler-found=true
  3. # 不要为工程中的资源文件建立映射
  4. spring.resources.add-mappings=false
复制代码
  1. spring:
  2.   # 出现错误时, 直接抛出异常(便于异常统一处理，否则捕获不到404)
  3.   mvc:
  4.     throw-exception-if-no-handler-found: true
  5.   # 不要为工程中的资源文件建立映射
  6.   resources:
  7.     add-mappings: false
复制代码
Spring Boot 基础就不介绍了，推荐下这个实战教程：
https://github.com/javastacks/spring-boot-best-practice
新建错误信息实体
  1. /**
  2. * 信息实体
  3. */
  4. public class ExceptionEntity implements Serializable {
  6.     private static final long serialVersionUID = 1L;
  8.     private String message;
  10.     private int    code;
  12.     private String error;
  14.     private String path;
  16.     @JSONField(format = "yyyy-MM-dd hh:mm:ss")
  17.     private Date timestamp = new Date();
  19.     public static long getSerialVersionUID() {
  20.         return serialVersionUID;
  21.     }
  23.     public String getMessage() {
  24.         return message;
  25.     }
  27.     public void setMessage(String message) {
  28.         this.message = message;
  29.     }
  31.     public int getCode() {
  32.         return code;
  33.     }
  35.     public void setCode(int code) {
  36.         this.code = code;
  37.     }
  39.     public String getError() {
  40.         return error;
  41.     }
  43.     public void setError(String error) {
  44.         this.error = error;
  45.     }
  47.     public String getPath() {
  48.         return path;
  49.     }
  51.     public void setPath(String path) {
  52.         this.path = path;
  53.     }
  55.     public Date getTimestamp() {
  56.         return timestamp;
  57.     }
  59.     public void setTimestamp(Date timestamp) {
  60.         this.timestamp = timestamp;
  61.     }
  62. }
复制代码
新建自定义异常
  1. /**
  2. * 自定义异常
  3. */
  4. public class BasicException extends RuntimeException {
  6.     private static final long serialVersionUID = 1L;
  8.     private int code = 0;
  10.     public BasicException(int code, String message) {
  11.         super(message);
  12.         this.code = code;
  13.     }
  15.     public int getCode() {
  16.         return this.code;
  17.     }
  18. }
复制代码
  1. /**
  2. * 业务异常
  3. */
  4. public class BusinessException extends BasicException {
  6.     private static final long serialVersionUID = 1L;
  8.     public BusinessException(int code, String message) {
  9.         super(code, message);
  10.     }
  11. }
复制代码
BasicException 继承了 RuntimeException ，并在原有的 Message 基础上增加了错误码 code 的内容。而 BusinessException 则是在业务中具体使用的自定义异常类，起到了对不同的异常信息进行分类的作用。
新建 error.ftl 模板文件

位置：/src/main/resources/templates/ 用于显示错误信息
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4.     <meta name="robots" content="noindex,nofollow" />
  5.     <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
  6.    
  7. </head>
  8. <body>
  11.     <h2>Exception Datas</h2>
  12.     <table>
  13.         <tbody>
  14.         <tr>
  15.             <td>Code</td>
  16.             <td>
  17.                 ${(exception.code)!}
  18.             </td>
  19.         </tr>
  20.         <tr>
  21.             <td>Time</td>
  22.             <td>
  23.                 ${(exception.timestamp?datetime)!}
  24.             </td>
  25.         </tr>
  26.         <tr>
  27.             <td>Path</td>
  28.             <td>
  29.                 ${(exception.path)!}
  30.             </td>
  31.         </tr>
  32.         <tr>
  33.             <td>Exception</td>
  34.             <td>
  35.                 ${(exception.error)!}
  36.             </td>
  37.         </tr>
  38.         <tr>
  39.             <td>Message</td>
  40.             <td>
  41.                 ${(exception.message)!}
  42.             </td>
  43.         </tr>
  44.         </tbody>
  45.     </table>
  47. </body>
  48. </html>
复制代码
编写全局异常控制类
  1. /**
  2. * 全局异常控制类
  3. */
  4. @ControllerAdvice
  5. public class GlobalExceptionHandler {
  7.     /**
  8.      * 404异常处理
  9.      */
  10.     @ExceptionHandler(value = NoHandlerFoundException.class)
  11.     @ResponseStatus(HttpStatus.NOT_FOUND)
  12.     public ModelAndView errorHandler(HttpServletRequest request, NoHandlerFoundException exception, HttpServletResponse response) {
  13.         return commonHandler(request, response,
  14.                 exception.getClass().getSimpleName(),
  15.                 HttpStatus.NOT_FOUND.value(),
  16.                 exception.getMessage());
  17.     }
  19.     /**
  20.      * 405异常处理
  21.      */
  22.     @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
  23.     public ModelAndView errorHandler(HttpServletRequest request, HttpRequestMethodNotSupportedException exception, HttpServletResponse response) {
  24.         return commonHandler(request, response,
  25.                 exception.getClass().getSimpleName(),
  26.                 HttpStatus.METHOD_NOT_ALLOWED.value(),
  27.                 exception.getMessage());
  28.     }
  30.     /**
  31.      * 415异常处理
  32.      */
  33.     @ExceptionHandler(HttpMediaTypeNotSupportedException.class)
  34.     public ModelAndView errorHandler(HttpServletRequest request, HttpMediaTypeNotSupportedException exception, HttpServletResponse response) {
  35.         return commonHandler(request, response,
  36.                 exception.getClass().getSimpleName(),
  37.                 HttpStatus.UNSUPPORTED_MEDIA_TYPE.value(),
  38.                 exception.getMessage());
  39.     }
  41.     /**
  42.      * 500异常处理
  43.      */
  44.     @ExceptionHandler(value = Exception.class)
  45.     public ModelAndView errorHandler (HttpServletRequest request, Exception exception, HttpServletResponse response) {
  46.         return commonHandler(request, response,
  47.                 exception.getClass().getSimpleName(),
  48.                 HttpStatus.INTERNAL_SERVER_ERROR.value(),
  49.                 exception.getMessage());
  50.     }
  52.     /**
  53.      * 业务异常处理
  54.      */
  55.     @ExceptionHandler(value = BasicException.class)
  56.     private ModelAndView errorHandler (HttpServletRequest request, BasicException exception, HttpServletResponse response) {
  57.         return commonHandler(request, response,
  58.                 exception.getClass().getSimpleName(),
  59.                 exception.getCode(),
  60.                 exception.getMessage());
  61.     }
  63.     /**
  64.      * 表单验证异常处理
  65.      */
  66.     @ExceptionHandler(value = BindException.class)
  67.     @ResponseBody
  68.     public ExceptionEntity validExceptionHandler(BindException exception, HttpServletRequest request, HttpServletResponse response) {
  69.         List<FieldError> fieldErrors = exception.getBindingResult().getFieldErrors();
  70.         Map<String,String> errors = new HashMap<>();
  71.         for (FieldError error:fieldErrors) {
  72.             errors.put(error.getField(), error.getDefaultMessage());
  73.         }
  74.         ExceptionEntity entity = new ExceptionEntity();
  75.         entity.setMessage(JSON.toJSONString(errors));
  76.         entity.setPath(request.getRequestURI());
  77.         entity.setCode(HttpStatus.INTERNAL_SERVER_ERROR.value());
  78.         entity.setError(exception.getClass().getSimpleName());
  79.         response.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());
  80.         return entity;
  81.     }
  83.     /**
  84.      * 异常处理数据处理
  85.      */
  86.     private ModelAndView commonHandler (HttpServletRequest request, HttpServletResponse response,
  87.                                             String error, int httpCode, String message) {
  88.         ExceptionEntity entity = new ExceptionEntity();
  89.         entity.setPath(request.getRequestURI());
  90.         entity.setError(error);
  91.         entity.setCode(httpCode);
  92.         entity.setMessage(message);
  93.         return determineOutput(request, response, entity);
  94.     }
  96.     /**
  97.      * 异常输出处理
  98.      */
  99.     private ModelAndView determineOutput(HttpServletRequest request, HttpServletResponse response, ExceptionEntity entity) {
  100.         if (!(
  101.                 request.getHeader("accept").contains("application/json")
  102.                 || (request.getHeader("X-Requested-With") != null && request.getHeader("X-Requested-With").contains("XMLHttpRequest"))
  103.         )) {
  104.             ModelAndView modelAndView = new ModelAndView("error");
  105.             modelAndView.addObject("exception", entity);
  106.             return modelAndView;
  107.         } else {
  108.             response.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());
  109.             response.setCharacterEncoding("UTF8");
  110.             response.setHeader("Content-Type", "application/json");
  111.             try {
  112.                 response.getWriter().write(ResultJsonTools.build(
  113.                         ResponseCodeConstant.SYSTEM_ERROR,
  114.                         ResponseMessageConstant.APP_EXCEPTION,
  115.                         JSONObject.parseObject(JSON.toJSONString(entity))
  116.                 ));
  117.             } catch (IOException e) {
  118.                 e.printStackTrace();
  119.             }
  120.             return null;
  121.         }
  122.     }
  123. }
复制代码
@ControllerAdvice
作用于类上，用于标识该类用于处理全局异常。
@ExceptionHandler
作用于方法上，用于对拦截的异常类型进行处理。value 属性用于指定具体的拦截异常类型，如果有多个 ExceptionHandler 存在，则需要指定不同的 value 类型，由于异常类拥有继承关系，所以 ExceptionHandler 会首先执行在继承树中靠前的异常类型。
BindException
该异常来自于表单验证框架 Hibernate validation，当字段验证未通过时会抛出此异常。
编写测试 Controller
  1. @RestController
  2. public class TestController {
  4.     @RequestMapping(value = "err")
  5.     public void error(){
  6.         throw new BusinessException(400, "业务异常错误信息");
  7.     }
  9.     @RequestMapping(value = "err2")
  10.     public void error2(){
  11.         throw new NullPointerException("手动抛出异常信息");
  12.     }
  14.     @RequestMapping(value = "err3")
  15.     public int error3(){
  16.         int a = 10 / 0;
  17.         return a;
  18.     }
  19. }
复制代码
使用 AJAX 方式请求时返回的 JSON 格式错误信息。
  1. # /err
  2. {
  3.     "msg": "应用程序异常",
  4.     "code": -1,
  5.     "status_code": 0,
  6.     "data": {
  7.         "path": "/err",
  8.         "code": 400,
  9.         "error": "BusinessException",
  10.         "message": "业务异常错误信息",
  11.         "timestamp": "2018-12-18 11:09:00"
  12.     }
  13. }
  15. # /err2
  16. {
  17.     "msg": "应用程序异常",
  18.     "code": -1,
  19.     "status_code": 0,
  20.     "data": {
  21.         "path": "/err2",
  22.         "code": 500,
  23.         "error": "NullPointerException",
  24.         "message": "手动抛出异常信息",
  25.         "timestamp": "2018-12-18 11:15:15"
  26.     }
  27. }
  29. # /err3
  30. {
  31.     "msg": "应用程序异常",
  32.     "code": -1,
  33.     "status_code": 0,
  34.     "data": {
  35.         "path": "/err3",
  36.         "code": 500,
  37.         "error": "ArithmeticException",
  38.         "message": "/ by zero",
  39.         "timestamp": "2018-12-18 11:15:46"
  40.     }
  41. }
  43. # /err404
  44. {
  45.     "msg": "应用程序异常",
  46.     "code": -1,
  47.     "status_code": 0,
  48.     "data": {
  49.         "path": "/err404",
  50.         "code": 404,
  51.         "error": "NoHandlerFoundException",
  52.         "message": "No handler found for GET /err404",
  53.         "timestamp": "2018-12-18 11:16:11"
  54.     }
  55. }
复制代码
使用浏览器请求时返回的错误信息界面。




示例代码：https://github.com/BNDong/spring-cloud-examples/tree/master/spring-cloud-zuul/cloud-zuul
参考资料：
近期热文推荐：
1.1,000+ 道 Java面试题及答案整理(2022最新版)
2.劲爆！Java 协程要来了。。。
3.Spring Boot 2.x 教程，太全了！
4.别再写满屏的爆爆爆炸类了，试试装饰器模式，这才是优雅的方式！！
5.《Java开发手册（嵩山版）》最新发布，速速下载！
觉得不错，别忘了随手点赞+转发哦！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

汕尾海湾

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

挺好的 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表