SpringBoot2異常處理與web原生組件注入的方法

這篇文章主要介紹“SpringBoot2異常處理與web原生組件注入的方法”的相關(guān)知識(shí)，小編通過實(shí)際案例向大家展示操作過程，操作方法簡(jiǎn)單快捷，實(shí)用性強(qiáng)，希望這篇“SpringBoot2異常處理與web原生組件注入的方法”文章能幫助大家解決問題。

1 異常處理

??默認(rèn)情況下，SpringBoot會(huì)提供/error處理所有的錯(cuò)誤請(qǐng)求并返回相應(yīng)的信息，對(duì)于瀏覽器客戶端來說會(huì)返回一個(gè)包含時(shí)間戳、狀態(tài)碼、錯(cuò)誤信息、攜帶的自定義異常信息、發(fā)生錯(cuò)誤的路徑等信息的錯(cuò)誤Whitelabel頁面，對(duì)于機(jī)器客戶端(postman等)會(huì)返回一個(gè)包含以上內(nèi)容的JSON數(shù)據(jù)

1.1 異常處理之錯(cuò)誤頁面

??要想替代之前瀏覽器客戶端返回的錯(cuò)誤Whitelabel頁面，需要將自定義的html頁面放在靜態(tài)資源static等的error文件夾下或者模板引擎templates的error文件夾下，這樣的話出現(xiàn)錯(cuò)誤時(shí)SpringBoot發(fā)送/error請(qǐng)求就會(huì)自動(dòng)解析這些頁面進(jìn)行渲染。頁面解析規(guī)則：先將狀態(tài)碼的值與error文件夾下的頁面名進(jìn)行精確匹配，如果精確匹配不到的話就按照4xx、5xx這樣的方式進(jìn)行模糊匹配，要是還匹配不到的話就返回Whitelabel頁面

1.2 異常處理之精確捕獲

??要是說錯(cuò)誤頁面是按照狀態(tài)碼進(jìn)行頁面處理的話，精確捕獲就是通過異常類進(jìn)行捕獲，捕獲之后再進(jìn)行一系列的自定義操作。具體步驟就是：創(chuàng)建一個(gè)異常處理器類，并在類上加@ControllerAdvice注解表明是一個(gè)異常處理器并向容器中注冊(cè)該組件，@ExceptionHandler注解對(duì)參數(shù)中的異常類進(jìn)行精準(zhǔn)捕獲，并在方法體定義具體的處理操作。

@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler({ArithmeticException.class, NullPointerException.class})
    public String handleArithException(Exception e) {
        log.info("系統(tǒng)捕獲到異常信息：{}", e);
        return "login";
    }
}

1.3 異常處理之自定義異常

??有時(shí)候我們需要在程序中自定義一些運(yùn)行時(shí)異常，這些異常并不會(huì)像那些異常一樣產(chǎn)生異常狀態(tài)碼，甚至在未定義之前都不算是異常且不會(huì)影響程序的正常運(yùn)行。這時(shí)就需要我們自定義異常的產(chǎn)生邏輯，并自定義異常類創(chuàng)建有參無參構(gòu)造器，在類上加@ResponseStatus注解，使用注解參數(shù)定義異常響應(yīng)碼和異常信息

@ResponseStatus(value = HttpStatus.FORBIDDEN, reason = "用戶數(shù)量太多")
public class UserTooManyException extends RuntimeException{

    public UserTooManyException() {

    }
    public UserTooManyException(String message) {
        super(message);
    }
}

異常產(chǎn)生邏輯：

// 判斷用戶數(shù)量拋出用戶數(shù)量過多的自定義異常
if (users.size() > 3) {
    throw new UserTooManyException();
}

1.4 異常處理之框架底層異常

??除了exception類中定義的異常外，spring框架底層也定義了一些異常，這些異常由DefaultHandlerExceptionResolver來處理

2 web原生組件的注入

2.1 servlet組件

??servlet組件需要自定義創(chuàng)建一個(gè)servlet類繼承HttpServlet，并使用@WebServlet注解的urlPatterns屬性聲明攔截的請(qǐng)求，再通過主程序類上使用@ServletComponentScan(basePackages = “…”)注解將該組件掃描注冊(cè)到容器中。

// 聲明攔截的請(qǐng)求
@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組件需要自定義創(chuàng)建一個(gè)filter類實(shí)現(xiàn)Filter接口，并使用@WebFilter注解的urlPatterns屬性聲明過濾的請(qǐng)求

@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組件需要自定義創(chuàng)建一個(gè)listener類實(shí)現(xiàn)ServletContextListener 接口，并使用@WebListener注解

@Slf4j
@WebListener
public class MyServletContextListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        log.info("MyServletContextListener監(jiān)聽到項(xiàng)目初始化完成……");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        log.info("MyServletContextListener監(jiān)聽到項(xiàng)目已經(jīng)銷毀……");
    }
}

除了使用注解進(jìn)行注冊(cè)之外，還可以使用配置類的方式將以上三種組件注冊(cè)到容器中去

@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請(qǐng)求并不會(huì)經(jīng)過spring的攔截器攔截處理，而是直接交由tomcat服務(wù)器進(jìn)行處理：現(xiàn)在有這么兩個(gè)組件攔截到我們發(fā)送的/my請(qǐng)求，一個(gè)是spring的組件DispatcherServlet通過/路徑攔截到，一個(gè)是tomcat的自定義MyServlet組件通過/my路徑攔截到。tomcat服務(wù)器對(duì)請(qǐng)求有這么一個(gè)處理規(guī)則，當(dāng)多個(gè)servlet組件都能處理到同一個(gè)請(qǐng)求的時(shí)候，使用匹配度最高的組件進(jìn)行處理，也就是說處理請(qǐng)求的是tomcat的MyServlet組件。

關(guān)于“SpringBoot2異常處理與web原生組件注入的方法”的內(nèi)容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識(shí)，可以關(guān)注億速云行業(yè)資訊頻道，小編每天都會(huì)為大家更新不同的知識(shí)點(diǎn)。