springboot-错误处理

ErrorMvcAutoConfiguration错误处理的自动配置

如何定制错误页面

错误处理步骤:

• 1、ErrorPageCustomizer 发生错误，该类生效，发出【/error】请求。

@value("${error.path: / error} ")
private String path = "/error";系统出现错误以后来到error请求进行处理;( web.xml注册的错误页面规则)

• 2、BasicErrorController 处理默认【/error】请求，返回错误视图对象。

@Controller
@RequestNapping( "${ server.error.path : ${error.path : / error}}")
public class BasicErrorController extends AbstractErrorController { 

@RequestMapping(produces = "text/html") //产生html类型的数据
public ModelAndview errorHtm1(HttpServletRequest request,HttpServletResponse response) {
      HttpStatus status = getstatus( request);
      Map<String，object> model = collections.unmodifiableMap(getErrorAttributes(
      request， isIncludestackTrace(request，MediaType.TEXT_HTNL)));
      response.setstatus ( status.value() );

      //去哪个页面作为错误页面；包含页面地址和页面内容。
      ModelAndview modelAndView = resolveErrorView(request，response，status，model);
      return (modelAndview == null ? new ModelAndview( "error", model) : modelAndview);
}

@RequestMapping
@ResponseBody //产生json数据
public ResponseEntity<Map<String，0bject>> error(HttpServletRequest request){
      Map<String, object> body = getErrorAttributes(request,
      isIncludeStackTrace( request，MediaType.ALL));
      Httpstatus status = getstatus( request) ;
      return new ResponseEntity<Map<String，object>>( body,status ) ;
}

• 3、DefaultErrorViewResolver: 解析错误视图，响应页面，去哪个页面由该类决定。

@override
public ModelAndView resolveErrorView(HttpServletRequest request，HttpStatus status,Map<String, object> model) {
      ModelAndview modelAndview = resolve(String.valueof(status)， model);
      if (modelAndView == null 8& 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 errorviewWame = "error/" + viewName ;
      //模板引擎可以解析这个页面地址就用模板引擎解析
      TemplateAvailabilityProvider provider = this.templateAvailabilityProviders.getProvider(errorviewName，this.applicationcontext ) ;
      if ( provider != null) {
            //模板引擎可用的情况下返回到errorviewName指定的视图地址
            return new ModelAndview( errorViewName, model);
      }
      //模板引擎不可用，就在静态资源文件夹下找errorViewName对应的页面
      return resolveResource(errorviewName,model);
}

定制错误响应：

1----有模板引擎情况：
【error/状态码】将错误页面命名为[错误状态码.html],放在模板引起文件夹里面的error文件夹下，发生此状态码的错误就会来到对应的页面;
可以使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误，精确优先

2----没有模板引擎（模板引擎找不到这个错误页面)，静态资源文件夹下找

3----以上都没有错误页面，就默认来到SpringBoot默认的错误提示页面  
逻辑在【BasicErrorController】可找到。

• 4、DefaultErrorAttributes 帮助在页面共享信息。

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

定制json错误响应数据

• 1、自定义异常处理类，返回定制json数据

----自定义异常
public class UserNotExistException extends RuntimeException{
    public UserNotExistException(){super("用户不存在！");}
}

----自定义异常处理
@ControllerAdvice
public class MyExceptionHandler {
    //1--浏览器和客户端返回的都是json数据
    @ExceptionHandler(UserNotExistException.class)
    @ResponseBody
    public Map<String,Object> handleException(Exception e){
        Map<String,Object> map = new HashMap<>();
        map.put("code","user.notexist");
        map.put("message",e.getMessage());
        return map;
    } 
}

• 2、转发到/erro进行自适应响应效果处理

@ControllerAdvice
public class MyExceptionHandler {
    //2--浏览器和客户端自适应响应页面或json数据
    @ExceptionHandler(UserNotExistException.class)
    public String handleException(Exception e,HttpServletRequest request){
        Map<String,Object> map = new HashMap<>();
        //传入我们自己的错误状态码4xx 5xx，否则就不会进入定制错误页面的解析流程
        request.setAttribute(RequestDispatcher.ERROR_STATUS_CODE,500);

        map.put("code","user.notexist");
        map.put("message","用户出错了");
        request.setAttribute("ext",map); //把自定义异常数据添加到域，便于在【ErrorAttributes】中获取错误信息添加到默认异常数据中。
        //转发
        return "forward:/error";
    }
}

• 3、定制的数据携带出去
  出现错误以后，会来到/error请求，会被BasicErrorController处理，响应出去可以获取的数据是由getErrorAttributes得到的（是AbstractErrorController (ErrorController )规定的方法）;

----给容器中添加自定义的ErrorAttributes
@Component
public class MyErrorAttributes extends DefaultErrorAttributes { //定义该错误属性类添加到ioc容器，不仅可以获取到默认错误响应数据，还可以获取到自定义响应数据

    //返回的map就是页面和json能获取到的所有字段
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
        Map<String, Object> map = super.getErrorAttributes(webRequest, options);
        map.put("company","xiaoaiying");

        //获取自定义异常处理器携带的数据
        Map<String,Object> ext = (Map<String, Object>) webRequest.getAttribute("ext", 0);
        map.put("ext",ext);
        return map;
    }
}