SpringBoot框架学习(五)——Web(下)

最新推荐文章于 2024-05-29 16:46:55 发布

2NaCl

最新推荐文章于 2024-05-29 16:46:55 发布

阅读量370

点赞数 1

分类专栏： javaWeb 文章标签： SpringBoot

本文链接：https://blog.csdn.net/qq_41936805/article/details/86759807

版权

javaWeb 专栏收录该内容

34 篇文章 3 订阅

订阅专栏

文章目录

八、错误处理机制
- 1.SpringBoot的默认处理机制
- - 2.自定义错误响应
  - - <1>如何定制错误的页面
    - <2>如何定制错误的json数据
九、嵌入式Servlet容器
- - 1.如何定制和修改Servlet容器的相关配置？
  - 2.注册Servlet三大组件【Servlet、Filter、Listener】

八、错误处理机制

1.SpringBoot的默认处理机制

默认效果：
1）、浏览器，返回一个默认的错误页面
2）、如果是其他客户端，默认响应一个json数据
原理：

可以参照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.有模板引擎的情况下自拟【status】.html 到resource/error/目录下，便会自动来到对应的页面，当拟定了4xx.html和5xx.html的时候，在没有确切自定义error的html的情况下便会来到这两个网页

而我们自定义的页面也要拥有：
timestamp：时间戳
status：状态码
error：错误提示
exception：异常对象
message：异常消息
2.没有模板引擎的情况下放入静态资源文件夹下，SpringBoot会自动进行查询

<2>如何定制错误的json数据

public class UserNotExistException extends RuntimeException{
    public UserNotExistException() {
        super("用户不存在");
    }
}

//和我们之前写的发送hello请求的可以进行简单的模拟
	@ResponseBody
    @RequestMapping("/hello")
    public String hello(@RequestParam("user") String user) {
        if(user.equals("aaa")){
            throw new UserNotExistException();
        }
        return "hello world";
    }

但我们现在想用自己的json格式，那就要这样

@ControllerAdvice
public class MyExceptionHandler {

    /**
     * 针对某个类json数据报告异常
     * @param e
     * @return
     */
    @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;
    }
}

但是若是要把当前错误做成自适应就要

//自适应效果
    @ExceptionHandler(UserNotExistException.class)
    public String handleException(Exception e){
        Map<String, Object> map = new HashMap<>();
        map.put("code", "user.notexist");
        map.put("message", e.getMessage());
        //转发到/error
        return "forward:/error";
    }

将定制的数据携带出去
出现错误之后，回来到/error请求，被BasicErrorController处理，响应出去可以获取的数据是由getErrorAttributes得到的（是AbstractErrorController(ErrorController)规定的方法）；
1、完全来编写一个ErrorController的实现类【或者是编写AbstractErrorController的子类】，放在容器中；

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

容器中DefaultErrorAttributes.getErrorAttributes()；默认进行数据处理的；
自定义一个ErrorAttributes

//给容器中加入我们自己定义的错误属性
public class MyErrorContributes extends DefaultErrorAttributes {
    //这个map返回的就是页面和json能获取的所有字段
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        Map<String, Object> map = super.getErrorAttributes(webRequest, includeStackTrace);
        map.put("company", "Alibaba");

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

//自适应效果
    @ExceptionHandler(UserNotExistException.class)
    public String handleException(Exception e, HttpServletRequest request){
        Map<String, Object> map = new HashMap<>();
        //传入我们自己的错误状态码 4xx 5xx,否则不会进入错误页面的解析流程
        request.setAttribute("javax.servlet.error.status_code",400);

        map.put("code", "user.notexist");
        map.put("message", e.getMessage());
        request.setAttribute("ext",map);
        //转发到/error
        return "forward:/error";
    }

九、嵌入式Servlet容器

SpringBoot默认使用的是嵌入式Servlet容器(Tomcat)

1.如何定制和修改Servlet容器的相关配置？

1.修改和server相关的配置即可，在application.properties里面配置就行
server.xxx 是对Servlet容器的设置
server.tomcat.xxx是对Tomcat 设置
2、编写一个EmbeddedServletContainerCustomizer：嵌入式的Servlet容器的定制器；来修改Servlet容器的配置

@Bean  //一定要将这个定制器加入到容器中
public EmbeddedServletContainerCustomizer embeddedServletContainerCustomizer(){
    return new EmbeddedServletContainerCustomizer() {

        //定制嵌入式的Servlet容器相关的规则
        @Override
        public void customize(ConfigurableEmbeddedServletContainer container) {
            container.setPort(9996);
        }
    };
}

2.注册Servlet三大组件【Servlet、Filter、Listener】

在注册组件之前，我们要首先定制嵌入式Servlet容器相关的规则
在这里我们要注意，如果你用的是SpringBoot 2.x，下面不用管，但是如果是1.x，请使用EmbeddedServletContainerCustomer，其他的都一样
在我们的配置文件中添加这个类

@Configuration
public class MyServerConfig {

    @Bean
    public ConfigurableServletWebServerFactory configurableServletWebServerFactory(){
        TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
        factory.setPort(6666);
        return factory
    }
}

我们可以发现，定制器定制了一个port，而这个tomcat的port也是可以在application.properties中进行配置的。server.port=xxx即可
SpringBoot内，xxxxCustomizer更多的用于定制配置，而xxxConfigurer更多的用于扩展配置
准备工作做完，接下来开始注册三大组件了

ServletRegistrationBean

//注册三大组件
    @Bean
    public ServletRegistrationBean myServlet(){
        ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(new MyServlet(), "/myServlet");
        servletRegistrationBean.setLoadOnStartup(1);
        return servletRegistrationBean;
    }

FilterRegistrationBean

@Bean
    public FilterRegistrationBean myFilter(){
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new Myfilter());
        filterRegistrationBean.setUrlPatterns(Arrays.asList("/hello", "myServlet"));
        return filterRegistrationBean;
    }

ServletListenerRegistrationBean

@Bean
  public ServletListenerRegistrationBean myListener(){
      ServletListenerRegistrationBean<MyListener> myListenerServletListenerRegistrationBean = new ServletListenerRegistrationBean<>(new MyListener());
      return myListenerServletListenerRegistrationBean;
  }