SpringBoot全局异常统一处理

Posted 2022-10-22 阿征new

统一处理机制

spring 系统异常：@ControllerAdvice & @ExceptionHandler

http 异常 ErrorController

Servlet 异常 Filter

1.SpringBoot默认错误统一处理机制
在基于SpringBoot的Web应用中，对于Http请求处理过程中发生的各种错误，如常见的400、404和500等错误，SpringBoot默认提供了一种映射到错误页面/error的机制来处理所有的错误，并且该页面也由SpringBoot默认提供，不需要开发者自己编写。该页面会显示请求的错误状态码， 以及一些错误原因和消息，如下图分别为SpringBoot默认提供的404错误和500错误页面：

上述/error错误页面路径可以理解为SpringBoot默认为我们写了一个模版错误页面，然后默认还写了一个Controller，该Controller中包含一个/error请求地址映射指向该错误页面。当SpringBoot的错误处理机制捕获到请求异常之后，则会将用户的原请求携带上错误信息，然后转发到这个/error页面，页面再显示错误的相关信息。

虽然SpringBoot提供了默认的错误显示页面，但是仅使用该默认错误页面会存在大量的局限性：

该页面比较简陋，对于用户而言并不友好；
500错误暴露了服务器的详细出错原因，存在严重安全隐患；
在前后端分离的项目中，客户端需要的不是页面，而是JSON数据。
2.全局异常统一处理
基于上述SpringBoot默认错误处理机制存在的局限性和问题，SpringBoot中提供了@ControllerAdvice和@ExceptionHandler两个注解来实现专门对服务器500异常进行自定义处理。使用示例如下：

@ControllerAdvice
public class ExceptionController 

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Map globalException(HttpServletRequest request, Exception e) 
        Map<String,Object> map = new HashMap<>();
        map.put("code",500);
        map.put("message",e.getMessage());
        return map;
    

    @ExceptionHandler(MyException.class)
    @ResponseBody
    public Map myException(HttpServletRequest request, Exception e) 
        Map<String,Object> map = new HashMap<>();
        map.put("code",500);
        map.put("message",e.getMessage());
        return map;
    

@ControllerAdvice注解表示我们定义的是一个控制器增强类，当其他任何控制器发生异常且异常类型符合@ExceptionHandler注解中指定的异常类时，原请求将会被拦截到这个我们自定义的控制器方法中。

在该方法中，我们可以拿到异常信息，于是便可以自定义该如何处理异常，是返回一个我们自定义的模版错误页面，还是返回JSON数据，这将都由我们根据实际应用场景而自己决定。并且我们还可以自定义异常类处理特殊情况。

另外，@ExceptionHandler注解只有一个value参数，为指定的异常类；@ControllerAdvice注解查看源码参数发现我们还可以指定需要拦截的控制器所在的包路径。

在业务控制器中模拟发生异常：

	@GetMapping("user/id")
    public User findById(@PathVariable("id") Long id) 
        User user = userService.findById(id);
        int i = 1/0;
        return user;