SpringBoot自定义错误页面

灰太狼 2022-03-11 07:49 347阅读 0赞

## 一.错误处理机制 ##

### 1.SpringBoot默认的错误处理机制 ###

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3htMzkzMzkyNjI1_size_16_color_FFFFFF_t_70][]

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

![20190307161428868.png][]

3）、SpringBoot如何区别是浏览器还是其他客户端

它是通过分析请求头来处理的

如果是浏览器：

![20190307161732139.png][]

如果是其他客户端：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3htMzkzMzkyNjI1_size_16_color_FFFFFF_t_70 1][]

### 2. 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;
    }
    ...

BasicErrorController：处理默认/error请求 (当请求出错时会发送一个/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);
    	}
    ```

ErrorPageCustomizer：定制错误的响应规则

@Value("${error.path:/error}")
    	private String path = "/error";  系统出现错误以后来到error请求进行处理

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请求，就会被BasicErrorControlle处理，然后DefaultErrorViewResolver解析得到的响应页面

### 3.自定义错误响应 ###

1）、如何定制错误的页面：

有模板引擎的情况下：

将错误页面命名为“**错误状态码.html** ”放在模板引擎文件夹里面的 error文件夹下发生此状态码的错误就会来到对应的页面

![20190307163712636.png][]

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

页面能获取的信息：

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

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

以上都没有错误页面，就是默认来到SpringBoot默认的错误提示页面；

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3htMzkzMzkyNjI1_size_16_color_FFFFFF_t_70]: /images/20220311/de5817cc667948d3bc9037fec0d0f5df.png
[20190307161428868.png]: /images/20220311/752110aa2f2a4cb8aeea52b9986bdb72.png
[20190307161732139.png]: /images/20220311/d62d994ddab548e0a6b675393879cd36.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3htMzkzMzkyNjI1_size_16_color_FFFFFF_t_70 1]: /images/20220311/9b7c45d3299d4cb29d4ba2fc15b66e39.png
[20190307163712636.png]: /images/20220311/527af7f046bb46bcafe0f896aec46a1d.png