SpringBoot定制化错误处理

639 阅读3分钟

这是我参与11月更文挑战的第14天,活动详情查看:2021最后一次更文挑战

SpringBoot默认的错误处理机制

默认效果:

1)、浏览器,返回一个默认的错误页面

浏览器发送请求的请求头:

2)、如果是其他客户端,默认响应一个json数据

原理:

可以参照ErrorMvcAutoConfiguration;错误处理的自动配置;

1、DefaultErrorAttributes:帮我们在页面共享信息;

2、BasicErrorController:处理默认/error请求

3、ErrorPageCustomizer: 系统出现错误以后来到error请求进行处理;(web.xml注册的错误页面规则)

4、DefaultErrorViewResolver:

@Override
	public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status,
			Map<String, Object> model) {
		ModelAndView modelAndView = resolve(String.valueOf(status), model);
		if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {
			modelAndView = resolve(SERIES_VIEWS.get(status.series()), model);
		}
		return modelAndView;
	}

	private ModelAndView resolve(String viewName, Map<String, Object> model) {
        //默认SpringBoot可以去找到一个页面?  error/404
		String errorViewName = "error/" + viewName;
        
        //模板引擎可以解析这个页面地址就用模板引擎解析
		TemplateAvailabilityProvider provider = this.templateAvailabilityProviders
				.getProvider(errorViewName, this.applicationContext);
		if (provider != null) {
            //模板引擎可用的情况下返回到errorViewName指定的视图地址
			return new ModelAndView(errorViewName, model);
		}
        //模板引擎不可用,就在静态资源文件夹下找errorViewName对应的页面   error/404.html
		return resolveResource(errorViewName, model);
	}

一但系统出现4xx或者5xx之类的错误;ErrorPageCustomizer就会生效(定制错误的响应规则);就会来到/error请求;就会被BasicErrorController处理;

响应页面;去哪个页面是由DefaultErrorViewResolver解析得到的;

自定义错误

为我们要去做一个自定义错误呢?他不是已经给我出现了错误提示吗?

首先,作为开发者我们能看懂错误提示,但是作为用户,他们不知道啊,可能有一些问题是用户在无意间搞出来的,用户可以根据我们的提示,正确的继续使用,而且他还美观,让用户有更好的用户体验

其次,我们自定义错误,能帮我们更方便的找到我们的错误原因

1)有模板引擎的情况下;error/状态码; 【将错误页面命名为 错误状态码.html 放在模板引擎文件夹里面的 error文件夹下】,发生此状态码的错误就会来到 对应的页面;

我们可以使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误,精确优先(优先寻找精确的状态码.html);

页面能获取的信息;

  • timestamp:时间戳
  • status:状态码
  • error:错误提示
  • exception:异常对象
  • message:异常消息
  • errors:JSR303数据校验的错误都在这里

2)、没有模板引擎(模板引擎找不到这个错误页面),静态资源文件夹下找;

错误页面:gitee.com/ghllhg/Spri…

3)、以上都没有错误页面,就是默认来到SpringBoot默认的错误提示页面;

最先是需要我们的一个异常类

public class UserNotExistException extends RuntimeException{
    public UserNotExistException() {
        super("用户不存在");
    }
}

我们创建一个人造错误

 	@ResponseBody
    @RequestMapping("/hello")
    public String hello(@RequestParam("user") String user){
        if(user.equals("aaa")){
            throw new UserNotExistException();
        }
        return "hello World";
    }

我们新建一个类,自定义我们的异常返回信息

@ControllerAdvice
/**
*浏览器客户端返回的是json
*/
public class MyExceptionHandler {

    @ResponseBody
    @ExceptionHandler(UserNotExistException.class)
    public Map<String,Object> handleException(Exception e){
        Map<String,Object> map = new HashMap<>(10);
        map.put("code","user.notexist");
        map.put("message",e.getMessage());
        return map;


    }
}

转发到/error进行自适应响应效果处理

	@ExceptionHandler(UserNotExistException.class)
    public String handleException(Exception e){
        Map<String,Object> map = new HashMap<>(10);
        map.put("code","user.notexist");
        map.put("message",e.getMessage());

        return "forward:error";

但是这个样子他又回到了之前的样子,而且状态码显示是200,这是不对的

@ControllerAdvice
public class MyExceptionHandler {
    @ExceptionHandler(UserNotExistException.class)
    public String handleException(Exception e,HttpServletRequest request){
        Map<String,Object> map = new HashMap<>(10);
        request.setAttribute("javax.servlet.error.status_code",400);
        map.put("code","user.notexist");
        map.put("message",e.getMessage());
        request.setAttribute("ext",map);
        return "forward:error";

    }
}

我们通过自己设置状态码的方式,跳转到我们的错误页面

但这样我们的定制信息又没,反反复复

出现错误以后,会来到/error请求,会被BasicErrorController处理,响应出去可以获取的数据是由getErrorAttributes得到的(是AbstractErrorController(ErrorController)规定的方法);

1、完全来编写一个ErrorController的实现类【或者是编写AbstractErrorController的子类】,放在容器中;

2、页面上能用的数据,或者是json返回能用的数据都是通过errorAttributes.getErrorAttributes得到;

容器中DefaultErrorAttributes.getErrorAttributes();默认进行数据处理的;

自定义ErrorAttributes

@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
    /**
     *
     * @param webRequest
     * @param options
     * @return
     * 返回值的map就是页面和json能获取的所有字段的值
     */
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
        Map<String, Object> map = super.getErrorAttributes(webRequest, options);
        map.put("company","ll");
        //异常处理器携带的数据
        Map<String, Object> ext = (Map<String, Object>) webRequest.getAttribute("ext", 0);
        map.put("ext",ext);
        return map;
    }
}