你以为Spring Boot统一异常处理能拦截所有的异常?

开发 架构
通常我们在Spring Boot中设置的统一异常处理只能处理Controller抛出的异常。有些请求还没到Controller就出异常了,而这些异常不能被统一异常捕获,例如Servlet容器的某些异常。

[[396961]]

通常我们在Spring Boot中设置的统一异常处理只能处理Controller抛出的异常。有些请求还没到Controller就出异常了,而这些异常不能被统一异常捕获,例如Servlet容器的某些异常。今天我在项目开发中就遇到了一个,这让我很不爽,因为它返回的错误信息格式不能统一处理,我决定找个方案解决这个问题。

ErrorPageFilter

Whitelabel Error Page

这类图相信大家没少见,Spring Boot 只要出错,体现在页面上的就是这个。如果你用Postman之类的测试出了异常则是:


  "timestamp""2021-04-29T22:45:33.231+0000"
  "status": 500, 
  "message""Internal Server Error"
  "path""foo/bar" 

  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.

这个是怎么实现的呢?Spring Boot在启动时会注册一个ErrorPageFilter,当Servlet发生异常时,该过滤器就会拦截处理,将异常根据不同的策略进行处理:当异常已经在处理的话直接处理,否则转发给对应的错误页面。有兴趣的可以去看下源码,逻辑不复杂,这里就不贴了。

另外当一个 Servlet 抛出一个异常时,处理异常的Servlet可以从HttpServletRequest里面得到几个属性,如下:

异常属性

我们可以从上面的几个属性中获取异常的详细信息。

默认错误页面

通常Spring Boot出现异常默认会跳转到/error进行处理,而/error的相关逻辑则是由BasicErrorController实现的。

@Controller 
@RequestMapping("${server.error.path:${error.path:/error}}"
public class BasicErrorController extends AbstractErrorController { 
    //返回错误页面 
  @RequestMapping(produces = MediaType.TEXT_HTML_VALUE) 
 public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) { 
  HttpStatus status = getStatus(request); 
  Map<String, Object> model = Collections 
    .unmodifiableMap(getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.TEXT_HTML))); 
  response.setStatus(status.value()); 
  ModelAndView modelAndView = resolveErrorView(request, response, status, model); 
  return (modelAndView != null) ? modelAndView : new ModelAndView("error", model); 
 } 
    // 返回json 
 @RequestMapping 
 public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) { 
  HttpStatus status = getStatus(request); 
  if (status == HttpStatus.NO_CONTENT) { 
   return new ResponseEntity<>(status); 
  } 
  Map<String, Object> body = getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.ALL)); 
  return new ResponseEntity<>(body, status); 
 }   
// 其它省略 

  • 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.

而对应的配置:

@Bean 
@ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT
public BasicErrorController basicErrorController(ErrorAttributes errorAttributes, 
      ObjectProvider<ErrorViewResolver> errorViewResolvers) { 
   return new BasicErrorController(errorAttributes, this.serverProperties.getError(), 
         errorViewResolvers.orderedStream().collect(Collectors.toList())); 

  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.

所以我们只需要重新实现一个ErrorController并注入Spring IoC就可以替代默认的处理机制。而且我们可以很清晰的发现这个BasicErrorController不但是ErrorController的实现而且是一个控制器,如果我们让控制器的方法抛异常,肯定可以被自定义的统一异常处理。所以我对BasicErrorController进行了改造:

@Controller 
@RequestMapping("${server.error.path:${error.path:/error}}"
public class ExceptionController extends AbstractErrorController { 
 
 
    public ExceptionController(ErrorAttributes errorAttributes) { 
        super(errorAttributes); 
    } 
 
 
    @Override 
    @Deprecated 
    public String getErrorPath() { 
        return null
    } 
 
    @RequestMapping(produces = MediaType.TEXT_HTML_VALUE) 
    public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) { 
        throw new RuntimeException(getErrorMessage(request)); 
    } 
 
    @RequestMapping 
    public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) { 
        throw new RuntimeException(getErrorMessage(request)); 
    } 
 
    private String getErrorMessage(HttpServletRequest request) { 
        Object code = request.getAttribute("javax.servlet.error.status_code"); 
        Object exceptionType = request.getAttribute("javax.servlet.error.exception_type"); 
        Object message = request.getAttribute("javax.servlet.error.message"); 
        Object path = request.getAttribute("javax.servlet.error.request_uri"); 
        Object exception = request.getAttribute("javax.servlet.error.exception"); 
 
        return String.format("code: %s,exceptionType: %s,message: %s,path: %s,exception: %s"
                code, exceptionType, message, path, exception); 
    } 

  • 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.

 

直接抛异常,简单省力!凡是这里捕捉的到的异常大部分还没有经过Controller,我们通过ExceptionController中继也让这些异常被统一处理,保证整个应用的异常处理对外保持一个统一的门面。

 

责任编辑:武晓燕 来源: 码农小胖哥
相关推荐

2025-02-13 00:34:22

Spring对象系统

2022-04-08 16:27:48

SpringBoot异常处理

2017-05-18 14:14:25

过滤器Spring ClouZuul

2017-07-31 15:47:50

Zuul统一处理

2017-05-19 15:13:05

过滤器Spring ClouZuul

2024-09-25 08:10:00

Spring后端

2023-11-28 14:32:04

2021-04-20 10:50:38

Spring Boot代码Java

2019-08-22 14:02:00

Spring BootRestful APIJava

2023-09-24 13:55:42

Spring应用程序

2024-08-09 08:25:32

Spring流程注解

2022-10-26 07:14:25

Spring 6Spring业务

2011-05-24 09:22:44

Spring3异常处理

2023-07-10 08:00:13

架构Rest返回值

2022-05-30 08:03:06

后端参数校验异常处理

2020-03-16 17:20:02

异常处理Spring Boot

2023-11-30 07:00:56

SpringBoot处理器

2020-03-11 08:00:00

.NET异常处理编程语言

2024-10-28 08:32:22

统一接口响应SpringBoot响应框架

2024-08-02 09:15:22

Spring捕捉格式
点赞
收藏

51CTO技术栈公众号