詳解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í)行。具體如下。
也就是說,在 preHandle 中如果返回 false,那么后續(xù)的流程將不被執(zhí)行,這可能也是攔截器命名的由來。
測試攔截器
寫一個(gè)簡單攔截器,代碼如下:
@Slf4j public 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è)。代碼如下:
@Configuration public class InterceptorConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(testInterceptor()); }
再來寫一個(gè)簡單的請(qǐng)求方法,代碼如下:
@GetMapping("test") public String test() { return "test"; }
來啟動(dòng)我們的項(xiàng)目,并進(jìn)行訪問,控制臺(tái)的輸出如下:
2021-05-05 16:02:08.110 INFO 88509 --- [nio-8081-exec-6] com.example.demo.TestInterceptor : preHandler 2021-05-05 16:02:08.111 INFO 88509 --- [nio-8081-exec-6] com.example.demo.TestInterceptor : postHandler 2021-05-05 16:02:08.111 INFO 88509 --- [nio-8081-exec-6] com.example.demo.TestInterceptor : afterCompletion
多個(gè)攔截器的執(zhí)行順序
我們來寫多個(gè)相同的監(jiān)聽器,分別是 TestInterceptor、TestInterceptor2 和 TestInterceptor3。然后我們進(jìn)行注冊(cè),注冊(cè)代碼如下:
@Override public 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 : preHandler 2021-05-05 16:09:57.736 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2 : preHandler2 2021-05-05 16:09:57.736 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor3 : preHandler3 2021-05-05 16:09:57.755 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor3 : postHandler3 2021-05-05 16:09:57.755 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2 : postHandler2 2021-05-05 16:09:57.755 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor : postHandler 2021-05-05 16:09:57.755 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor3 : afterCompletion3 2021-05-05 16:09:57.755 INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2 : afterCompletion2 2021-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 : preHandler 2021-05-05 16:14:00.998 INFO 88582 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2 : preHandler2 2021-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è)的順序,代碼如下:
@Override public 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
可以看到它后面的流程都被攔截了,沒有機(jī)會(huì)執(zhí)行了。
總結(jié)
攔截器是使用一個(gè) List 進(jìn)行保存,我們可以在項(xiàng)目中添加多個(gè)攔截器來完成不同的功能,比如可以進(jìn)行 Token 的驗(yàn)證,權(quán)限的獲取等。我們可以放到不同的攔截器中來進(jìn)行相關(guān)的操作。
以上就是詳解Spring 攔截器流程及多個(gè)攔截器的執(zhí)行順序的詳細(xì)內(nèi)容,更多關(guān)于Spring 攔截器的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
JAVA開發(fā)環(huán)境Vs?code配置步驟詳解
這篇文章主要為大家介紹了JAVA開發(fā)環(huán)境Vs?code配置步驟詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-04-04IDEA里找不到Maven的有效解決辦法(小白超詳細(xì))
這篇文章主要給大家介紹了關(guān)于IDEA里找不到Maven的有效解決辦法,文中通過圖文將解決的辦法介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2023-07-07SpringBoot實(shí)現(xiàn)上傳文件到AWS S3的代碼
這篇文章主要介紹了SpringBoot實(shí)現(xiàn)上傳文件到AWS S3的代碼,幫助大家更好的理解和使用springboot框架,感興趣的朋友可以了解下2020-10-10SpringBoot+Redis+Lua分布式限流的實(shí)現(xiàn)
本文主要介紹了SpringBoot+Redis+Lua分布式限流的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-08-08Java中RabbitMQ的幾種消息確認(rèn)機(jī)制
RabbitMQ消息確認(rèn)機(jī)制指的是在消息傳遞過程中,發(fā)送方發(fā)送消息后,接收方需要對(duì)消息進(jìn)行確認(rèn),以確保消息被正確地接收和處理,本文主要介紹了Java中RabbitMQ的幾種消息確認(rèn)機(jī)制,具有一定的參考價(jià)值,感興趣的可以了解一下2023-12-12Spring Boot2發(fā)布調(diào)用REST服務(wù)實(shí)現(xiàn)方法
這篇文章主要介紹了Spring Boot2發(fā)布調(diào)用REST服務(wù)實(shí)現(xiàn)方法,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-04-04詳解spring boot使用@Retryable來進(jìn)行重處理
本篇文章主要介紹了詳解spring boot使用@Retryable來進(jìn)行重處理,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-06-06