zoukankan      html  css  js  c++  java
  • 4_6.springboot2.xWeb开发之错误处理机制

    1、SpringBoot默认的错误处理机制

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

    在这里插入图片描述

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

    在这里插入图片描述

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

    在这里插入图片描述

    在这里插入图片描述

    原理:

    ​ 默认情况下,Spring Boot提供/error 映射,以合理的方式处理所有错误,并在servlet容器中注册为“全局”错误页面。对于计算机客户端,它会生成一个JSON响应,其中包含错误,HTTP状态和异常消息的详细信息。

    对于浏览器客户端,有一个“whitelabel”错误视图,以HTML格式呈现相同的数据(要自定义它,添加一个解析
    为error 的View )。要完全替换默认行为,您可以实现ErrorController 并注册该类型的bean定义或添加bean类型ErrorAttributes 以使用现有机制但替换内容。

    ​ 要完全替换默认行为,您可以实现ErrorController 并注册该类型的bean定义或添加bean类型ErrorAttributes 以使用现有机制但替换内容。
    BasicErrorController 可以用作自定义ErrorController 的基类。如果要为新内容类型添加处理程序,则此功能特别有用(默认情况下,专门处理text/html 并为其他所有内容提供后备)。为此,请扩展BasicErrorController ,添加具有produces 属性的@RequestMapping 的公共方法,并创
    建新类型的bean。

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

    给容器中添加了以下组件
    

    1、DefaultErrorAttributes:

    	@Override
    	public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
    		Map<String, Object> errorAttributes = new LinkedHashMap<>();
    		errorAttributes.put("timestamp", new Date());
    		addStatus(errorAttributes, webRequest);
    		addErrorDetails(errorAttributes, webRequest, includeStackTrace);
    		addPath(errorAttributes, webRequest);
    		return errorAttributes;
    	}
    

    注意调用顺序:

    在BasicErrorController:(@RequestMapping(produces = MediaType.TEXT_HTML_VALUE))

    Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(request, isIncludeStackTrace(request, MediaType.TEXT_HTML)))
    

    点进去到:AbstractErrorController中

    protected Map<String, Object> getErrorAttributes(HttpServletRequest request, boolean includeStackTrace) {   WebRequest webRequest = new ServletWebRequest(request);   return this.errorAttributes.getErrorAttributes(webRequest, includeStackTrace);}
    

    ​ 再点进去到ErrorAttributes接口中,观察实现类,帮我们在页面共享信息

    @Order(Ordered.HIGHEST_PRECEDENCE)public class DefaultErrorAttributes implements ErrorAttributes, HandlerExceptionResolver, Ordered {
        
        @Override
    	public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
    		Map<String, Object> errorAttributes = new LinkedHashMap<>();
    		errorAttributes.put("timestamp", new Date());
    		addStatus(errorAttributes, webRequest);
    		addErrorDetails(errorAttributes, webRequest, includeStackTrace);
    		addPath(errorAttributes, webRequest);
    		return errorAttributes;
    	} 
    }
    

    2、BasicErrorController:

    处理默认/error请求

    @Controller
    @RequestMapping("${server.error.path:${error.path:/error}}")
    public class BasicErrorController extends AbstractErrorController {
        //产生html类型的数据;浏览器发送的请求来到这个方法处理
        @RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
    	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) ? modelAndView : new ModelAndView("error", model);
    	}
        
        //产生json数据,其他客户端来到这个方法处理;
    	@RequestMapping
    	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<>(body, status);
    	}
        
    }
    

    3、ErrorPageCustomizer:

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

    private static class ErrorPageCustomizer implements ErrorPageRegistrar, Ordered {
    
    		private final ServerProperties properties;
    
    		private final DispatcherServletPath dispatcherServletPath;
    
    		protected ErrorPageCustomizer(ServerProperties properties, DispatcherServletPath dispatcherServletPath) {
    			this.properties = properties;
    			this.dispatcherServletPath = dispatcherServletPath;
    		}
    
    		@Override
    		public void registerErrorPages(ErrorPageRegistry errorPageRegistry) {
                //系统出现错误来到error请求处理
    			ErrorPage errorPage = new ErrorPage(
    					this.dispatcherServletPath.getRelativePath(this.properties.getError().getPath()));
    			errorPageRegistry.addErrorPages(errorPage);
    		}
    
    		@Override
    		public int getOrder() {
    			return 0;
    		}
    
    	}
    
    
     */
    	@Value("${error.path:/error}")
    	private String path = "/error";
    

    4、DefaultErrorViewResolver:

    public class DefaultErrorViewResolver implements ErrorViewResolver, Ordered {
    
    	private static final Map<Series, String> SERIES_VIEWS;
    
    	static {
    		Map<Series, String> views = new EnumMap<>(Series.class);
    		views.put(Series.CLIENT_ERROR, "4xx");
    		views.put(Series.SERVER_ERROR, "5xx");
    		SERIES_VIEWS = Collections.unmodifiableMap(views);
    	}
        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);
    	}
    
    	private ModelAndView resolveResource(String viewName, Map<String, Object> model) {
            //静态资源文件夹下 404.html
    		for (String location : this.resourceProperties.getStaticLocations()) {
    			try {
    				Resource resource = this.applicationContext.getResource(location);
    				resource = resource.createRelative(viewName + ".html");
    				if (resource.exists()) {
    					return new ModelAndView(new HtmlResourceView(resource), model);
    				}
    			}
    			catch (Exception ex) {
    			}
    		}
    		return null;
    	}
        
        
        
        
    }
    
    

    调用步骤:

    ​ 一但系统出现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数据;

    还可以定义使用@ControllerAdvice 注释的类,以自定义要为特定控制器和/或异常类型返回的JSON数据

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

    @ControllerAdvice
    public class MyExceptionHandler {
        /*
         * @Author: jiatp
         * Description:返回的是json数据
        */
        @ResponseBody
        @ExceptionHandler(UserNotExistException.class)
        public  Map<String,Object> handlerException(Exception e){
            Map<String,Object> map = new HashMap<>();
            map.put("code","user.notexist");
            map.put("message",e.getMessage());
    
            return map;
        }        
      }
    

    缺点:没有自适应效果…即浏览器访问返回页面,其他客户端访问返回json数据

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

    package com.spboot.springboot04.controller;
    
    import com.spboot.springboot04.exception.UserNotExistException;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    import javax.servlet.http.HttpServletRequest;
    import java.util.HashMap;
    import java.util.Map;
    
    /*
     * @Author: jiatp
     * Description:自定义异常处理器
    */
    @ControllerAdvice
    public class MyExceptionHandler {
       
        @ExceptionHandler(UserNotExistException.class)
        public  String handlerException(Exception e, HttpServletRequest request){
            Map<String,Object> map = new HashMap<>();
            map.put("code","user.notexist");
            map.put("message",e.getMessage());
    
            //传入自己的错误状态码 4xx,5XX
            /*
           Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");
           */
            request.setAttribute("javax.servlet.error.status_code",500);
            request.setAttribute("ext",map);
            //转发到/error
            return "forward:/error";
        }
    }
    
    

    转发到/error请求由BasicErrorController处理, 传入自己的错误状态码 4xx,5XX,不传的话是200

    Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");
    

    request中放入请求状态码

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

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

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

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

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

    查看AbstractErrorController

    protected Map<String, Object> getErrorAttributes(HttpServletRequest request, boolean includeStackTrace) {
    		WebRequest webRequest = new ServletWebRequest(request);
    		return this.errorAttributes.getErrorAttributes(webRequest, includeStackTrace);
    	}
    

    给容器中加入我们自己定义的ErrorAttributes

    @Component
    public class MyErrorAttributes extends DefaultErrorAttributes {
    
        /*给容器中加入我们自己定义的ErrorAttributes
         * @Author: jiatp
         * Description:返回值的map就是页面和json获取的所有字段
        */
        @Override
        public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
            Map<String, Object> map =super.getErrorAttributes(webRequest, includeStackTrace);
            map.put("company","jiatp");
            //我们异常处理器携带的数据
            Map<String,Object> ext =(Map) webRequest.getAttribute("ext",0);
            map.put("ext",ext);
            return map;
        }
    }
    
    

    返回值的map就是页面和json获取的所有字段,最终的效果:响应是自适应的,可以通过定制ErrorAttributes改变需要返回的内容。

  • 相关阅读:
    TCP/IP的基本概念知识
    Mysql查询今天、昨天、7天、近30天、本月、上一月数据
    PHP OOP面向对象部分方法归总(代码实例子)
    PHP 变量
    PHP超级全局变量、魔术变量和魔术函数
    PHP编程效率的20个要点
    MemCache超详细解读
    CodeForces 652E Pursuit For Artifacts 边双连通分量
    HDU 2460 Network 边双连通分量 缩点
    HDU 3594 Cactus 有向仙人掌图判定
  • 原文地址:https://www.cnblogs.com/jatpeo/p/11767481.html
Copyright © 2011-2022 走看看