SpringBoot2.3定制错误页面的方法示例

#自定义静态资源路径
spring.resources.static-locations=classpath:/templates/layuimini/

@Configuration
public class MyErrorPageConfig {

  @Bean
  public WebServerFactoryCustomizer<ConfigurableWebServerFactory> webServerFactoryCustomizer(){
    return new WebServerFactoryCustomizer<ConfigurableWebServerFactory>() {
      @Override
      public void customize(ConfigurableWebServerFactory factory) {
        ErrorPage errorPage1 = new ErrorPage(HttpStatus.NOT_FOUND, "/page/error/4xx.html");
        ErrorPage errorPage2 = new ErrorPage(HttpStatus.NOT_FOUND, "/page/error/5xx.html");
        factory.addErrorPages(errorPage1, errorPage2);
      }
    };
  }
}

/**
 * 定制ErrorController，目的是能使SpringBoot找到自己定制的错误页面
 * 大部分的代码BasicController一致，关键点是修改错误页面的路径
 */
@Controller
@RequestMapping(value = "/error")
public class MyBasicErrorController implements ErrorController {


  @RequestMapping(produces = {"text/html"})//返回给浏览器
  public String handlerError(HttpServletRequest request, Model model){
    WebRequest webRequest = new ServletWebRequest(request);//对request进行包装，目的是能操作更多的方法
    HttpStatus status = this.getStatus(request);//获取status

    String path = (String) webRequest.getAttribute("javax.servlet.error.request_uri", 0);
    String message = (String) webRequest.getAttribute("javax.servlet.error.message", 0);
    if(message.equals("")){
      message = "No Available Message";
    }

    //携带错误数据信息
    model.addAttribute("timestamp", new Date());
    model.addAttribute("statusCode", status.value());
    model.addAttribute("error", status.getReasonPhrase());
    model.addAttribute("message", message);
    model.addAttribute("path", path);

    int i = status.value() / 100;//判断是4xx还是5xx错误
    if(i == 4){
      return "layuimini/page/error/4xx";//使用自己定制的错误页面
    }else if(i == 5){
      return "layuimini/page/error/5xx";//使用自己定制的错误页面
    }
    return null;
  }

  @RequestMapping//返回给客户端
  public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
    WebRequest webRequest = new ServletWebRequest(request);//对request进行包装，目的是能操作更多的方法
    HttpStatus status = this.getStatus(request);//获取status
    Map<String, Object> map = new HashMap<>();

    if (status == HttpStatus.NO_CONTENT) {
      return new ResponseEntity(status);
    } else {

      String path = (String) webRequest.getAttribute("javax.servlet.error.request_uri", 0);
      String message = (String) webRequest.getAttribute("javax.servlet.error.message", 0);

      map.put("timestamp", new Date());
      map.put("statusCode", status.value());
      map.put("error", status.getReasonPhrase());
      map.put("message", message);
      map.put("path", path);

      return new ResponseEntity(map, status);
    }
  }



  protected HttpStatus getStatus(HttpServletRequest request) {
    Integer statusCode = (Integer)request.getAttribute("javax.servlet.error.status_code");
    if (statusCode == null) {
      return HttpStatus.INTERNAL_SERVER_ERROR;
    } else {
      try {
        return HttpStatus.valueOf(statusCode);
      } catch (Exception var4) {
        return HttpStatus.INTERNAL_SERVER_ERROR;
      }
    }
  }

  @Override
  public String getErrorPath() {
    return "null";
  }
}

@Bean
  @ConditionalOnMissingBean(
    value = {ErrorController.class},//没有ErrorController才会去注册BasicErrorController
    search = SearchStrategy.CURRENT
  )
  public BasicErrorController basicErrorController(ErrorAttributes errorAttributes, ObjectProvider<ErrorViewResolver> errorViewResolvers) {
    return new BasicErrorController(errorAttributes, this.serverProperties.getError(), (List)errorViewResolvers.orderedStream().collect(Collectors.toList()));
  }