詳解Spring 攔截器流程及多個(gè)攔截器的執(zhí)行順序
攔截器是 Spring MVC 中的組件,它可以在進(jìn)入請(qǐng)求方法前做一些操作,也可以在請(qǐng)求方法后和渲染視圖后做一些事情。
攔截器的定義SpringMVC 的攔截器只需要實(shí)現(xiàn) HandlerInterceptor 接口,并進(jìn)行配置即可。HandlerInterceptor 接口的定義如下:
public interface HandlerInterceptor { default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {return true; } default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception { } default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception { }}
在 HandlerInterceptor 中共有三個(gè)方法,每個(gè)方法的含義如下:
preHandler:進(jìn)入請(qǐng)求方法之前執(zhí)行;
postHandler:請(qǐng)求方法執(zhí)行完成之后執(zhí)行;
afterCompletion:視圖渲染后執(zhí)行。
攔截器的執(zhí)行流程
在 preHandle 方法中,它的返回值是 boolean 類型的,它的返回值影響著請(qǐng)求方法,以及 postHandle 和 afterCompletion 的執(zhí)行。具體如下。
也就是說(shuō),在 preHandle 中如果返回 false,那么后續(xù)的流程將不被執(zhí)行,這可能也是攔截器命名的由來(lái)。
測(cè)試攔截器寫一個(gè)簡(jiǎn)單攔截器,代碼如下:
@Slf4jpublic class TestInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {log.info('preHandler');return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {log.info('postHandler'); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {log.info('afterCompletion'); }}
創(chuàng)建了一個(gè) TestInterceptor 的監(jiān)聽器類,它實(shí)現(xiàn)了 HandlerInterceptor 的所有接口。寫完 TestInterceptor 還需要進(jìn)行注冊(cè)。代碼如下:
@Configurationpublic class InterceptorConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(testInterceptor()); }
再來(lái)寫一個(gè)簡(jiǎn)單的請(qǐng)求方法,代碼如下:
@GetMapping('test')public String test(){ return 'test';}
來(lái)啟動(dòng)我們的項(xiàng)目,并進(jìn)行訪問(wèn),控制臺(tái)的輸出如下:
2021-05-05 16:02:08.110 INFO 88509 --- [nio-8081-exec-6] com.example.demo.TestInterceptor : preHandler2021-05-05 16:02:08.111 INFO 88509 --- [nio-8081-exec-6] com.example.demo.TestInterceptor : postHandler2021-05-05 16:02:08.111 INFO 88509 --- [nio-8081-exec-6] com.example.demo.TestInterceptor : afterCompletion多個(gè)攔截器的執(zhí)行順序
我們來(lái)寫多個(gè)相同的監(jiān)聽器,分別是 TestInterceptor、TestInterceptor2 和 TestInterceptor3。然后我們進(jìn)行注冊(cè),注冊(cè)代碼如下:
@Overridepublic void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(testInterceptor()); registry.addInterceptor(testInterceptor2()); registry.addInterceptor(testInterceptor3());}
請(qǐng)求我們的方法,輸出如下:
2021-05-05 16:09:57.735 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor : preHandler2021-05-05 16:09:57.736 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2: preHandler22021-05-05 16:09:57.736 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor3: preHandler32021-05-05 16:09:57.755 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor3: postHandler32021-05-05 16:09:57.755 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2: postHandler22021-05-05 16:09:57.755 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor : postHandler2021-05-05 16:09:57.755 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor3: afterCompletion32021-05-05 16:09:57.755 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2: afterCompletion22021-05-05 16:09:57.755 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor : afterCompletion
注意觀察輸出的順序,preHandle 方法是按注冊(cè)順序進(jìn)行執(zhí)行的,而 postHandle 和 afterCompletion 跟注冊(cè)順序是相反的。
讓 preHandle 進(jìn)行攔截我們讓 TestInterceptor2 的 preHandle 返回值為 false,然后查看一下輸出內(nèi)容。
2021-05-05 16:14:00.997 INFO 88582 --- [nio-8081-exec-1] com.example.demo.TestInterceptor : preHandler2021-05-05 16:14:00.998 INFO 88582 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2: preHandler22021-05-05 16:14:00.998 INFO 88582 --- [nio-8081-exec-1] com.example.demo.TestInterceptor : afterCompletion
可以看到,TestInterceptor2 的 preHandle 的返回值為 false 以后,相當(dāng)于在 TestInterceptor2 的 preHandle 后續(xù)流程則不再繼續(xù)執(zhí)行了。
我們調(diào)整一下注冊(cè)的順序,代碼如下:
@Overridepublic void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(testInterceptor2()); registry.addInterceptor(testInterceptor()); registry.addInterceptor(testInterceptor3());}
修改順序后的輸出如下:
2021-05-05 16:17:23.956 INFO 88589 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2: preHandler2
可以看到它后面的流程都被攔截了,沒(méi)有機(jī)會(huì)執(zhí)行了。
總結(jié)攔截器是使用一個(gè) List 進(jìn)行保存,我們可以在項(xiàng)目中添加多個(gè)攔截器來(lái)完成不同的功能,比如可以進(jìn)行 Token 的驗(yàn)證,權(quán)限的獲取等。我們可以放到不同的攔截器中來(lái)進(jìn)行相關(guān)的操作。
以上就是詳解Spring 攔截器流程及多個(gè)攔截器的執(zhí)行順序的詳細(xì)內(nèi)容,更多關(guān)于Spring 攔截器的資料請(qǐng)關(guān)注好吧啦網(wǎng)其它相關(guān)文章!
相關(guān)文章:
1. CSS自定義滾動(dòng)條樣式案例詳解2. 通過(guò)工廠模式返回Spring Bean方法解析3. JSP實(shí)現(xiàn)客戶信息管理系統(tǒng)4. PHP 面向?qū)ο蟪绦蛟O(shè)計(jì)之類屬性與類常量實(shí)現(xiàn)方法分析5. Java Spring WEB應(yīng)用實(shí)例化如何實(shí)現(xiàn)6. python 批量下載bilibili視頻的gui程序7. Intellij IDEA連接Navicat數(shù)據(jù)庫(kù)的方法8. 關(guān)于Mysql-connector-java驅(qū)動(dòng)版本問(wèn)題總結(jié)9. 使用css實(shí)現(xiàn)全兼容tooltip提示框10. python numpy庫(kù)np.percentile用法說(shuō)明
