【SpringBoot 2】(九)异常处理 web原生组件的注入

简介: 【SpringBoot 2】(九)异常处理 web原生组件的注入

1 异常处理

 默认情况下,SpringBoot会提供/error处理所有的错误请求并返回相应的信息,对于浏览器客户端来说会返回一个包含时间戳、状态码、错误信息、携带的自定义异常信息、发生错误的路径等信息的错误Whitelabel页面,对于机器客户端(postman等)会返回一个包含以上内容的JSON数据


1.1 异常处理之错误页面

 要想替代之前浏览器客户端返回的错误Whitelabel页面,需要将自定义的html页面放在静态资源static等的error文件夹下或者模板引擎templates的error文件夹下,这样的话出现错误时SpringBoot发送/error请求就会自动解析这些页面进行渲染。页面解析规则:先将状态码的值与error文件夹下的页面名进行精确匹配,如果精确匹配不到的话就按照4xx、5xx这样的方式进行模糊匹配,要是还匹配不到的话就返回Whitelabel页面

image.png

1.2 异常处理之精确捕获

 要是说错误页面是按照状态码进行页面处理的话,精确捕获就是通过异常类进行捕获,捕获之后再进行一系列的自定义操作。具体步骤就是:创建一个异常处理器类,并在类上加@ControllerAdvice注解表明是一个异常处理器并向容器中注册该组件,@ExceptionHandler注解对参数中的异常类进行精准捕获,并在方法体定义具体的处理操作。


@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler({ArithmeticException.class, NullPointerException.class})
    public String handleArithException(Exception e) {
        log.info("系统捕获到异常信息:{}", e);
        return "login";
    }
}


1.3 异常处理之自定义异常

 有时候我们需要在程序中自定义一些运行时异常,这些异常并不会像那些异常一样产生异常状态码,甚至在未定义之前都不算是异常且不会影响程序的正常运行。这时就需要我们自定义异常的产生逻辑,并自定义异常类创建有参无参构造器,在类上加@ResponseStatus注解,使用注解参数定义异常响应码和异常信息


@ResponseStatus(value = HttpStatus.FORBIDDEN, reason = "用户数量太多")
public class UserTooManyException extends RuntimeException{
    public UserTooManyException() {
    }
    public UserTooManyException(String message) {
        super(message);
    }
}


异常产生逻辑:


// 判断用户数量抛出用户数量过多的自定义异常
if (users.size() > 3) {
    throw new UserTooManyException();
}


1.3 异常处理之框架底层异常

 除了exception类中定义的异常外,spring框架底层也定义了一些异常,这些异常由DefaultHandlerExceptionResolver来处理


2 web原生组件的注入

2.1 servlet组件

 servlet组件需要自定义创建一个servlet类继承HttpServlet,并使用@WebServlet注解的urlPatterns属性声明拦截的请求,再通过主程序类上使用@ServletComponentScan(basePackages = “…”)注解将该组件扫描注册到容器中。


// 声明拦截的请求
@WebServlet(urlPatterns = "/my")
public class MyServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.getWriter().write("385695");
    }
}


2.2 filter组件

 filter组件需要自定义创建一个filter类实现Filter接口,并使用@WebFilter注解的urlPatterns属性声明过滤的请求


@Slf4j
@WebFilter(urlPatterns = {"/css/*", "/images/*"})
public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("MyFilter初始化……");
    }
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        log.info("MyFilter方法开始工作了……");
        filterChain.doFilter(servletRequest, servletResponse);
    }
    @Override
    public void destroy() {
        log.info("MyFilter销毁了……");
    }
}


2.3 listener组件

 listener组件需要自定义创建一个listener类实现ServletContextListener 接口,并使用@WebListener注解


@Slf4j
@WebListener
public class MyServletContextListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        log.info("MyServletContextListener监听到项目初始化完成……");
    }
    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        log.info("MyServletContextListener监听到项目已经销毁……");
    }
}


除了使用注解进行注册之外,还可以使用配置类的方式将以上三种组件注册到容器中去


@Configuration
public class MyRegistConfig {
    @Bean
    public ServletRegistrationBean MyServlet() {
        MyServlet myServlet = new MyServlet();
        return new ServletRegistrationBean(myServlet, "/my", "/my02");
    }
    @Bean
    public FilterRegistrationBean myFilter() {
        MyFilter myFilter = new MyFilter();
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(myFilter);
        filterRegistrationBean.setUrlPatterns(Arrays.asList("/my", "/my02"));
        return filterRegistrationBean;
    }
    @Bean
    public ServletListenerRegistrationBean myListener() {
        MyServletContextListener listener = new MyServletContextListener();
        return new ServletListenerRegistrationBean(listener);
    }
}


 通过servlet组件声明的/my请求并不会经过spring的拦截器拦截处理,而是直接交由tomcat服务器进行处理:现在有这么两个组件拦截到我们发送的/my请求,一个是spring的组件DispatcherServlet通过/路径拦截到,一个是tomcat的自定义MyServlet组件通过/my路径拦截到。tomcat服务器对请求有这么一个处理规则,当多个servlet组件都能处理到同一个请求的时候,使用匹配度最高的组件进行处理,也就是说处理请求的是tomcat的MyServlet组件。


3 web实现定制化总结

创建配置类实现WebMvcConfigurer接口,重写相应的方法或者使用@Bean注解向容器中扩展功能(使用的最多)

自定义配置类使用@Bean注解使用自定义的web原生组件替换容器中的默认组件或者向容器中添加组件

配置文件的配置项修改

xxxCustomizer

@EnableWebMvc注解表示全面接管SpringMVC,导致的效果就是SpringBoot的所有自动配置全部失效,全部功能都需要自己进行配置。大佬专属注解,小白的禁术!!!


相关文章
|
3月前
|
Java 开发者 UED
Spring Boot的全局异常处理机制
【2月更文挑战第13天】
235 0
|
存储 JSON 前端开发
SpringBoot + Vue前后端分离开发:全局异常处理及统一结果封装
SpringBoot + Vue前后端分离开发:全局异常处理及统一结果封装的实现
1004 0
SpringBoot + Vue前后端分离开发:全局异常处理及统一结果封装
|
2天前
|
前端开发 JavaScript Java
Web中的异常处理
Web中的异常处理
|
19天前
|
开发框架 JSON 前端开发
利用过滤器Filter和特性Attribute实现对Web API返回结果的封装和统一异常处理
利用过滤器Filter和特性Attribute实现对Web API返回结果的封装和统一异常处理
|
1月前
|
网络协议 安全 Python
我们将使用Python的内置库`http.server`来创建一个简单的Web服务器。虽然这个示例相对简单,但我们可以围绕它展开许多讨论,包括HTTP协议、网络编程、异常处理、多线程等。
我们将使用Python的内置库`http.server`来创建一个简单的Web服务器。虽然这个示例相对简单,但我们可以围绕它展开许多讨论,包括HTTP协议、网络编程、异常处理、多线程等。
|
3月前
|
前端开发 Java 程序员
Spring Boot统一功能处理(拦截器, 统一数据返回格式, 统一异常处理)
Spring Boot统一功能处理(拦截器, 统一数据返回格式, 统一异常处理)
53 1
|
3月前
|
JSON 监控 Java
Java Web开发中的异常处理与日志记录最佳实践
Java Web开发中的异常处理与日志记录最佳实践
|
3月前
|
Java 数据格式 Spring
SpringBoot统一功能处理(统⼀⽤户登录权限验证、统⼀异常处理、统⼀数据格式封装)
SpringBoot统一功能处理(统⼀⽤户登录权限验证、统⼀异常处理、统⼀数据格式封装)
|
存储 运维 Java
SpringBoot 统一异常处理(附核心工具类-ErrorInfoBuilder) 1
SpringBoot 统一异常处理(附核心工具类-ErrorInfoBuilder)
|
前端开发 JavaScript Java
SpringBoot 统一功能处理:用户登录权限校验-拦截器、异常处理、数据格式返回
本篇将要学习 Spring Boot 统一功能处理模块,这也是 AOP 的实战环节 用户登录权限的校验实现接口 HandlerInterceptor + WebMvcConfigurer 异常处理使用注解 @RestControllerAdvice + @ExceptionHandler 数据格式返回使用注解 @ControllerAdvice 并且实现接口 @ResponseBodyAdvice
509 0