spring 两次进入拦截器_过滤器和拦截器的 6 个区别,别再傻傻分不清了
點擊上方?肉眼品世界,選擇?設(shè)為星標(biāo)
深度價值體系傳遞
作者 :程序員內(nèi)點事
來源?:toutiao.com/i6834310440495874563
畢竟這兩種工具開發(fā)中用到的頻率都相當(dāng)高,應(yīng)用起來也是比較簡單的,可當(dāng)我準(zhǔn)備回復(fù)他的時候,竟然不知道從哪說起,支支吾吾了半天,場面炒雞尷尬有木有,工作這么久一個基礎(chǔ)問題答成這樣,丟了大人了。
平時覺得簡單的知識點,但通常都不會太關(guān)注細(xì)節(jié),一旦被別人問起來,反倒說不出個所以然來。
歸根結(jié)底,還是對這些知識了解的不夠,一直停留在會用的階段,以至于現(xiàn)在「一看就會一說就廢」!這是典型基礎(chǔ)不扎實的表現(xiàn),哎·~,其實我也就是個虛胖!
知恥而后勇,下邊結(jié)合實踐,更直觀的來感受一下兩者到底有什么不同?
準(zhǔn)備環(huán)境
我們在項目中同時配置 攔截器 和 過濾器。
1、過濾器 (Filter)
過濾器的配置比較簡單,直接實現(xiàn)Filter 接口即可,也可以通過@WebFilter注解實現(xiàn)對特定URL攔截,看到Filter 接口中定義了三個方法。
1.init() :該方法在容器啟動初始化過濾器時被調(diào)用,它在 Filter 的整個生命周期只會被調(diào)用一次。「注意」:這個方法必須執(zhí)行成功,否則過濾器會不起作用。
2.doFilter() :容器中的每一次請求都會調(diào)用該方法, FilterChain 用來調(diào)用下一個過濾器 Filter。
3.destroy():當(dāng)容器銷毀 過濾器實例時調(diào)用該方法,一般在方法中銷毀或關(guān)閉資源,在過濾器 Filter 的整個生命周期也只會被調(diào)用一次
@Componentpublic?class?MyFilter?implements?Filter?{@Overridepublic?void?init(FilterConfig filterConfig)?throws?ServletException {????????System.out.println(Filter 前置);
????}@Overridepublic?void?doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)?throws?IOException, ServletException {
????????System.out.println(Filter 處理中);
????????filterChain.doFilter(servletRequest, servletResponse);
????}@Overridepublic?void?destroy()?{
????????System.out.println(Filter 后置);
????}
}
2、攔截器 (Interceptor)
攔截器它是鏈?zhǔn)秸{(diào)用,一個應(yīng)用中可以同時存在多個攔截器Interceptor, 一個請求也可以觸發(fā)多個攔截器 ,而每個攔截器的調(diào)用會依據(jù)它的聲明順序依次執(zhí)行。
首先編寫一個簡單的攔截器處理類,請求的攔截是通過HandlerInterceptor 來實現(xiàn),看到HandlerInterceptor 接口中也定義了三個方法。
1.preHandle() :這個方法將在請求處理之前進(jìn)行調(diào)用。「注意」:如果該方法的返回值為false ,將視為當(dāng)前請求結(jié)束,不僅自身的攔截器會失效,還會導(dǎo)致其他的攔截器也不再執(zhí)行。
2.postHandle():只有在 preHandle() 方法返回值為true 時才會執(zhí)行。會在Controller 中的方法調(diào)用之后,DispatcherServlet 返回渲染視圖之前被調(diào)用。?「有意思的是」:postHandle() 方法被調(diào)用的順序跟 preHandle() 是相反的,先聲明的攔截器 preHandle() 方法先執(zhí)行,而postHandle()方法反而會后執(zhí)行。
3.afterCompletion():只有在 preHandle() 方法返回值為true 時才會執(zhí)行。在整個請求結(jié)束之后, DispatcherServlet 渲染了對應(yīng)的視圖之后執(zhí)行。
@Componentpublic?class?MyInterceptor?implements?HandlerInterceptor?{@Overridepublic?boolean?preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)?throws?Exception {????????System.out.println(Interceptor 前置);return?true;
????}@Overridepublic?void?postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)?throws?Exception {
????????System.out.println(Interceptor 處理中);
????}@Overridepublic?void?afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)?throws?Exception {
????????System.out.println(Interceptor 后置);
????}
}
將自定義好的攔截器處理類進(jìn)行注冊,并通過addPathPatterns、excludePathPatterns等屬性設(shè)置需要攔截或需要排除的 URL。
@Configurationpublic?class?MyMvcConfig?implements?WebMvcConfigurer?{@Overridepublic?void?addInterceptors(InterceptorRegistry registry)?{????????registry.addInterceptor(new?MyInterceptor()).addPathPatterns(/**);
????????registry.addInterceptor(new?MyInterceptor1()).addPathPatterns(/**);
????}
}
我們不一樣
過濾器 和 攔截器 均體現(xiàn)了AOP的編程思想,都可以實現(xiàn)諸如日志記錄、登錄鑒權(quán)等功能,但二者的不同點也是比較多的,接下來一一說明。
1、實現(xiàn)原理不同
過濾器和攔截器 底層實現(xiàn)方式大不相同,過濾器 是基于函數(shù)回調(diào)的,攔截器 則是基于Java的反射機(jī)制(動態(tài)代理)實現(xiàn)的。
這里重點說下過濾器!
在我們自定義的過濾器中都會實現(xiàn)一個 doFilter()方法,這個方法有一個FilterChain 參數(shù),而實際上它是一個回調(diào)接口。ApplicationFilterChain是它的實現(xiàn)類, 這個實現(xiàn)類內(nèi)部也有一個 doFilter() 方法就是回調(diào)方法。
ApplicationFilterChain里面能拿到我們自定義的xxxFilter類,在其內(nèi)部回調(diào)方法doFilter()里調(diào)用各個自定義xxxFilter過濾器,并執(zhí)行 doFilter() 方法。
public?final?class?ApplicationFilterChain?implements?FilterChain?{@Overridepublic?void?doFilter(ServletRequest request, ServletResponse response)?{????????????...//省略
????????????internalDoFilter(request,response);
????}private?void?internalDoFilter(ServletRequest request, ServletResponse response){if?(pos < n) {//獲取第pos個filter
????????????ApplicationFilterConfig filterConfig = filters[pos++];
????????????Filter filter = filterConfig.getFilter();
????????????...
????????????filter.doFilter(request, response, this);
????????}
????}
}
而每個xxxFilter 會先執(zhí)行自身的 doFilter() 過濾邏輯,最后在執(zhí)行結(jié)束前會執(zhí)行filterChain.doFilter(servletRequest, servletResponse),也就是回調(diào)ApplicationFilterChain的doFilter() 方法,以此循環(huán)執(zhí)行實現(xiàn)函數(shù)回調(diào)。
@Overridepublic?void?doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)?throws?IOException, ServletException {????????filterChain.doFilter(servletRequest, servletResponse);
????}
2、使用范圍不同
我們看到過濾器 實現(xiàn)的是 javax.servlet.Filter 接口,而這個接口是在Servlet規(guī)范中定義的,也就是說過濾器Filter 的使用要依賴于Tomcat等容器,導(dǎo)致它只能在web程序中使用。
而攔截器(Interceptor) 它是一個Spring組件,并由Spring容器管理,并不依賴Tomcat等容器,是可以單獨使用的。不僅能應(yīng)用在web程序中,也可以用于Application、Swing等程序中。
3、觸發(fā)時機(jī)不同
過濾器 和 攔截器的觸發(fā)時機(jī)也不同,我們看下邊這張圖。
過濾器Filter是在請求進(jìn)入容器后,但在進(jìn)入servlet之前進(jìn)行預(yù)處理,請求結(jié)束是在servlet處理完以后。
攔截器 Interceptor 是在請求進(jìn)入servlet后,在進(jìn)入Controller之前進(jìn)行預(yù)處理的,Controller 中渲染了對應(yīng)的視圖之后請求結(jié)束。
4、攔截的請求范圍不同
在上邊我們已經(jīng)同時配置了過濾器和攔截器,再建一個Controller接收請求測試一下。
@Controller@RequestMapping()public class Test {@RequestMapping(/test1)@ResponseBody
????public String test1(String a) {System.out.println(我是controller);return?null;
????}
}
項目啟動過程中發(fā)現(xiàn),過濾器的init()方法,隨著容器的啟動進(jìn)行了初始化。
此時瀏覽器發(fā)送請求,F12 看到居然有兩個請求,一個是我們自定義的 Controller 請求,另一個是訪問靜態(tài)圖標(biāo)資源的請求。
看到控制臺的打印日志如下:
執(zhí)行順序 :Filter 處理中 -> Interceptor 前置 -> 我是controller -> Interceptor 處理中 -> Interceptor 處理后
Filter?處理中Interceptor 前置
Interceptor 處理中
Interceptor 后置Filter?處理中
過濾器Filter執(zhí)行了兩次,攔截器Interceptor只執(zhí)行了一次。這是因為過濾器幾乎可以對所有進(jìn)入容器的請求起作用,而攔截器只會對Controller中請求或訪問static目錄下的資源請求起作用。
5、注入Bean情況不同
在實際的業(yè)務(wù)場景中,應(yīng)用到過濾器或攔截器,為處理業(yè)務(wù)邏輯難免會引入一些service服務(wù)。
下邊我們分別在過濾器和攔截器中都注入service,看看有什么不同?
@Componentpublic?class?TestServiceImpl?implements?TestService?{@Overridepublic?void?a()?{????????System.out.println(我是方法A);
????}
}
過濾器中注入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ā)起請求測試一下 ,竟然TM的報錯了,debug跟一下發(fā)現(xiàn)注入的service怎么是Null啊?
這是因為加載順序?qū)е碌膯栴},攔截器加載的時間點在springcontext之前,而Bean又是由spring進(jìn)行管理。
?
攔截器:老子今天要進(jìn)洞房;Spring:兄弟別鬧,你媳婦我還沒生出來呢!
?
解決方案也很簡單,我們在注冊攔截器之前,先將Interceptor 手動進(jìn)行注入。「注意」:在registry.addInterceptor()注冊的是getMyInterceptor() 實例。
@Configurationpublic?class?MyMvcConfig?implements?WebMvcConfigurer?{@Beanpublic?MyInterceptor getMyInterceptor(){????????System.out.println(注入了MyInterceptor);return?new?MyInterceptor();
????}@Overridepublic?void?addInterceptors(InterceptorRegistry registry)?{
????????registry.addInterceptor(getMyInterceptor()).addPathPatterns(/**);
????}
}
6、控制執(zhí)行順序不同
實際開發(fā)過程中,會出現(xiàn)多個過濾器或攔截器同時存在的情況,不過,有時我們希望某個過濾器或攔截器能優(yōu)先執(zhí)行,就涉及到它們的執(zhí)行順序。
過濾器用@Order注解控制執(zhí)行順序,通過@Order控制過濾器的級別,值越小級別越高越先執(zhí)行。
@Order(Ordered.HIGHEST_PRECEDENCE)@Componentpublic class MyFilter2 implements Filter {
攔截器默認(rèn)的執(zhí)行順序,就是它的注冊順序,也可以通過Order手動設(shè)置控制,值越小越先執(zhí)行。
@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);
????}
看到輸出結(jié)果發(fā)現(xiàn),先聲明的攔截器 preHandle() 方法先執(zhí)行,而postHandle()方法反而會后執(zhí)行。
postHandle() 方法被調(diào)用的順序跟 preHandle() 居然是相反的!如果實際開發(fā)中嚴(yán)格要求執(zhí)行順序,那就需要特別注意這一點。
Interceptor1?前置Interceptor2 前置
Interceptor 前置
我是controller
Interceptor 處理中
Interceptor2 處理中
Interceptor1 處理中
Interceptor 后置
Interceptor2 處理后
Interceptor1 處理后
「那為什么會這樣呢?」?得到答案就只能看源碼了,我們要知道controller 中所有的請求都要經(jīng)過核心組件DispatcherServlet路由,都會執(zhí)行它的 doDispatch() 方法,而攔截器postHandle()、preHandle()方法便是在其中調(diào)用的。
protected?void?doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {try?{?????????...........try?{// 獲取可以執(zhí)行當(dāng)前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;
????????????????????}
????????????????}// 注意:執(zhí)行Interceptor中PreHandle()方法if?(!mappedHandler.applyPreHandle(processedRequest, response)) {return;
????????????????}// 注意:執(zhí)行Handle【包括我們的業(yè)務(wù)邏輯,當(dāng)拋出異常時會被Try、catch到】
????????????????mv = ha.handle(processedRequest, response, mappedHandler.getHandler());if?(asyncManager.isConcurrentHandlingStarted()) {return;
????????????????}
????????????????applyDefaultViewName(processedRequest, mv);// 注意:執(zhí)行Interceptor中PostHandle 方法【拋出異常時無法執(zhí)行】
????????????????mappedHandler.applyPostHandle(processedRequest, response, mv);
????????????}
????????}
????????...........
????}
看看兩個方法applyPreHandle()、applyPostHandle()具體是如何被調(diào)用的,就明白為什么postHandle()、preHandle() 執(zhí)行順序是相反的了。
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ā)現(xiàn)兩個方法正在調(diào)用攔截器數(shù)組 HandlerInterceptor[] 時,循環(huán)的順序竟然是相反的。。。,導(dǎo)致postHandle()、preHandle() 方法執(zhí)行的順序相反。
總結(jié)
我相信大部分人都能熟練使用濾器和攔截器,但兩者的差別還是需要多了解下,不然開發(fā)中使用不當(dāng),時不時就會出現(xiàn)奇奇怪怪的問題,以上內(nèi)容比較簡單,有遺漏的地方還望大家積極補(bǔ)充,如有理解錯誤之處,還望不吝賜教。
總結(jié)
以上是生活随笔為你收集整理的spring 两次进入拦截器_过滤器和拦截器的 6 个区别,别再傻傻分不清了的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: SPI介绍
- 下一篇: sudo修改文件夹名字_修改mac os