1. 程式人生 > >web 過濾器 Filter、 Spring 攔截器 interceptor

web 過濾器 Filter、 Spring 攔截器 interceptor

拋出異常 internal 針對 turn 被調用 enc 過濾 過濾器 文件

1、過濾器(Filter)(在web.xml中註冊過濾器)

  首先說一下Filter的使用地方,我們在配置web.xml時,總會配置下面一段設置字符編碼,不然會導致亂碼問題:

<filter>
    <filter-name>encoding</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name
>encoding</param-name> <param-value>UTF-8</param-value> </init-param> <init-param> <param-name>forceEncoding</param-name> <param-value>true</param-value> </init-param> </filter> <filter-mapping
> <filter-name>encoding</filter-name> <servlet-name>/*</servlet-name> </filter-mapping>

  配置這個地方的目的,是讓所有的請求都需要進行字符編碼的設置,下面來介紹一下Filter。

(1)過濾器(Filter):它依賴於servlet容器。在實現上,基於函數回調,它可以對幾乎所有請求進行過濾,但是缺點是一個過濾器實例只能在容器初始化時調用一次。使用過濾器的目的,是用來做一些過濾操作,獲取我們想要獲取的數據,比如:在Javaweb中,對傳入的request、response提前過濾掉一些信息,或者提前設置一些參數,然後再傳入servlet或者Controller進行業務邏輯操作。通常用的場景是:在過濾器中修改字符編碼(CharacterEncodingFilter)、在過濾器中修改HttpServletRequest的一些參數(XSSFilter(自定義過濾器)),如:過濾低俗文字、危險字符等。

public class CharacterEncodingFilter implements Filter {

    protected FilterConfig filterConfig;
    protected String encoding = null;
    protected boolean forceEncoding = true; // 默認為true
    
    public void init(FilterConfig filterConfig) throws ServletException {
        this.filterConfig = filterConfig;
        this.encoding = filterConfig.getInitParameter("encoding");
        String value = filterConfig.getInitParameter("forceEncoding");
        if (value == null) {
            this.forceEncoding = true;
        } else if (value.equalsIgnoreCase("true")) {
            this.forceEncoding = true;
        } else if (value.equalsIgnoreCase("yes")) {
            this.forceEncoding = true;
        } else {
            this.forceEncoding = false;
        }
    }

    public void doFilter(ServletRequest req, ServletResponse res,
            FilterChain chain) throws IOException, ServletException {
        HttpServletRequest  request;
        try {
            request = (HttpServletRequest) req;
        } catch (ClassCastException e) {
            throw new ServletException("non-HTTP request or response");
        }
        
        String encoding = filterConfig.getInitParameter("encoding");
        if(encoding==null){
            encoding = "UTF-8";
        }
        //設置字符編碼
        request.setCharacterEncoding(encoding);
        //將請求與響應傳遞給下個過濾器
        chain.doFilter(request, response);
    }

    public void destroy() {
        this.encoding = null;
        this.filterConfig = null;
    }

}

void init(FilterConfig paramFilterConfig) : 當容器初始化 Filter 時調用,該方法在 Filter 的生命周期只會被調用一次,一般在該方法中初始化一些資源,FilterConfig 是容器提供給 Filter 的初始化參數,在該方法中可以拋出 ServletException 。init 方法必須執行成功,否則 Filter 可能不起作用,出現以下兩種情況時,web 容器中 Filter 可能無效: 1)拋出 ServletException 2)超過 web 容器定義的執行時間。 

doFilter(ServletRequest paramServletRequest, ServletResponse paramServletResponse, FilterChain paramFilterChain) : Web 容器每一次請求都會調用該方法。該方法將容器的請求和響應作為參數傳遞進來, FilterChain 用來調用下一個 Filter。  

void destroy() :當容器銷毀 Filter 實例時調用該方法,可以在方法中銷毀資源,該方法在 Filter 的生命周期只會被調用一次。

註: 其中的FilterConfig對象提供對servlet環境及web.xml文件中指派的過濾器名的訪問。
   FilterConfig對象具有一個getInitParameter方法,它能夠訪問部署描述符文件(web.xml)中分配的過濾器初始化參數。


二:攔截器

  攔截器(Interceptor):它依賴於web框架,在SpringMVC中就是依賴於SpringMVC框架。在實現上,基於Java的反射機制,屬於面向切面編程(AOP)的一種運用,就是在service或者一個方法前,調用一個方法,或者在方法後,調用一個方法,比如動態代理就是攔截器的簡單實現,在調用方法前打印出字符串(或者做其它業務邏輯的操作),也可以在調用方法後打印出字符串,甚至在拋出異常的時候做業務邏輯的操作。由於攔截器是基於web框架的調用,因此可以使用Spring的依賴註入(DI)進行一些業務操作,同時一個攔截器實例在一個controller生命周期之內可以多次調用。但是缺點是只能對controller請求進行攔截,對其他的一些比如直接訪問靜態資源的請求則沒辦法進行攔截處理。

下面在一個項目中我們使用既有多個過濾器,又有多個攔截器,並觀察它們的執行順序:

  (1)第一個過濾器:

public class TestFilter1 extends Filter {  
  
        @Override
          protected void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {  
        //在DispatcherServlet之前執行  
        System.out.println("############TestFilter1 doFilterInternal executed############");  
        filterChain.doFilter(request, response);  
        //在視圖頁面返回給客戶端之前執行,但是執行順序在Interceptor之後  
        System.out.println("############TestFilter1 doFilter after############");  
    }  
}  

  (2)第二個過濾器:

public class TestFilter2 extends Filter {  
 
    @Override
    protected void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {  
        //在DispatcherServlet之前執行  
        System.out.println("############TestFilter2 doFilterInternal executed############");  
        filterChain.doFilter(request, response);  
        //在視圖頁面返回給客戶端之前執行,但是執行順序在Interceptor之後 
        System.out.println("############TestFilter2 doFilter after############");  
    }  
}  

(3)在web.xml中註冊這兩個過濾器:

    <!-- 自定義過濾器:testFilter1 -->   
       <filter>  
            <filter-name>testFilter1</filter-name>  
            <filter-class>com.scorpios.filter.TestFilter1</filter-class>  
        </filter>  
        <filter-mapping>  
            <filter-name>testFilter1</filter-name>  
            <url-pattern>/*</url-pattern>  
        </filter-mapping>  
        <!-- 自定義過濾器:testFilter2 -->   
       <filter>  
            <filter-name>testFilter2</filter-name>  
            <filter-class>com.scorpios.filter.TestFilter2</filter-class>  
        </filter>  
        <filter-mapping>  
            <filter-name>testFilter2</filter-name>  
            <url-pattern>/*</url-pattern>  
        </filter-mapping>  
    

再定義兩個攔截器:
(4)第一個攔截器:

public class BaseInterceptor implements HandlerInterceptor{  
     
    /** 
     * 在DispatcherServlet之前執行 
     * */  
    public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {  
        System.out.println("************BaseInterceptor preHandle executed**********");  
        return true;  
    }  
 
    /** 
     * 在controller執行之後的DispatcherServlet之後執行 
     * */  
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3) throws Exception {  
        System.out.println("************BaseInterceptor postHandle executed**********");  
    }  
     
    /** 
     * 在頁面渲染完成返回給客戶端之前執行 
     * */  
    public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)  
            throws Exception {  
        System.out.println("************BaseInterceptor afterCompletion executed**********");  
    }  
}

(5)第二個攔截器:

public class TestInterceptor implements HandlerInterceptor {  
 
    public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {  
        System.out.println("************TestInterceptor preHandle executed**********");  
        return true;  
    }  
 
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3) throws Exception {  
        System.out.println("************TestInterceptor postHandle executed**********");  
    }  
 
    public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3) throws Exception {  
        System.out.println("************TestInterceptor afterCompletion executed**********");  
    }  
}  

(6)、在SpringMVC的配置文件中,加上攔截器的配置:

<!-- 攔截器 -->  
    <mvc:interceptors>  
        <!-- 對所有請求都攔截,公共攔截器可以有多個 -->  
        <bean name="baseInterceptor" class="com.scorpios.interceptor.BaseInterceptor" />  
        
        <mvc:interceptor> 
            <!-- 對/test.html進行攔截 -->       
            <mvc:mapping path="/test.html"/>  
            <!-- 特定請求的攔截器只能有一個 -->  
            <bean class="com.scorpios.interceptor.TestInterceptor" />  
        </mvc:interceptor>  
    </mvc:interceptors>  

(7)、定義一個Controller控制器:

import org.springframework.stereotype.Controller;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.servlet.ModelAndView;  
  
@Controller  
public class TestController {  
    @RequestMapping("/test")  
    public ModelAndView handleRequest(){  
        System.out.println("---------TestController executed--------");  
        return new ModelAndView("test");  
    }  
}  

(8)、測試結果:
  啟動測試項目,地址如下:http://www.localhost:8080/demo,可以看到控制臺中輸出如下:

技術分享圖片

  這就說明了過濾器的運行是依賴於servlet容器,跟springmvc等框架並沒有關系。並且,多個過濾器的執行順序跟xml文件中定義的先後關系有關。

  接著清空控制臺,並訪問:http://www.localhost:8080/demo/test,再次看控制臺的輸出:

技術分享圖片

  從這個控制臺打印輸出,就可以很清晰地看到有多個攔截器和過濾器存在時的整個執行順序了。當然,對於多個攔截器它們之間的執行順序跟在SpringMVC的配置文件中定義的先後順序有關。


三:結論

  對於上述過濾器和攔截器的測試,可以得到如下結論:
  (1)、Filter需要在web.xml中配置,依賴於Servlet;
  (2)、Interceptor需要在SpringMVC中配置,依賴於框架;
  (3)、Filter的執行順序在Interceptor之前;

  (4)、兩者的本質區別:攔截器(Interceptor)是基於Java的反射機制,而過濾器(Filter)是基於函數回調。從靈活性上說攔截器功能更強大些,Filter能做的事情,都能做,而且可以在請求前,請求後執行,比較靈活。Filter主要是針對URL地址做一個編碼的事情、過濾掉沒用的參數、安全校驗(比較泛的,比如登錄不登錄之類),太細的話,還是建議用interceptor。不過還是根據不同情況選擇合適的。

web 過濾器 Filter、 Spring 攔截器 interceptor