HandlerInterceptor攔截器接口

HandlerInterceptor是 Spring 框架提供的一個(gè)攔截器接口，用于在請(qǐng)求處理過(guò)程中攔截和處理請(qǐng)求。

當(dāng)一個(gè)請(qǐng)求到達(dá) Spring MVC 的控制器之前或之后，攔截器可以對(duì)請(qǐng)求進(jìn)行預(yù)處理、后處理或者進(jìn)行攔截操作。

通過(guò)實(shí)現(xiàn)HandlerInterceptor接口，可以自定義攔截器并注冊(cè)到 Spring MVC 的攔截器鏈中。

攔截器可以用于實(shí)現(xiàn)一些通用的功能，如權(quán)限驗(yàn)證、日志記錄、跨域處理等，以及對(duì)請(qǐng)求進(jìn)行修改、重定向或攔截等操作。

HandlerInterceptor接口定義了三個(gè)方法，分別是：

1. preHandle：在請(qǐng)求處理之前被調(diào)用?？梢赃M(jìn)行一些預(yù)處理操作，如身份驗(yàn)證、參數(shù)校驗(yàn)等。如果返回true，則繼續(xù)執(zhí)行后續(xù)的攔截器或請(qǐng)求處理器；如果返回false，則中斷請(qǐng)求處理流程。
2. postHandle：在請(qǐng)求處理之后、視圖渲染之前被調(diào)用?？梢詫?duì)請(qǐng)求的結(jié)果進(jìn)行后處理，如添加額外的模型數(shù)據(jù)或修改視圖等。
3. afterCompletion：在整個(gè)請(qǐng)求處理完成后被調(diào)用，即在視圖渲染完成后調(diào)用。可以進(jìn)行一些資源清理操作或日志記錄等。

通過(guò)實(shí)現(xiàn)HandlerInterceptor接口，并在配置文件中進(jìn)行注冊(cè)，可以將自定義的攔截器應(yīng)用到 Spring MVC 的請(qǐng)求處理流程中。

攔截器按照配置的順序依次執(zhí)行，并可以對(duì)請(qǐng)求進(jìn)行攔截、修改或處理，實(shí)現(xiàn)特定的業(yè)務(wù)邏輯或功能需求。

攔截器預(yù)處理操作

這里拿前置攔截器來(lái)說(shuō)

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    // 在此處編寫攔截處理邏輯
    // ...
    return true; // 或者根據(jù)需要返回 false 中斷請(qǐng)求處理流程
}

該方法在請(qǐng)求到達(dá)控制器之前被調(diào)用，允許進(jìn)行一些預(yù)處理操作。

它接收三個(gè)參數(shù)：

1. HttpServletRequest request：表示當(dāng)前的 HTTP 請(qǐng)求對(duì)象，可以通過(guò)該對(duì)象獲取請(qǐng)求的相關(guān)信息，如請(qǐng)求頭、請(qǐng)求參數(shù)等。
2. HttpServletResponse response：表示當(dāng)前的 HTTP 響應(yīng)對(duì)象，可以通過(guò)該對(duì)象操作響應(yīng)，如設(shè)置響應(yīng)頭、寫入響應(yīng)內(nèi)容等。
3. Object handler：表示當(dāng)前的請(qǐng)求處理器（即控制器方法），是一個(gè)處理當(dāng)前請(qǐng)求的目標(biāo)對(duì)象。

在preHandle方法中，你可以編寫自定義的攔截處理邏輯。

這包括但不限于以下內(nèi)容：

• 身份驗(yàn)證：檢查用戶是否已經(jīng)登錄或是否具有相應(yīng)的權(quán)限。如果驗(yàn)證失敗，可以中斷請(qǐng)求處理流程并返回false，或者進(jìn)行重定向到登錄頁(yè)面或錯(cuò)誤頁(yè)面。
• 參數(shù)校驗(yàn)：檢查請(qǐng)求參數(shù)的合法性和有效性，如檢查必填參數(shù)、參數(shù)格式等。如果參數(shù)不符合要求，可以中斷請(qǐng)求處理流程并返回false，或者返回錯(cuò)誤信息給客戶端。
• 日志記錄：記錄請(qǐng)求的相關(guān)信息，如請(qǐng)求URL、請(qǐng)求方法、請(qǐng)求參數(shù)等，用于后續(xù)的跟蹤和分析。
• 跨域處理：檢查請(qǐng)求的來(lái)源域，判斷是否允許跨域訪問(wèn)。如果不允許，可以進(jìn)行相應(yīng)的處理，如設(shè)置響應(yīng)頭或返回錯(cuò)誤信息。

在方法的最后，根據(jù)業(yè)務(wù)需求，可以返回true繼續(xù)請(qǐng)求處理流程，或者返回false中斷請(qǐng)求處理流程。

返回false會(huì)阻止請(qǐng)求繼續(xù)傳遞給后續(xù)的攔截器或控制器方法。

需要注意的是，攔截器只作用于 Spring MVC 中的請(qǐng)求處理過(guò)程，并不影響其他類型的請(qǐng)求處理，如靜態(tài)資源的處理等。

同時(shí)，攔截器的執(zhí)行順序和配置方式也需要根據(jù)具體的需求和場(chǎng)景進(jìn)行合理的配置和調(diào)整。

HandlerInterceptor 源碼

HandlerInterceptor是springMVC項(xiàng)目中的攔截器，它攔截的目標(biāo)是請(qǐng)求的地址， 比MethodInterceptor先執(zhí)行。

實(shí)現(xiàn)一個(gè)HandlerInterceptor攔截器可以直接實(shí)現(xiàn)HandlerInterceptor接口，也可以繼承HandlerInterceptorAdapter類。

這兩種方法殊途同歸，其實(shí)HandlerInterceptorAdapter也就是聲明了HandlerInterceptor接口中所有方法的默認(rèn)實(shí)現(xiàn)，而我們?cè)诶^承他之后只需要重寫必要的方法。

下面我們來(lái)看下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 {
	}
}

• preHandler：目標(biāo)方法執(zhí)行完成之前
• postHanlder：目標(biāo)方法執(zhí)行完成之后
• afterComplete：頁(yè)面渲染以后

一般而言，我們的登錄攔截操做，等相關(guān)的攔截操做都可以定義在preHandler方法里面。

到此這篇關(guān)于Spring中的攔截器HandlerInterceptor詳細(xì)解析的文章就介紹到這了,更多相關(guān)HandlerInterceptor攔截器內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論