Java中過(guò)濾器 (Filter) 和 攔截器 (Interceptor)的使用

目錄

1.過(guò)濾器 (Filter)

過(guò)濾器的配置比較簡(jiǎn)單，直接實(shí)現Filter 接口即可，也可以通過(guò)@WebFilter注解實(shí)現對特定URL攔截，看到Filter 接口中定義了三個(gè)方法。

• init() ：該方法在容器啟動(dòng)初始化過(guò)濾器時(shí)被調用，它在 Filter 的整個(gè)生命周期只會(huì )被調用一次。注意：這個(gè)方法必須執行成功，否則過(guò)濾器會(huì )不起作用。
• doFilter() ：容器中的每一次請求都會(huì )調用該方法， FilterChain 用來(lái)調用下一個(gè)過(guò)濾器 Filter。
• destroy()： 當容器銷(xiāo)毀 過(guò)濾器實(shí)例時(shí)調用該方法，一般在方法中銷(xiāo)毀或關(guān)閉資源，在過(guò)濾器 Filter 的整個(gè)生命周期也只會(huì )被調用一次

@Component
public class MyFilter implements Filter {
 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

        System.out.println("Filter 前置");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

        System.out.println("Filter 處理中");
        filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void destroy() {

        System.out.println("Filter 后置");
    }
}

2.攔截器 (Interceptor)

攔截器它是鏈式調用，一個(gè)應用中可以同時(shí)存在多個(gè)攔截器Interceptor， 一個(gè)請求也可以觸發(fā)多個(gè)攔截器 ，而每個(gè)攔截器的調用會(huì )依據它的聲明順序依次執行。首先編寫(xiě)一個(gè)簡(jiǎn)單的攔截器處理類(lèi)，請求的攔截是通過(guò)HandlerInterceptor 來(lái)實(shí)現，看到HandlerInterceptor 接口中也定義了三個(gè)方法。

• preHandle() ：這個(gè)方法將在請求處理之前進(jìn)行調用。注意：如果該方法的返回值為false ,將視為當前請求結束，不僅自身的攔截器會(huì )失效，還會(huì )導致其他的攔截器也不再執行。
• postHandle()：只有在 preHandle() 方法返回值為true 時(shí)才會(huì )執行。會(huì )在Controller 中的方法調用之后，DispatcherServlet 返回渲染視圖之前被調用。 有意思的是：postHandle() 方法被調用的順序跟 preHandle() 是相反的，先聲明的攔截器 preHandle() 方法先執行，而postHandle()方法反而會(huì )后執行。
• afterCompletion()：只有在 preHandle() 方法返回值為true 時(shí)才會(huì )執行。在整個(gè)請求結束之后， DispatcherServlet 渲染了對應的視圖之后執行。

@Component
public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        System.out.println("Interceptor 前置");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

        System.out.println("Interceptor 處理中");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

        System.out.println("Interceptor 后置");
    }
}

將自定義好的攔截器處理類(lèi)進(jìn)行注冊，并通過(guò)addPathPatterns、excludePathPatterns等屬性設置需要攔截或需要排除的 URL。

@Configuration
public class MyMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
        registry.addInterceptor(new MyInterceptor1()).addPathPatterns("/**");
    }
}

3.區別

過(guò)濾器 和 攔截器 均體現了AOP的編程思想，都可以實(shí)現諸如日志記錄、登錄鑒權等功能，但二者的不同點(diǎn)也是比較多的，接下來(lái)一一說(shuō)明。

3.11、實(shí)現原理不同

過(guò)濾器和攔截器 底層實(shí)現方式大不相同，過(guò)濾器 是基于函數回調的，攔截器 則是基于Java的反射機制（動(dòng)態(tài)代理）實(shí)現的。這里重點(diǎn)說(shuō)下過(guò)濾器！在我們自定義的過(guò)濾器中都會(huì )實(shí)現一個(gè) doFilter()方法，這個(gè)方法有一個(gè)FilterChain 參數，而實(shí)際上它是一個(gè)回調接口。ApplicationFilterChain是它的實(shí)現類(lèi)， 這個(gè)實(shí)現類(lèi)內部也有一個(gè) doFilter() 方法就是回調方法。

public interface FilterChain {
    void doFilter(ServletRequest var1, ServletResponse var2) throws IOException, ServletException;
}

ApplicationFilterChain里面能拿到我們自定義的xxxFilter類(lèi)，在其內部回調方法doFilter()里調用各個(gè)自定義xxxFilter過(guò)濾器，并執行 doFilter() 方法。

public final class ApplicationFilterChain implements FilterChain {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response) {
            ...//省略
            internalDoFilter(request,response);
    }
 
    private void internalDoFilter(ServletRequest request, ServletResponse response){
    if (pos < n) {
            //獲取第pos個(gè)filter    
            ApplicationFilterConfig filterConfig = filters[pos++];        
            Filter filter = filterConfig.getFilter();
            ...
            filter.doFilter(request, response, this);
        }
    }
 
}

而每個(gè)xxxFilter 會(huì )先執行自身的 doFilter() 過(guò)濾邏輯，最后在執行結束前會(huì )執行filterChain.doFilter(servletRequest, servletResponse)，也就是回調ApplicationFilterChain的doFilter() 方法，以此循環(huán)執行實(shí)現函數回調。

 @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

        filterChain.doFilter(servletRequest, servletResponse);
    }

3.2 使用范圍不同

我們看到過(guò)濾器 實(shí)現的是 javax.servlet.Filter 接口，而這個(gè)接口是在Servlet規范中定義的，也就是說(shuō)過(guò)濾器Filter 的使用要依賴(lài)于Tomcat等容器，導致它只能在web程序中使用。

而攔截器(Interceptor) 它是一個(gè)Spring組件，并由Spring容器管理，并不依賴(lài)Tomcat等容器，是可以單獨使用的。不僅能應用在web程序中，也可以用于A(yíng)pplication、Swing等程序中。

3.3 觸發(fā)時(shí)機不同

過(guò)濾器Filter是在請求進(jìn)入容器后，但在進(jìn)入servlet之前進(jìn)行預處理，請求結束是在servlet處理完以后。攔截器 Interceptor 是在請求進(jìn)入servlet后，在進(jìn)入Controller之前進(jìn)行預處理的，Controller 中渲染了對應的視圖之后請求結束。

3.4 攔截的請求范圍不同

在上邊我們已經(jīng)同時(shí)配置了過(guò)濾器和攔截器，再建一個(gè)Controller接收請求測試一下。

@Controller
@RequestMapping()
public class Test {

    @RequestMapping("/test1")
    @ResponseBody
    public String test1(String a) {
        System.out.println("我是controller");
        return null;
    }
}

項目啟動(dòng)過(guò)程中發(fā)現，過(guò)濾器的init()方法，隨著(zhù)容器的啟動(dòng)進(jìn)行了初始化。
此時(shí)瀏覽器發(fā)送請求，F12 看到居然有兩個(gè)請求，一個(gè)是我們自定義的 Controller 請求，另一個(gè)是訪(fǎng)問(wèn)靜態(tài)圖標資源的請求。

看到控制臺的打印日志如下：

執行順序 ：Filter 處理中 -> Interceptor 前置 -> 我是controller -> Interceptor 處理中 -> Interceptor 處理后

Filter 處理中
Interceptor 前置
Interceptor 處理中
Interceptor 后置
Filter 處理中

3.5 注入Bean情況不同

在實(shí)際的業(yè)務(wù)場(chǎng)景中，應用到過(guò)濾器或攔截器，為處理業(yè)務(wù)邏輯難免會(huì )引入一些service服務(wù)。
下邊我們分別在過(guò)濾器和攔截器中都注入service，看看有什么不同？

@Component
public class TestServiceImpl implements TestService {

    @Override
    public void a() {
        System.out.println("我是方法A");
    }
}

過(guò)濾器中注入service，發(fā)起請求測試一下 ，日志正常打印出“我是方法A”。

@Autowired
    private TestService testService;

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

        System.out.println("Filter 處理中");
        testService.a();
        filterChain.doFilter(servletRequest, servletResponse);
    }

Filter 處理中
我是方法A
Interceptor 前置
我是controller
Interceptor 處理中
Interceptor 后置

在攔截器中注入service，發(fā)起請求測試一下 ，竟然報錯了，debug跟一下發(fā)現注入的service怎么是Null??？

這是因為加載順序導致的問(wèn)題，攔截器加載的時(shí)間點(diǎn)在springcontext之前，而B(niǎo)ean又是由spring進(jìn)行管理。

攔截器：老子今天要進(jìn)洞房；
Spring：兄弟別鬧，你媳婦我還沒(méi)生出來(lái)呢！

解決方案也很簡(jiǎn)單，我們在注冊攔截器之前，先將Interceptor 手動(dòng)進(jìn)行注入。注意：在registry.addInterceptor()注冊的是getMyInterceptor() 實(shí)例。

@Configuration
public class MyMvcConfig implements WebMvcConfigurer {

    @Bean
    public MyInterceptor getMyInterceptor(){
        System.out.println("注入了MyInterceptor");
        return new MyInterceptor();
    }
 
    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(getMyInterceptor()).addPathPatterns("/**");
    }
}

3.6 控制執行順序不同

實(shí)際開(kāi)發(fā)過(guò)程中，會(huì )出現多個(gè)過(guò)濾器或攔截器同時(shí)存在的情況，不過(guò)，有時(shí)我們希望某個(gè)過(guò)濾器或攔截器能優(yōu)先執行，就涉及到它們的執行順序。

過(guò)濾器用@Order注解控制執行順序，通過(guò)@Order控制過(guò)濾器的級別，值越小級別越高越先執行。

@Order(Ordered.HIGHEST_PRECEDENCE)
@Component
public class MyFilter2 implements Filter {}

攔截器默認的執行順序，就是它的注冊順序，也可以通過(guò)Order手動(dòng)設置控制，值越小越先執行。

@Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor2()).addPathPatterns("/**").order(2);
        registry.addInterceptor(new MyInterceptor1()).addPathPatterns("/**").order(1);
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**").order(3);
    }

看到輸出結果發(fā)現，先聲明的攔截器 preHandle() 方法先執行，而postHandle()方法反而會(huì )后執行。

postHandle() 方法被調用的順序跟 preHandle() 居然是相反的！如果實(shí)際開(kāi)發(fā)中嚴格要求執行順序，那就需要特別注意這一點(diǎn)。

Interceptor1 前置
Interceptor2 前置
Interceptor 前置
我是controller
Interceptor 處理中
Interceptor2 處理中
Interceptor1 處理中
Interceptor 后置
Interceptor2 處理后
Interceptor1 處理后

那為什么會(huì )這樣呢？ 得到答案就只能看源碼了，我們要知道controller 中所有的請求都要經(jīng)過(guò)核心組件DispatcherServlet路由，都會(huì )執行它的 doDispatch() 方法，而攔截器postHandle()、preHandle()方法便是在其中調用的。

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
 
        try {
         ...........
            try {
 
                // 獲取可以執行當前Handler的適配器
                HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

                // Process last-modified header, if supported by the handler.
                String method = request.getMethod();
                boolean isGet = "GET".equals(method);
                if (isGet || "HEAD".equals(method)) {
                    long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
                    if (logger.isDebugEnabled()) {
                        logger.debug("Last-Modified value for [" + getRequestUri(request) + "] is: " + lastModified);
                    }
                    if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {
                        return;
                    }
                }
                // 注意： 執行Interceptor中PreHandle()方法
                if (!mappedHandler.applyPreHandle(processedRequest, response)) {
                    return;
                }

                // 注意：執行Handle【包括我們的業(yè)務(wù)邏輯，當拋出異常時(shí)會(huì )被Try、catch到】
                mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

                if (asyncManager.isConcurrentHandlingStarted()) {
                    return;
                }
                applyDefaultViewName(processedRequest, mv);

                // 注意：執行Interceptor中PostHandle 方法【拋出異常時(shí)無(wú)法執行】
                mappedHandler.applyPostHandle(processedRequest, response, mv);
            }
        }
        ...........
    }

看看兩個(gè)方法applyPreHandle(）、applyPostHandle(）具體是如何被調用的，就明白為什么postHandle()、preHandle() 執行順序是相反的了。

boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
        HandlerInterceptor[] interceptors = this.getInterceptors();
        if(!ObjectUtils.isEmpty(interceptors)) {
            for(int i = 0; i < interceptors.length; this.interceptorIndex = i++) {
                HandlerInterceptor interceptor = interceptors[i];
                if(!interceptor.preHandle(request, response, this.handler)) {
                    this.triggerAfterCompletion(request, response, (Exception)null);
                    return false;
                }
            }
        }

        return true;
    }

void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @Nullable ModelAndView mv) throws Exception {
        HandlerInterceptor[] interceptors = this.getInterceptors();
        if(!ObjectUtils.isEmpty(interceptors)) {
            for(int i = interceptors.length - 1; i >= 0; --i) {
                HandlerInterceptor interceptor = interceptors[i];
                interceptor.postHandle(request, response, this.handler, mv);
            }
        }
    }

發(fā)現兩個(gè)方法中在調用攔截器數組 HandlerInterceptor[] 時(shí)，循環(huán)的順序竟然是相反的。。。，導致postHandle()、preHandle() 方法執行的順序相反。

到此這篇關(guān)于Java中過(guò)濾器 (Filter) 和 攔截器 (Interceptor)的使用的文章就介紹到這了,更多相關(guān)Java 過(guò)濾器和攔截器 內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！