程式師世界 >> 編程語言 >> JAVA編程 >> JAVA綜合教程 >> SpringMVC學習記錄(七)--攔截器的使用

SpringMVC學習記錄(七)--攔截器的使用

編輯：JAVA綜合教程

SpringMVC學習記錄(七)--攔截器的使用

SpringMVC的請求如下面這種圖所示:
此處輸入圖片的描述

可以看出所有的請求都要通過Dispatherservlet來接收,然後通過Handlermapping來決定使用哪個控制器,再根據ViewResolver來決定返回哪個視圖.從流程來看,Handlermapping就是我們可以實現攔截器的第一種方法.另外還有一種是實現WebRequestInterceptor接口,或者繼承其子類.

一.實現HandlerInterceptor接口

實現HandlerInterceptor接口或者繼承HandlerInterceptor的子類,比如比如Spring 已經提供的實現了HandlerInterceptor 接口的抽象類HandlerInterceptorAdapter ,下面講實現其接口的寫法,先看一下這個接口的三個方法.
- 方法preHandle: 顧名思義，該方法將在請求處理之前進行調用。SpringMVC 中的Interceptor 是鏈式的調用的，在一個應用中或者說是在一個請求中可以同時存在多個Interceptor 。每個Interceptor 的調用會依據它的聲明順序依次執行，而且最先執行的都是Interceptor 中的preHandle 方法，所以可以在這個方法中進行一些前置初始化操作或者是對當前請求的一個預處理，也可以在這個方法中進行一些判斷來決定請求是否要繼續進行下去。該方法的返回值是布爾值Boolean 類型的，當它返回為false 時，表示請求結束，後續的Interceptor 和Controller 都不會再執行；當返回值為true 時就會繼續調用下一個Interceptor 的preHandle 方法，如果已經是最後一個Interceptor 的時候就會是調用當前請求的Controller 方法。
- 方法postHandle:由preHandle 方法的解釋我們知道這個方法包括後面要說到的afterCompletion 方法都只能是在當前所屬的Interceptor 的preHandle 方法的返回值為true 時才能被調用。postHandle 方法，顧名思義就是在當前請求進行處理之後，也就是Controller 方法調用之後執行，但是它會在DispatcherServlet 進行視圖返回渲染之前被調用，所以我們可以在這個方法中對Controller 處理之後的ModelAndView 對象進行操作。postHandle 方法被調用的方向跟preHandle 是相反的，也就是說先聲明的Interceptor 的postHandle 方法反而會後執行，這和Struts2 裡面的Interceptor 的執行過程有點類型。Struts2 裡面的Interceptor 的執行過程也是鏈式的，只是在Struts2 裡面需要手動調用ActionInvocation 的invoke 方法來觸發對下一個Interceptor 或者是Action 的調用，然後每一個Interceptor 中在invoke 方法調用之前的內容都是按照聲明順序執行的，而invoke 方法之後的內容就是反向的。
- 方法afterCompletion:該方法也是需要當前對應的Interceptor 的preHandle 方法的返回值為true 時才會執行。顧名思義，該方法將在整個請求結束之後，也就是在DispatcherServlet 渲染了對應的視圖之後執行。這個方法的主要作用是用於進行資源清理工作的。

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class SpringMVCInterceptor implements HandlerInterceptor {


    /**
     * preHandle方法是進行處理器攔截用的，顧名思義，該方法將在Controller處理之前進行調用，SpringMVC中的Interceptor攔截器是鏈式的，可以同時存在
     * 多個Interceptor，然後SpringMVC會根據聲明的前後順序一個接一個的執行，而且所有的Interceptor中的preHandle方法都會在
     * Controller方法調用之前調用。SpringMVC的這種Interceptor鏈式結構也是可以進行中斷的，這種中斷方式是令preHandle的返
     * 回值為false，當preHandle的返回值為false的時候整個請求就結束了。
     */
    @Override
    public boolean preHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler) throws Exception {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * 這個方法只會在當前這個Interceptor的preHandle方法返回值為true的時候才會執行。postHandle是進行處理器攔截用的，它的執行時間是在處理器進行處理之
     * 後，也就是在Controller的方法調用之後執行，但是它會在DispatcherServlet進行視圖的渲染之前執行，也就是說在這個方法中你可以對ModelAndView進行操
     * 作。這個方法的鏈式結構跟正常訪問的方向是相反的，也就是說先聲明的Interceptor攔截器該方法反而會後調用，這跟Struts2裡面的攔截器的執行過程有點像，
     * 只是Struts2裡面的intercept方法中要手動的調用ActionInvocation的invoke方法，Struts2中調用ActionInvocation的invoke方法就是調用下一個Interceptor
     * 或者是調用action，然後要在Interceptor之前調用的內容都寫在調用invoke之前，要在Interceptor之後調用的內容都寫在調用invoke方法之後。
     */
    @Override
    public void postHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        // TODO Auto-generated method stub

    }

    /**
     * 該方法也是需要當前對應的Interceptor的preHandle方法的返回值為true時才會執行。該方法將在整個請求完成之後，也就是DispatcherServlet渲染了視圖執行，
     * 這個方法的主要作用是用於清理資源的，當然這個方法也只能在當前這個Interceptor的preHandle方法的返回值為true時才會執行。
     */
    @Override
    public void afterCompletion(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex)
    throws Exception {
        // TODO Auto-generated method stub

    }

}

二.實現WebRequestInterceptor接口

WebRequestInterceptor 中也定義了三個方法，我們也是通過這三個方法來實現攔截的。這三個方法都傳遞了同一個參數WebRequest ，那麼這個WebRequest 是什麼呢？這個WebRequest 是Spring 定義的一個接口，它裡面的方法定義都基本跟HttpServletRequest 一樣，在WebRequestInterceptor 中對WebRequest 進行的所有操作都將同步到HttpServletRequest 中，然後在當前請求中一直傳遞。

方法preHandle:方法將在請求處理之前進行調用，也就是說會在Controller 方法調用之前被調用。這個方法跟HandlerInterceptor 中的preHandle 是不同的，主要區別在於該方法的返回值是void ，也就是沒有返回值，所以我們一般主要用它來進行資源的准備工作，比如我們在使用Hibernate 的時候可以在這個方法中准備一個Hibernate 的Session 對象，然後利用WebRequest 的setAttribute(name, value, scope) 把它放到WebRequest 的屬性中。這裡可以說說這個setAttribute 方法的第三個參數scope ，該參數是一個Integer 類型的。在WebRequest 的父層接口RequestAttributes 中對它定義了三個常量：
SCOPE_REQUEST ：它的值是0 ，代表只有在request 中可以訪問。
SCOPE_SESSION ：它的值是1 ，如果環境允許的話它代表的是一個局部的隔離的session，否則就代表普通的session，並且在該session范圍內可以訪問。
SCOPE_GLOBAL_SESSION ：它的值是2 ，如果環境允許的話，它代表的是一個全局共享的session，否則就代表普通的session，並且在該session 范圍內可以訪問。

方法postHandle:該方法將在請求處理之後，也就是在Controller 方法調用之後被調用，但是會在視圖返回被渲染之前被調用，所以可以在這個方法裡面通過改變數據模型ModelMap 來改變數據的展示。該方法有兩個參數，WebRequest 對象是用於傳遞整個請求數據的，比如在preHandle 中准備的數據都可以通過WebRequest 來傳遞和訪問；ModelMap 就是Controller 處理之後返回的Model 對象，我們可以通過改變它的屬性來改變返回的Model 模型。

方法afterCompletion:該方法會在整個請求處理完成，也就是在視圖返回並被渲染之後執行。所以在該方法中可以進行資源的釋放操作。而WebRequest 參數就可以把我們在preHandle 中准備的資源傳遞到這裡進行釋放。Exception 參數表示的是當前請求的異常對象，如果在Controller 中拋出的異常已經被Spring 的異常處理器給處理了的話，那麼這個異常對象就是是null 。

import org.springframework.ui.ModelMap;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.context.request.WebRequestInterceptor;

public class AllInterceptor implements WebRequestInterceptor {

    /**
     * 在請求處理之前執行，該方法主要是用於准備資源數據的，然後可以把它們當做請求屬性放到WebRequest中
     */
    @Override
    public void preHandle(WebRequest request) throws Exception {
        // TODO Auto-generated method stub
        System.out.println("AllInterceptor...............................");
        request.setAttribute("request", "request", WebRequest.SCOPE_REQUEST);//這個是放到request范圍內的，所以只能在當前請求中的request中獲取到
        request.setAttribute("session", "session", WebRequest.SCOPE_SESSION);//這個是放到session范圍內的，如果環境允許的話它只能在局部的隔離的會話中訪問，否則就是在普通的當前會話中可以訪問
        request.setAttribute("globalSession", "globalSession", WebRequest.SCOPE_GLOBAL_SESSION);//如果環境允許的話，它能在全局共享的會話中訪問，否則就是在普通的當前會話中訪問
    }

    /**
     * 該方法將在Controller執行之後，返回視圖之前執行，ModelMap表示請求Controller處理之後返回的Model對象，所以可以在
     * 這個方法中修改ModelMap的屬性，從而達到改變返回的模型的效果。
     */
    @Override
    public void postHandle(WebRequest request, ModelMap map) throws Exception {
        // TODO Auto-generated method stub
        for (String key:map.keySet())
            System.out.println(key + "-------------------------");;
        map.put("name3", "value3");
        map.put("name1", "name1");
    }

    /**
     * 該方法將在整個請求完成之後，也就是說在視圖渲染之後進行調用，主要用於進行一些資源的釋放
     */
    @Override
    public void afterCompletion(WebRequest request, Exception exception)
    throws Exception {
        // TODO Auto-generated method stub
        System.out.println(exception + "-=-=--=--=-=-=-=-=-=-=-=-==-=--=-=-=-=");
    }

}

三.攔截器的配置

1.mvc:interceptors標簽來聲明需要加入到SpringMVC攔截器鏈中的攔截器

由上面的示例可以看出可以利用mvc:interceptors標簽聲明一系列的攔截器，然後它們就可以形成一個攔截器鏈，攔截器的執行順序是按聲明的先後順序執行的，先聲明的攔截器中的preHandle方法會先執行，然而它的postHandle方法和afterCompletion方法卻會後執行。
在mvc:interceptors標簽下聲明interceptor主要有兩種方式：
（1）直接定義一個Interceptor實現類的bean對象。使用這種方式聲明的Interceptor攔截器將會對所有的請求進行攔截。
（2）使用mvc:interceptor標簽進行聲明。使用這種方式進行聲明的Interceptor可以通過mvc:mapping子標簽來定義需要進行攔截的請求路徑。
經過上述兩步之後，定義的攔截器就會發生作用對特定的請求進行攔截了。

原文鏈接 http://haohaoxuexi.iteye.com/blog/1750680