SpringBoot2零基础到精通之异常处理与web原生组件注入

目录

• 1 异常处理
• 1.1 异常处理之错误页面
• 1.2 异常处理之精确捕获
• 1.3 异常处理之自定义异常
• 1.4 异常处理之框架底层异常
• 2 web原生组件的注入
• 2.1 servlet组件
• 2.2 filter组件
• 2.3 listener组件
• 3 web实现定制化总结

1 异常处理

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

1.1 异常处理之错误页面

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

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.4 异常处理之框架底层异常

  除了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的所有自动配置全部失效，全部功能都需要自己进行配置。大佬专属注解，小白的禁术！！！

到此这篇关于SpringBoot2零基础到精通之异常处理与web原生组件注入的文章就介绍到这了,更多相关SpringBoot2 异常处理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！