springMVC 攔截器

Springmvc的處理器攔截器相似於Servlet 開發中的過濾器Filter，用於對處理器進行預處理和後處理。本文主要總結一下springmvc中攔截器是如何定義的，以及測試攔截器的執行狀況和使用方法。

1. springmvc攔截器的定義和配置

1.1 springmvc攔截器的定義

　　在springmvc中，定義攔截器要實現HandlerInterceptor接口，並實現該接口中提供的三個方法，以下：

//測試攔截器1
public class HandlerInterceptor1 implements HandlerInterceptor{

    @Override
    public boolean preHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler) throws Exception {

        System.out.println("HandlerInterceptor1....preHandle");

        //false表示攔截，不向下執行；true表示放行
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {

        System.out.println("HandlerInterceptor1....postHandle");

    }

    @Override
    public void afterCompletion(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex)
            throws Exception {

        System.out.println("HandlerInterceptor1....afterCompletion");
    }
}

　　針對這三個方法，我作一下簡單的分析：

1. preHandle方法：進入Handler方法以前執行。能夠用於身份認證、身份受權。好比若是認證沒有經過表示用戶沒有登錄，須要此方法攔截再也不往下執行（return false），不然就放行（return true）。
2. postHandle方法：進入Handler方法以後，返回ModelAndView以前執行。能夠看到該方法中有個modelAndView的形參。應用場景：從modelAndView出發：將公用的模型數據（好比菜單導航之類的）在這裏傳到視圖，也能夠在這裏同一指定視圖。
3. afterCompletion方法：執行Handler完成以後執行。應用場景：統一異常處理，統一日誌處理等。

1.2 springmvc攔截器的配置

　　在springmvc中，攔截器是針對具體的HandlerMapping進行配置的，也就是說若是在某個HandlerMapping中配置攔截，通過該 HandlerMapping映射成功的handler最終使用該攔截器。好比，假設咱們在配置文件中配置了的映射器是org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping，那麼咱們能夠這樣來配置攔截器：

<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
    <property name="interceptors">
        <list>
            <ref bean="handlerInterceptor1"/>
            <ref bean="handlerInterceptor2"/>
        </list>
    </property>
</bean>
<bean id="handlerInterceptor1" class="ssm.intercapter.HandlerInterceptor1"/>
<bean id="handlerInterceptor2" class="ssm.intercapter.HandlerInterceptor2"/>

　　那麼在springmvc中，如何配置相似於全局的攔截器呢？上面也說了，springmvc中的攔截器是針對具體的映射器的，爲了解決這個問題，springmvc框架將配置的相似全局的攔截器注入到每一個HandlerMapping中，這樣就能夠成爲全局的攔截器了。配置以下：

<!-- 配置攔截器 -->
<mvc:interceptors>
    <!-- 多個攔截器，按順序執行 -->        
    <mvc:interceptor>
        <mvc:mapping path="/**"/> <!-- 表示攔截全部的url包括子url路徑 -->
        <bean class="ssm.interceptor.HandlerInterceptor1"/>
    </mvc:interceptor>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="ssm.interceptor.HandlerInterceptor2"/>
    </mvc:interceptor>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="ssm.interceptor.HandlerInterceptor3"/>
    </mvc:interceptor>
</mvc:interceptors>

　　通常咱們都用這種配置，<mvc:mapping>中指定要攔截的url便可。

2. springmvc攔截器的執行測試

　　仿照上面的HandlerInterceptor1再寫兩個攔截器，HandlerInterceptor2和HandlerInterceptor3，配置是按照上面這個配置。而後咱們來測試一下三個攔截器的執行狀況，並作相關總結。

2.1 三個攔截器都放行

　　也就是說，咱們將三個攔截器的preHandle方法中返回值都改爲true，來測試一下攔截器的執行順序，測試結果以下：

HandlerInterceptor1….preHandle
HandlerInterceptor2….preHandle
HandlerInterceptor3….preHandle

HandlerInterceptor3….postHandle
HandlerInterceptor2….postHandle
HandlerInterceptor1….postHandle

HandlerInterceptor3….afterCompletion
HandlerInterceptor2….afterCompletion
HandlerInterceptor1….afterCompletion

　　根據打印的結果作一個總結：當全部攔截器都放行的時候，preHandle方法是按照配置的順序執的；而另外兩個方法按照配置的順序逆向執行的。

2.2 有一個攔截器不放行

　　咱們將第三個攔截器的preHandle方法中返回值改爲false，前兩個仍是true，來測試一下攔截器的執行順序，測試結果以下：

HandlerInterceptor1….preHandle
HandlerInterceptor2….preHandle
HandlerInterceptor3….preHandle

HandlerInterceptor2….afterCompletion
HandlerInterceptor1….afterCompletion

根據打印的結果作一個總結：
　　1. 因爲攔截器1和2放行，因此攔截器3的preHandle才能執行。也就是說前面的攔截器放行，後面的攔截器才能執行preHandle。
　　2. 攔截器3不放行，因此其另外兩個方法沒有被執行。即若是某個攔截器不放行，那麼它的另外兩個方法就不會背執行。
　　3. 只要有一個攔截器不放行，全部攔截器的postHandle方法都不會執行，可是隻要執行過preHandle而且放行的，就會執行afterCompletion方法。

2.3 三個攔截器都不放行

　　這種狀況其實能夠參考上面的狀況了，是一個特例，也看一下運行結果：

HandlerInterceptor1….preHandle

　　很明顯，就只執行了第一個攔截器的preHandle方法，由於都不放行，因此沒有一個執行postHandle方法和afterCompletion方法。

3. 攔截器的使用

　　從第二種狀況來看，好比如今要寫一個統一異常處理的邏輯，那麼要將該攔截器放在攔截器鏈的第一個位置，且必定要放行，由於只有放行了，纔會去執行afterCompletion，並且放在攔截器鏈的第一個的話，afterCompletion方法會最後執行，才能在裏面執行統一異常處理的邏輯。
　　再好比，登錄認證攔截器，放在攔截器連接中第一個位置（若是有統一異常處理，那麼應該放在統一異常處理的後面）。權限校驗攔截器，放在登錄認證攔截器以後（由於登錄經過後才校驗權限）。
　　這裏寫一個登錄驗證的攔截器來講明一下如何使用springmvc的攔截器。

3.1 需求

　　首先看一下需求：咱們要攔截啥，攔截到了要幹啥。思路以下：

一、用戶請求url
二、攔截器進行攔截校驗
若是請求的url是公開地址（無需登錄便可訪問的url），讓放行。
若是用戶session不存在，則跳轉到登錄頁面。
若是用戶session存在則放行，繼續操做。

3.2 實現登錄的Controller方法

//登錄
@RequestMapping("/login")
public String login(HttpServletRequest request, String username, String password) throws Exception {

    //實際中要去和數據庫匹配的
    //....
    //這裏就假設登錄成功了
    HttpSession session = request.getSession();
    session.setAttribute("username", username);
    return "redirect:queryItems.action";
}

//退出
@RequestMapping("/logout")
public String logout(HttpServletRequest request) throws Exception {

    HttpSession session = request.getSession();
    session.invalidate();
    return "redirect:queryItems.action";
}

3.2 登錄驗證攔截器的實現

//測試攔截器1
public class LoginInterceptor implements HandlerInterceptor{

    //進入Handler方法以前執行
    //能夠用於身份認證、身份受權。若是認證沒有經過表示用戶沒有登錄，須要此方法攔截再也不往下執行，不然就放行
    @Override
    public boolean preHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler) throws Exception {

        //獲取請求的url
        String url = request.getRequestURI();
        //判斷url是否公開地址（實際使用時將公開地址配置到配置文件中）
        //這裏假設公開地址是否登錄提交的地址
        if(url.indexOf("login.action") > 0) {
            //若是進行登錄提交，放行
            return true;
        }

        //判斷session
        HttpSession session = request.getSession();
        //從session中取出用戶身份信息
        String username = (String) session.getAttribute("username");
        if(username != null) {
            return true;
        }

        //執行到這裏表示用戶身份須要驗證，跳轉到登錄頁面
        request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);

        return false;
    }
    //節省空間，省略另外兩個方法不寫了，也不用處理
}

而後配置該攔截器：

<!-- 配置攔截器 -->
<mvc:interceptors>
    <!-- 多個攔截器，按順序執行 -->    
    <mvc:interceptor>
        <mvc:mapping path="/**"/> <!-- 攔截全部的url包括子url路徑 -->
        <bean class="ssm.interceptor.LoginInterceptor"/>
    </mvc:interceptor>
    <!-- 其餘攔截器 -->
</mvc:interceptors>

　　這樣當咱們任意請求一個url的時候，就會被剛剛咱們定義的攔截器給捕獲到，而後會判斷是否session中有用戶信息，沒有的話就會跳到登錄頁面讓咱們登錄：

<form action="${pageContext.request.contextPath }/login.action" method="post">
    用戶名：<input type="text" name="username" /><br>
    密碼：<input type="password" name="password" /><br>
    <input type="submit" name="提交" />
</form>

攔截器的使用基本上就總結到這了。