1. Spring MVC 中的攔截器的使用“攔截器基本配置” 和 “攔截器高級配置” @目錄1. Spring MVC 中的攔截器的使用“攔截器基本配置” 和 “攔截器高級配置”2. 攔截器3. Spring MVC 中的攔截器的創建和基本配置3.1 定義攔截3.2 攔截器基本配置3.3 攔截器的 ...
1. Spring MVC 中的攔截器的使用“攔截器基本配置” 和 “攔截器高級配置”
@
目錄- 1. Spring MVC 中的攔截器的使用“攔截器基本配置” 和 “攔截器高級配置”
- 2. 攔截器
- 3. Spring MVC 中的攔截器的創建和基本配置
- 4. Spring MVC中多個攔截器的執行順序
- 5. 補充:源碼分析
- 6. 總結:
- 7. 最後:
2. 攔截器
攔截器(Interceptor) 類似於過濾器(Filter)
Spring MVC 的攔截器作用是在請求到達控制器之前或之後進行攔截,可以對請求和響應進行一些特定的處理。
攔截器可以用於很多場景下:
- 登錄驗證:對於需要登錄才能訪問的地址,使用攔截器可以判斷用戶是否已登錄,如果未登錄,則跳轉到登錄頁面。
- 許可權校驗:根據用戶許可權對部分網址進行訪問控制,拒絕未經授權的用戶訪問。
- 請求日誌:記錄請求信息,例如:請求地址,請求參數,請求時間等,用於排查問題和性能優化。
- 更改響應:可以對響應的內容進行修改,例如:添加頭信息,調整響應內容格式等。
攔截器和過濾器的區別在於它們的作用層面不同:
- 過濾器更註重在請求和響應的流程中進行處理,可以修改請求和響應的內容,例如:設置編碼和字元集,請求頭,狀態碼等。
- 攔截器則更加側重於對控制器進行前置或後置處理,在請求到達控制器之前或之後進行特定的操作,例如:列印日誌,許可權驗證等。
Filter、Servlet、Interceptor、Controller的執行順序:
3. Spring MVC 中的攔截器的創建和基本配置
3.1 定義攔截
實現org.springframework.web.servlet.HandlerInterceptor
介面,共有三個方法可以進行選擇性的實現:
- preHandle( ):處理器方法調用之前執行。只有該方法有返回值,返回值是布爾類型,true 表示放行,false 表示攔截 。
- postHandle( ):處理器方法調用之後執行。
- afterCompletion( ):渲染完成後執行。
3.2 攔截器基本配置
第一步:編寫攔截器,該攔截器要實現org.springframework.web.servlet.HandlerInterceptor
介面 。
package com.rainbowsea.springmvc.interceptors;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
public class Interceptor1 implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("Interceptor1's preHandle!");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("Interceptor1's postHandle!");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("Interceptor1's afterCompletion!");
}
}
在 Spring MVC 中攔截器的基本配置有兩種方式:
- 第一種方式是:通過 xml 進行配置
- 第二種方式是:通過 @Component 註解 + xml 文件進行配置
第一種方式:通過 xml 進行配置
需要註意的是:這個基本配置,預設情況下是攔截所有請求的。
在 springmvc.xml 文件中進行如下配置:
<mvc:interceptors>
<bean class="com.powernode.springmvc.interceptors.Interceptor1"/>
</mvc:interceptors>
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/cache http://www.springframework.org/schema/cache/spring-cache.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!-- 組件掃描-->
<context:component-scan
base-package="com.rainbowsea.springmvc.controller,com.rainbowsea.springmvc.interceptors"></context:component-scan>
<!-- 視圖解析器-->
<bean id="thymeleafViewResolver" class="org.thymeleaf.spring6.view.ThymeleafViewResolver">
<!--作用於視圖渲染的過程中,可以設置視圖渲染後輸出時採用的編碼字元集-->
<property name="characterEncoding" value="UTF-8"/>
<!--如果配置多個視圖解析器,它來決定優先使用哪個視圖解析器,它的值越小優先順序越高-->
<property name="order" value="1"/>
<!--當 ThymeleafViewResolver 渲染模板時,會使用該模板引擎來解析、編譯和渲染模板-->
<property name="templateEngine">
<bean class="org.thymeleaf.spring6.SpringTemplateEngine">
<!--用於指定 Thymeleaf 模板引擎使用的模板解析器。模板解析器負責根據模板位置、模板資源名稱、文件編碼等信息,載入模板並對其進行解析-->
<property name="templateResolver">
<bean class="org.thymeleaf.spring6.templateresolver.SpringResourceTemplateResolver">
<!--設置模板文件的位置(首碼)-->
<property name="prefix" value="/WEB-INF/templates/"/>
<!--設置模板文件尾碼(尾碼),Thymeleaf文件擴展名不一定是html,也可以是其他,例如txt,大部分都是html-->
<property name="suffix" value=".html"/>
<!--設置模板類型,例如:HTML,TEXT,JAVASCRIPT,CSS等-->
<property name="templateMode" value="HTML"/>
<!--用於模板文件在讀取和解析過程中採用的編碼字元集-->
<property name="characterEncoding" value="UTF-8"/>
</bean>
</property>
</bean>
</property>
</bean>
<!-- 配置攔截器-->
<mvc:interceptors>
<!-- 基本配置,第一種方式
註意:基本配置,預設情況下是攔截所有請求的-->
<bean class="com.rainbowsea.springmvc.interceptors.Interceptor1"></bean>
</mvc:interceptors>
</beans>
編寫對應的 Controller 控制器進行測試:
package com.rainbowsea.springmvc.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller // 交給 Spring IOC 容器管理
public class IndexController {
@RequestMapping("/index")
public String toIndex() {
System.out.println("IndexController#toIndex() ---> 處理器方法執行了");
return "index";
}
@RequestMapping("ok")
public String toOK() {
System.out.println("IndexController#OK() ---> 處理器方法執行了");
return "ok";
}
}
運行測試:
第二種方式是:通過 @Component 註解 + xml 文件進行配置
註意:同樣的,對於這種基本配置來說,攔截器是攔截所有請求的。
第二種方式的前提:
- 前提1:包掃描,在 spring mvc 中配置組件掃描
- 前提2:使用 @Component 註解進行對 編寫的攔截器類進行標註即可。
- 兩個前提都搞定了,就可以在 spring mvc.xml 文件中進行配置了。
<mvc:interceptors> <ref bean="interceptor1"/> </mvc:interceptors>
運行測試:
3.3 攔截器的高級配置
採用以上基本配置方式,攔截器是攔截所有請求路徑的。如果要針對某些路徑進行攔截,某些路徑不攔截,某些路徑攔截,可以採用高級配置:在 spring mvc.xml 文件當中進行配置
以上的配置表示,除 /ok 請求路徑之外,剩下的路徑全部攔截。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/cache http://www.springframework.org/schema/cache/spring-cache.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!-- 組件掃描-->
<context:component-scan
base-package="com.rainbowsea.springmvc.controller,com.rainbowsea.springmvc.interceptors"></context:component-scan>
<!-- 視圖解析器-->
<bean id="thymeleafViewResolver" class="org.thymeleaf.spring6.view.ThymeleafViewResolver">
<!--作用於視圖渲染的過程中,可以設置視圖渲染後輸出時採用的編碼字元集-->
<property name="characterEncoding" value="UTF-8"/>
<!--如果配置多個視圖解析器,它來決定優先使用哪個視圖解析器,它的值越小優先順序越高-->
<property name="order" value="1"/>
<!--當 ThymeleafViewResolver 渲染模板時,會使用該模板引擎來解析、編譯和渲染模板-->
<property name="templateEngine">
<bean class="org.thymeleaf.spring6.SpringTemplateEngine">
<!--用於指定 Thymeleaf 模板引擎使用的模板解析器。模板解析器負責根據模板位置、模板資源名稱、文件編碼等信息,載入模板並對其進行解析-->
<property name="templateResolver">
<bean class="org.thymeleaf.spring6.templateresolver.SpringResourceTemplateResolver">
<!--設置模板文件的位置(首碼)-->
<property name="prefix" value="/WEB-INF/templates/"/>
<!--設置模板文件尾碼(尾碼),Thymeleaf文件擴展名不一定是html,也可以是其他,例如txt,大部分都是html-->
<property name="suffix" value=".html"/>
<!--設置模板類型,例如:HTML,TEXT,JAVASCRIPT,CSS等-->
<property name="templateMode" value="HTML"/>
<!--用於模板文件在讀取和解析過程中採用的編碼字元集-->
<property name="characterEncoding" value="UTF-8"/>
</bean>
</property>
</bean>
</property>
</bean>
<!-- 高級配置:指定一些路徑被攔截,一些路徑不攔截-->
<mvc:interceptors>
<mvc:interceptor>
<!-- /** 表示攔截所有路徑-->
<mvc:mapping path="/**"/>
<!-- /ok 請求路徑不攔截-->
<mvc:exclude-mapping path="/ok"/>
<!-- /index 請求路徑攔截-->
<!-- <mvc:mapping path="/index"/>-->
<!-- 設置對應的那個攔截器-->
<ref bean="interceptor1"></ref>
</mvc:interceptor>
</mvc:interceptors>
</beans>
運行測試:
4. Spring MVC中多個攔截器的執行順序
這裡我們為了探究,多個攔截器存在的時候的執行順序,我們創建 3 個 攔截器。如下:
4.1 如果所有攔截器 preHandle( ) 方法 都返回 true時,多個攔截器的的執行順序
配置多個攔截器
<mvc:interceptors>
<!-- 配置多個攔截器,這個是基本配置,預設是所有請求都會進行攔截處理-->
<ref bean="interceptor1"></ref>
<ref bean="interceptor2"></ref>
<ref bean="interceptor3"></ref>
</mvc:interceptors>
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/cache http://www.springframework.org/schema/cache/spring-cache.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!-- 組件掃描-->
<context:component-scan
base-package="com.rainbowsea.springmvc.controller,com.rainbowsea.springmvc.interceptors"></context:component-scan>
<!-- 視圖解析器-->
<bean id="thymeleafViewResolver" class="org.thymeleaf.spring6.view.ThymeleafViewResolver">
<!--作用於視圖渲染的過程中,可以設置視圖渲染後輸出時採用的編碼字元集-->
<property name="characterEncoding" value="UTF-8"/>
<!--如果配置多個視圖解析器,它來決定優先使用哪個視圖解析器,它的值越小優先順序越高-->
<property name="order" value="1"/>
<!--當 ThymeleafViewResolver 渲染模板時,會使用該模板引擎來解析、編譯和渲染模板-->
<property name="templateEngine">
<bean class="org.thymeleaf.spring6.SpringTemplateEngine">
<!--用於指定 Thymeleaf 模板引擎使用的模板解析器。模板解析器負責根據模板位置、模板資源名稱、文件編碼等信息,載入模板並對其進行解析-->
<property name="templateResolver">
<bean class="org.thymeleaf.spring6.templateresolver.SpringResourceTemplateResolver">
<!--設置模板文件的位置(首碼)-->
<property name="prefix" value="/WEB-INF/templates/"/>
<!--設置模板文件尾碼(尾碼),Thymeleaf文件擴展名不一定是html,也可以是其他,例如txt,大部分都是html-->
<property name="suffix" value=".html"/>
<!--設置模板類型,例如:HTML,TEXT,JAVASCRIPT,CSS等-->
<property name="templateMode" value="HTML"/>
<!--用於模板文件在讀取和解析過程中採用的編碼字元集-->
<property name="characterEncoding" value="UTF-8"/>
</bean>
</property>
</bean>
</property>
</bean>
<mvc:interceptors>
<!-- 配置多個攔截器,這個是基本配置,預設是所有請求都會進行攔截處理-->
<ref bean="interceptor1"></ref>
<ref bean="interceptor2"></ref>
<ref bean="interceptor3"></ref>
</mvc:interceptors>
</beans>
如果所有攔截器 preHandle 都返回 true
按照 springmvc.xml文件中配置的順序,自上而下調用 preHandle:
4.2 如果其中一個攔截器 preHandle ( ) 方法,返回 false,多個攔截器的的執行順序
Interceptor3 攔截器中的 preHandle()方法返回 false。其他兩個攔截器返回 true.
規則:只要有一個攔截器preHandle
返回false,任何postHandle
都不執行。但返回false的攔截器的前面的攔截器按照逆序執行afterCompletion
。
只要有一個攔截器
preHandle()
方法,返回false,則任何攔截器的postHandle()方法
都不執行。但返回 false 的攔截器的前面的攔截器按照逆序執行afterCompletion
。返回 false 攔截器,攔截住了,則其中的 Controllor控制器不執行了,其中的 postHandle
一個也不會執行。而對應的 afterCompletion()方法,的執行是按照配置攔截器(自上而下)的倒序執行,但其中返回 false 的攔截器中的 afterCompletion()方法不會被執行
只要有一個攔截器
preHandle
返回false,任何postHandle
都不執行。但返回false的攔截器的前面的攔截器按照逆序執行afterCompletion
。只要有一個攔截器preHandle
返回false,任何postHandle
都不執行。但返回false的攔截器的前面的攔截器按照逆序執行afterCompletion
。
5. 補充:源碼分析
5.1 方法執行順序的源碼分析
public class DispatcherServlet extends FrameworkServlet {
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
// 調用所有攔截器的 preHandle 方法
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
return;
}
// 調用處理器方法
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
// 調用所有攔截器的 postHandle 方法
mappedHandler.applyPostHandle(processedRequest, response, mv);
// 處理視圖
processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
}
private void processDispatchResult(HttpServletRequest request, HttpServletResponse response,
@Nullable HandlerExecutionChain mappedHandler, @Nullable ModelAndView mv,
@Nullable Exception exception) throws Exception {
// 渲染頁面
render(mv, request, response);
// 調用所有攔截器的 afterCompletion 方法
mappedHandler.triggerAfterCompletion(request, response, null);
}
}
5.2 攔截與放行的源碼分析
public class DispatcherServlet extends FrameworkServlet {
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
// 調用所有攔截器的 preHandle 方法
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
// 如果 mappedHandler.applyPreHandle(processedRequest, response) 返回false,以下的return語句就會執行
return;
}
}
}
public class HandlerExecutionChain {
boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
for (int i = 0; i < this.interceptorList.size(); i++) {
HandlerInterceptor interceptor = this.interceptorList.get(i);
if (!interceptor.preHandle(request, response, this.handler)) {
triggerAfterCompletion(request, response, null);
// 如果 interceptor.preHandle(request, response, this.handler) 返回 false,以下的 return false;就會執行。
return false;
}
this.interceptorIndex = i;
}
return true;
}
}
5.3 DispatcherServlet 和 HandlerExecutionChain 的部分源碼:
public class DispatcherServlet extends FrameworkServlet {
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
// 按照順序執行所有攔截器的preHandle方法
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
return;
}
// 執行處理器方法
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
// 按照逆序執行所有攔截器的 postHanle 方法
mappedHandler.applyPostHandle(processedRequest, response, mv);
// 處理視圖
processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
}
private void processDispatchResult(HttpServletRequest request, HttpServletResponse response,
@Nullable HandlerExecutionChain mappedHandler, @Nullable ModelAndView mv,
@Nullable Exception exception) throws Exception {
// 渲染視圖
render(mv, request, response);
// 按照逆序執行所有攔截器的 afterCompletion 方法
mappedHandler.triggerAfterCompletion(request, response, null);
}
}
public class HandlerExecutionChain {
// 順序執行 preHandle
boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
for (int i = 0; i < this.interceptorList.size(); i++) {
HandlerInterceptor interceptor = this.interceptorList.get(i);
if (!interceptor.preHandle(request, response, this.handler)) {
// 如果其中一個攔截器preHandle返回false
// 將該攔截器前面的攔截器按照逆序執行所有的afterCompletion
triggerAfterCompletion(request, response, null);
return false;
}
this.interceptorIndex = i;
}
return true;
}
// 逆序執行 postHanle
void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @Nullable ModelAndView mv) throws Exception {
for (int i = this.interceptorList.size() - 1; i >= 0; i--) {
HandlerInterceptor interceptor = this.interceptorList.get(i);
interceptor.postHandle(request, response, this.handler, mv);
}
}
// 逆序執行 afterCompletion
void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) {
for (int i = this.interceptorIndex; i >= 0; i--) {
HandlerInterceptor interceptor = this.interceptorList.get(i);
try {
interceptor.afterCompletion(request, response, this.handler, ex);
}
catch (Throwable ex2) {
logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);
}
}
}
}
6. 總結:
實現
org.springframework.web.servlet.HandlerInterceptor
介面,共有三個方法可以進行選擇性的實現:
- preHandle( ):處理器方法調用之前執行。只有該方法有返回值,返回值是布爾類型,true 表示放行,false 表示攔截 。
- postHandle( ):處理器方法調用之後執行。
- afterCompletion( ):渲染完成後執行。
在 Spring MVC 中攔截器的基本配置有兩種方式:
- 第一種方式是:通過 xml 進行配置
- 第二種方式是:通過 @Component 註解 + xml 文件進行配置
- 對於這種基本配置來說,攔截器是攔截所有請求的。
攔截器的高級配置:採用以上基本配置方式,攔截器是攔截所有請求路徑的。如果要針對某些路徑進行攔截,某些路徑不攔截,某些路徑攔截,可以採用高級配置:在 spring mvc.xml 文件當中進行配置
Spring MVC中多個攔截器的執行順序:
如果所有攔截器 preHandle( ) 方法 都返回 true時,多個攔截器的的執行順序:
按照 springmvc.xml文件中配置的順序,自上而下調用 preHandle:
如果其中一個攔截器 preHandle ( ) 方法,返回 false,多個攔截器的的執行順序
- 只要有一個攔截器
preHandle()
方法,返回false,則任何攔截器的postHandle()方法
都不執行。但返回 false 的攔截器的前面的攔截器按照逆序執行afterCompletion
。攔截器源碼分析。
7. 最後:
“在這個最後的篇章中,我要表達我對每一位讀者的感激之情。你們的關註和回覆是我創作的動力源泉,我從你們身上吸取了無盡的靈感與勇氣。我會將你們的鼓勵留在心底,繼續在其他的領域奮鬥。感謝你們,我們總會在某個時刻再次相遇。”