快捷導(dǎo)航

Spring一步到位精通攔截器

更新時(shí)間：2023年01月16日 09:52:31 作者：不死鳥(niǎo).亞歷山大.狼崽子

攔截器（Interceptor）是一種動(dòng)態(tài)攔截方法調(diào)用的機(jī)制，在SpringMVC中動(dòng)態(tài)攔截控制器方法的執(zhí)行。本文將詳細(xì)講講SpringMVC中攔截器的概念及入門案例，感興趣的可以嘗試一下

1 攔截器

攔截器是Spring中的概念，和過(guò)濾器類似，可以對(duì)用戶請(qǐng)求進(jìn)行攔截過(guò)濾處理。但是相對(duì)于過(guò)濾器而言，攔截器要的控制更加的細(xì)節(jié)，攔截器可以在三個(gè)地方進(jìn)行執(zhí)行：

可以在請(qǐng)求達(dá)到Controller控制器之前，通過(guò)攔截器執(zhí)行一段代碼
也可以在控制器執(zhí)行之后，通過(guò)攔截器執(zhí)行一段代碼，此時(shí)只是Controller執(zhí)行完畢視圖還沒(méi)有開(kāi)始渲染
最后在整個(gè)請(qǐng)求結(jié)束的時(shí)候還可以通過(guò)攔截器執(zhí)行一段代碼

使用攔截器的方法

創(chuàng)建支持它的@Component類，它應(yīng)該實(shí)現(xiàn)HandlerInterceptor接口
實(shí)現(xiàn)WebMVCConfigure配置器，注冊(cè)到spring容器中，添加攔截路徑和放行路徑

攔截器和過(guò)濾器的區(qū)別：

攔截器（Interceptor）類似于Servlet中的過(guò)濾器( Filter)，它主要用于攔截用戶請(qǐng)求并做相應(yīng)的處理。

過(guò)濾器只能在容器初始化時(shí)被調(diào)用異常，在action的生命周期中，而攔截器可以多次被調(diào)用。
過(guò)濾器可以對(duì)幾乎所有的請(qǐng)求起作用，攔截器只能對(duì)action請(qǐng)求起作用。
過(guò)濾器不能訪問(wèn)action上下文、堆棧里的對(duì)象，而攔截器可以訪問(wèn)。
過(guò)濾器是基于函數(shù)回調(diào)，而攔截器不依賴與servlet容器。
過(guò)濾器不能獲取IOC容器中的各個(gè)bean，而攔截器可以，這點(diǎn)很重要，在攔截器里注入一個(gè)service，可以調(diào)用業(yè)務(wù)邏輯

攔截器是在DispatcherServlet這個(gè)servlet中執(zhí)行的，因此所有的請(qǐng)求最先進(jìn)入Filter，最后離開(kāi)Filter。其順序如下。

Filter->Interceptor.preHandle->Handler->Interceptor.postHandle->Interceptor.afterCompletion->Filter

2 實(shí)現(xiàn)流程

2.1 引入依賴

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

2.2 自定義攔截器

package com.example.demo.Interceptor;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Component
public class EasyLogControllerInterceptor implements HandlerInterceptor {
    /**
     * 在controller調(diào)用之前執(zhí)行
     */
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        System.out.println(request.getRequestURI()+"開(kāi)始執(zhí)行");
        return true;
    }
    /**
     * 在controller調(diào)用中執(zhí)行
     */
    public void postHandle(
            HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
            throws Exception {
        System.out.println(request.getRequestURI()+"執(zhí)行中");
    }
    /**
     * 在controller調(diào)用后執(zhí)行
     */
    public void afterCompletion(
            HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println(request.getRequestURI()+"執(zhí)行結(jié)束");
     }
}

2.3 注入適配器

package com.example.demo.Interceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class IntercepterConfig implements WebMvcConfigurer {
    @Autowired
    private EasyLogControllerInterceptor easyLogControllerInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //addPathPatterns用于添加攔截路徑
        //excludePathPatterns用于添加不攔截的路徑
        registry.addInterceptor(easyLogControllerInterceptor).addPathPatterns("/hello");
    }
    //此方法用于配置靜態(tài)資源路徑
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations("classpath:/my/");
    }
}

執(zhí)行結(jié)果如下：