過濾器 (Filter) 和 攔截器 (Interceptor) 有啥區別?下邊結合實踐,更直觀的來感受一下兩者到底有什么不同?
准備環境
我們在項目中同時配置 攔截器 和 過濾器。
1、過濾器 (Filter)
過濾器的配置比較簡單,直接實現Filter 接口即可,也可以通過@WebFilter注解實現對特定URL攔截,看到Filter 接口中定義了三個方法。
-
init():該方法在容器啟動初始化過濾器時被調用,它在Filter的整個生命周期只會被調用一次。「注意」:這個方法必須執行成功,否則過濾器會不起作用。 -
doFilter():容器中的每一次請求都會調用該方法,FilterChain用來調用下一個過濾器Filter。 -
destroy(): 當容器銷毀 過濾器實例時調用該方法,一般在方法中銷毀或關閉資源,在過濾器Filter的整個生命周期也只會被調用一次
2、攔截器 (Interceptor)
攔截器它是鏈式調用,一個應用中可以同時存在多個攔截器Interceptor, 一個請求也可以觸發多個攔截器 ,而每個攔截器的調用會依據它的聲明順序依次執行。
首先編寫一個簡單的攔截器處理類,請求的攔截是通過HandlerInterceptor 來實現,看到HandlerInterceptor 接口中也定義了三個方法。
-
preHandle():這個方法將在請求處理之前進行調用。java培訓「注意」:如果該方法的返回值為false,將視為當前請求結束,不僅自身的攔截器會失效,還會導致其他的攔截器也不再執行。 -
postHandle():只有在preHandle()方法返回值為true時才會執行。會在Controller 中的方法調用之后,DispatcherServlet 返回渲染視圖之前被調用。 「有意思的是」:postHandle()方法被調用的順序跟preHandle()是相反的,先聲明的攔截器preHandle()方法先執行,而postHandle()方法反而會后執行。 -
afterCompletion():只有在preHandle()方法返回值為true時才會執行。在整個請求結束之后, DispatcherServlet 渲染了對應的視圖之后執行。
將自定義好的攔截器處理類進行注冊,並通過addPathPatterns、excludePathPatterns等屬性設置需要攔截或需要排除的 URL。
我們不一樣
過濾器 和 攔截器 均體現了AOP的編程思想,都可以實現諸如日志記錄、登錄鑒權等功能,但二者的不同點也是比較多的,接下來一一說明。
1、實現原理不同
過濾器和攔截器 底層實現方式大不相同,過濾器 是基於函數回調的,攔截器 則是基於Java的反射機制(動態代理)實現的。
這里重點說下過濾器!
在我們自定義的過濾器中都會實現一個 doFilter()方法,這個方法有一個FilterChain 參數,而實際上它是一個回調接口。ApplicationFilterChain是它的實現類, 這個實現類內部也有一個 doFilter() 方法就是回調方法。
ApplicationFilterChain里面能拿到我們自定義的xxxFilter類,在其內部回調方法doFilter()里調用各個自定義xxxFilter過濾器,並執行 doFilter() 方法。
而每個xxxFilter 會先執行自身的 doFilter() 過濾邏輯,最后在執行結束前會執行filterChain.doFilter(servletRequest, servletResponse),也就是回調ApplicationFilterChain的doFilter() 方法,以此循環執行實現函數回調。
2、使用范圍不同
我們看到過濾器 實現的是 javax.servlet.Filter 接口,而這個接口是在Servlet規范中定義的,也就是說過濾器Filter 的使用要依賴於Tomcat等容器,導致它只能在web程序中使用。
而攔截器(Interceptor) 它是一個Spring組件,並由Spring容器管理,並不依賴Tomcat等容器,是可以單獨使用的。不僅能應用在web程序中,也可以用於Application、Swing等程序中。
3、觸發時機不同
過濾器 和 攔截器的觸發時機也不同,我們看下邊這張圖。
過濾器Filter是在請求進入容器后,但在進入servlet之前進行預處理,請求結束是在servlet處理完以后。
攔截器 Interceptor 是在請求進入servlet后,在進入Controller之前進行預處理的,Controller 中渲染了對應的視圖之后請求結束。
4、攔截的請求范圍不同
在上邊我們已經同時配置了過濾器和攔截器,再建一個Controller接收請求測試一下。
項目啟動過程中發現,過濾器的init()方法,隨着容器的啟動進行了初始化。
此時瀏覽器發送請求,F12 看到居然有兩個請求,一個是我們自定義的 Controller 請求,另一個是訪問靜態圖標資源的請求。
看到控制台的打印日志如下:
執行順序 :Filter 處理中 -> Interceptor 前置 -> 我是controller -> Interceptor 處理中 -> Interceptor 處理后
過濾器Filter執行了兩次,攔截器Interceptor只執行了一次。這是因為過濾器幾乎可以對所有進入容器的請求起作用,而攔截器只會對Controller中請求或訪問static目錄下的資源請求起作用。
5、注入Bean情況不同
在實際的業務場景中,應用到過濾器或攔截器,為處理業務邏輯難免會引入一些service服務。
下邊我們分別在過濾器和攔截器中都注入service,看看有什么不同?
過濾器中注入service,發起請求測試一下 ,日志正常打印出“我是方法A”。
在攔截器中注入service,發起請求測試一下 ,竟然TM的報錯了,debug跟一下發現注入的service怎么是Null啊?
這是因為加載順序導致的問題,攔截器加載的時間點在springcontext之前,而Bean又是由spring進行管理。
解決方案也很簡單,我們在注冊攔截器之前,先將Interceptor 手動進行注入。「注意」:在registry.addInterceptor()注冊的是getMyInterceptor() 實例。
6、控制執行順序不同
實際開發過程中,會出現多個過濾器或攔截器同時存在的情況,不過,有時我們希望某個過濾器或攔截器能優先執行,就涉及到它們的執行順序。
過濾器用@Order注解控制執行順序,通過@Order控制過濾器的級別,值越小級別越高越先執行。
攔截器默認的執行順序,就是它的注冊順序,也可以通過Order手動設置控制,值越小越先執行。
看到輸出結果發現,先聲明的攔截器 preHandle() 方法先執行,而postHandle()方法反而會后執行。
postHandle() 方法被調用的順序跟 preHandle() 居然是相反的!如果實際開發中嚴格要求執行順序,那就需要特別注意這一點。
「那為什么會這樣呢?」 得到答案就只能看源碼了,我們要知道controller 中所有的請求都要經過核心組件DispatcherServlet路由,都會執行它的 doDispatch() 方法,而攔截器postHandle()、preHandle()方法便是在其中調用的。
看看兩個方法applyPreHandle()、applyPostHandle()具體是如何被調用的,就明白為什么postHandle()、preHandle() 執行順序是相反的了。
發現兩個方法中在調用攔截器數組 HandlerInterceptor[] 時,循環的順序竟然是相反的。。。,導致postHandle()、preHandle() 方法執行的順序相反。 。
