0
点赞
收藏
分享

微信扫一扫

springboot的错误处理机制(全)


我项目使用过程中,我们不希望我们的错误页面是springboot内置的,因此需要自己定制错误页面;

默认效果:

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

springboot的错误处理机制(全)_错误页面

这是代表浏览器请求,返回的是springboot内置的错误页面;

springboot的错误处理机制(全)_spring_02

{
"timestamp": "2020-11-29T13:40:06.107+0000",
"status": 404,
"error": "Not Found",
"message": "No message available",
"path": "/crud/aaa"
}

这是利用postman模仿客户端请求返回的json

springboot的错误处理机制(全)_spring_03

springboot根据请求头返回了不同的内容,但是页面和json都不是我们自己定义的,我们需要自己定义来实现这个功能;

方法一:直接在templates中定义error/404.html,4xx.html,500.html,5xx.html

这样,springboot会通过默认的自动错误页面处理找到该模板;

原理:

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

给容器中添加了以下组件

1、DefaultErrorAttributes:

帮我们在页面共享信息;
@Override
public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes,
boolean includeStackTrace) {
Map<String, Object> errorAttributes = new LinkedHashMap<String, Object>();
errorAttributes.put("timestamp", new Date());
addStatus(errorAttributes, requestAttributes);
addErrorDetails(errorAttributes, requestAttributes, includeStackTrace);
addPath(errorAttributes, requestAttributes);
return errorAttributes;
}

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

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

@RequestMapping(produces = "text/html")//产生html类型的数据;浏览器发送的请求来到这个方法处理
public ModelAndView errorHtml(HttpServletRequest request,
HttpServletResponse response) {
HttpStatus status = getStatus(request);
Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(
request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
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, Object>> 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、ErrorPageCustomizer:

@Value("${error.path:/error}")
private String path = "/error"; 系统出现错误以后来到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处理;

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

protected ModelAndView resolveErrorView(HttpServletRequest request,
HttpServletResponse response, HttpStatus status, Map<String, Object> model) {
//所有的ErrorViewResolver得到ModelAndView
for (ErrorViewResolver resolver : this.errorViewResolvers) {
ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
if (modelAndView != null) {
return modelAndView;
}
}
return null;
}

2)、如果定制错误响应:

1)、如何定制错误的页面;

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

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

页面能获取的信息;

timestamp:时间戳

status:状态码

error:错误提示

exception:异常对象

message:异常消息

errors:JSR303数据校验的错误都在这里

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

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

 

2)、如何定制错误的json数据和页面;

1)、自定义异常处理&返回定制json数据;

首先放开拦截器;

这是controller

package com.pshdhx.controller;

import com.pshdhx.exception.UserNotExistException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

/**
* @Authtor pshdhx
* @Date 2020/11/220:57
* @Version 1.0
*/
@Controller
public class HelloWorld {
@RequestMapping("/hello")
@ResponseBody //内容写回给浏览器
public String hello(@RequestParam("user") String user){
if(user.equals("aaa")){
throw new UserNotExistException();
}
return "返回个浏览器的内容-helloworld";
}


/**
* //如果说静态资源文件和template中都有一个index页面,那么就不知道访问那个了,需要在controller中配置一个,很麻烦,需也可以配置一个视图映射
* @return
*/
// @RequestMapping({"/","/index.html"})
// public String index(){
// return "index";
// }
}

这是自定义exception

package com.pshdhx.exception;

/**
* @Authtor pshdhx
* @Date 2020/11/2921:48
* @Version 1.0
*/
public class UserNotExistException extends RuntimeException{
public UserNotExistException() {
super("自定义异常:用户不存在");
}

public UserNotExistException(String message) {
super(message);
}

public UserNotExistException(String message, Throwable cause) {
super(message, cause);
}

public UserNotExistException(Throwable cause) {
super(cause);
}

public UserNotExistException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
super(message, cause, enableSuppression, writableStackTrace);
}
}

这是使得exception生效

package com.pshdhx.controller;

import com.pshdhx.exception.UserNotExistException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;
import java.util.Map;

/**
* @Authtor pshdhx
* @Date 2020/11/2921:53
* @Version 1.0
*/
@ControllerAdvice
public class MyExceptionHandler {

//自定义异常处理&返回定制json数据;无论是移动端环视PC端,都是返回的json数据,没有定制化
@ResponseBody
@ExceptionHandler(UserNotExistException.class)
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;
}
}

springboot的错误处理机制(全)_spring boot_04

springboot的错误处理机制(全)_spring boot_05

使得浏览器错误返回定制页面,postman错误返回定制json

//转发到/error进行自适应响应效果处理  Pc端返回页面,postman返回json
@ExceptionHandler(UserNotExistException.class)
public String handleException(Exception e, HttpServletRequest request){
Map<String,Object> map = new HashMap<>();
//传入我们自己的错误状态码 4xx 5xx,否则就不会进入定制错误页面的解析流程
/**
* Integer statusCode = (Integer) request
.getAttribute("javax.servlet.error.status_code");
*/
request.setAttribute("javax.servlet.error.status_code",500);
map.put("code","user.notexist");
map.put("message",e.getMessage());
//转发到/error
return "forward:/error";
}

 

springboot的错误处理机制(全)_html_06

springboot的错误处理机制(全)_spring boot_07

3)、将我们的定制数据携带出去;

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

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

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

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

自定义ErrorAttributes

package com.pshdhx.component;

import org.springframework.boot.web.servlet.error.DefaultErrorAttributes;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.WebRequest;

import java.util.Map;

/**
* @Authtor pshdhx
* @Date 2020/11/2922:10
* @Version 1.0
*/
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
@Override
public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
Map<String, Object> map = super.getErrorAttributes(webRequest, includeStackTrace);
map.put("user","pshdhx");
//我们的异常处理器携带的数据
Object ext = webRequest.getAttribute("ext", 0);
map.put("ext",ext);
return map;
}
}

 

//转发到/error进行自适应响应效果处理  Pc端返回页面,postman返回json
@ExceptionHandler(UserNotExistException.class)
public String handleException(Exception e, HttpServletRequest request){
Map<String,Object> map = new HashMap<>();
//传入我们自己的错误状态码 4xx 5xx,否则就不会进入定制错误页面的解析流程
/**
* Integer statusCode = (Integer) request
.getAttribute("javax.servlet.error.status_code");
*/
request.setAttribute("javax.servlet.error.status_code",500);
map.put("code","user.notexist");
map.put("message",e.getMessage());
request.setAttribute("ext",map);
//转发到/error
return "forward:/error";
}

500.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h1>status:[[${status}]];<h1/>
<h1>timestamp:[[${timestamp}]];<h1/>
<h1>message:[[${message}]];<h1/>
<h2>exe:[[${ext.code}]]</h2>
</body>
</html>

springboot的错误处理机制(全)_错误页面_08

springboot的错误处理机制(全)_错误页面_09

github:​https://github.com/pshdhx/springbootcurd​

举报

相关推荐

0 条评论