攔截器簡(jiǎn)介

Spring MVC 中的攔截器(Interceptor)類似于 Servler 中的過濾器(Filter)。用于對(duì)處理器進(jìn)行預(yù)處理和后處理。常用于日志記錄、權(quán)限管理、性能監(jiān)控、通用行為等。

攔截器的實(shí)現(xiàn)

Spring MVC 中的攔截器需要我們手動(dòng)實(shí)現(xiàn)和配置。攔截器可以通過以下兩種方式定義

• 實(shí)現(xiàn) HandleInterceptor 接口，或者繼承該接口的實(shí)現(xiàn)類如 HandleInterceptorAdapter 來定義一個(gè)攔截器；
• 實(shí)現(xiàn) WebRequestInterceptor 接口來定義一個(gè)攔截器;

HandleInterceptor 接口

我們主要講解下實(shí)現(xiàn) HandleInterceptor 接口來創(chuàng)建攔截器。HandleInterceptor 接口定義了三個(gè)方法，分別為 preHandle() , postHandle() , afterCompletion()，我們需要重寫這三個(gè)方法，從而來實(shí)現(xiàn)我們定義攔截器的目的。

• preHandle(HttpServletRequest request, HttpServletResponse response, Object handle)：該方法在請(qǐng)求處理前調(diào)用。Spring MVC 中的攔截器是鏈?zhǔn)秸{(diào)用的，一個(gè)請(qǐng)求可以被多個(gè)攔截器攔截，但是 Interceptor 會(huì)根據(jù)被聲明的次序依次被調(diào)用執(zhí)行，而不會(huì)同時(shí)去攔截。而且所有 Interceptor 中的 preHandle 函數(shù)都會(huì)最先被調(diào)用，所以這個(gè)方法中可以進(jìn)行一些前置初始化操作或者是對(duì)當(dāng)前請(qǐng)求的預(yù)處理，或者設(shè)置一些判斷來決定該請(qǐng)求是否執(zhí)行下去。該方法的返回值是布爾值，當(dāng)它返回 true 時(shí)，之后的 Interceptor 和 controller 都不會(huì)執(zhí)行下去了；當(dāng)它返回 false 時(shí)，就會(huì)繼續(xù)調(diào)用下一個(gè) Interceptor 的 preHandle 方法或者處理當(dāng)前請(qǐng)求的 Controller。
• postHandle(HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView)：該方法只有在 perHandle 方法返回值為 true 時(shí)，在 Controller 執(zhí)行完當(dāng)前請(qǐng)求后才會(huì)執(zhí)行。咋一看好像和之后要介紹的 afterCompletion 方法沒有不同，但是這個(gè)方法會(huì)在 DispatcherServlet 進(jìn)行視圖渲染之前被調(diào)用，所以咱們可以在這個(gè)方法中對(duì) Controller 處理之后的 ModelAndView 對(duì)象進(jìn)行操作。
• afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex)：該方法在整個(gè)請(qǐng)求結(jié)束后，也就是 DispatcherServlet 渲染了對(duì)應(yīng)視圖之后執(zhí)行，這個(gè)方法的主要作用是用于進(jìn)行資源清理的工作。

假設(shè)我們現(xiàn)在定義了兩個(gè)攔截器，xml 配置文件中配置順序如下內(nèi)容如下：

<!-- 攔截器1 -->
<mvc:interceptor>
 <!--配置攔截器的作用路徑-->
 <mvc:mapping path="/**"/>
 <bean class="com.jojo.test.interceptor.Intercptor1"/>
</mvc:interceptor>
<!--攔截器2-->
<mvc:interceptor>
 <mvc:mapping path="/hello"/>
 <bean class="com.jojo.test.interceptor.Interceptor2"/>
</mvc:interceptor>

那么這兩個(gè)攔截器中的處理方法和請(qǐng)求的處理方法的順序如下圖：

實(shí)際應(yīng)用舉例

實(shí)現(xiàn)開發(fā)中，我們會(huì)要求一些頁面需要登錄后才能訪問。未登錄狀態(tài)是無法得到訪問權(quán)限的。這一小功能我們可以直接通過安全框架，類似 Spring Security 或者 shiro 來實(shí)現(xiàn)，不過我們現(xiàn)在利用 Spring MVC 這一功能來實(shí)現(xiàn)一下：

public class LoginInterceptor implements HandlerInterceptor {
 
 public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
  
  User user = (User) httpServletRequest.getSession().getAttribute("user");

  if (user == null) {
   // 用戶未登錄，重定向到登錄頁
   httpServletResponse.sendRedirect("/login");
   return false;
  }

  return true;
 }

 public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
  
  }
 }

 public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {

 }
}

我們還需要在 spring-mvc 中配置攔截器

<mvc:interceptors>
 <mvc:interceptor>
  <mvc:mapping path="/**"/>
  <mvc:exclude-mapping path="/static/**"/>
  <mvc:exclude-mapping path="/login"/>
  <bean class="com.jojo.test.interceptor.LoginInterceptor"/>
 </mvc:interceptor>
</mvc:interceptors>

相關(guān)配置說明：

• mvc:interceptor：定義一個(gè)攔截器
  • mvc:mapping：定義需要被攔截的路徑
  • mvc:exclude-mapping：定義需要排除攔截的請(qǐng)求路徑
  • bean class：指定攔截器對(duì)象

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，謝謝大家對(duì)腳本之家的支持。

最新評(píng)論