Java過濾器Filter使用詳解

 轉載請注明原文地址：http://www.cnblogs.com/ygj0930/p/6374212.html

 在我的項目中有具體應用：https://github.com/ygj0930/CoupleSpace

過濾器

   過濾器是處於客戶端與服務器資源文件之間的一道過濾網，在訪問資源文件之前，通過一系列的過濾器對請求進行修改、判斷等，把不符合規則的請求在中途攔截或修改。也可以對響應進行過濾，攔截或修改響應。

 

 

      如圖，瀏覽器發出的請求先遞交給第一個filter進行過濾，符合規則則放行，遞交給filter鏈中的下一個過濾器進行過濾。過濾器在鏈中的順序與它在web.xml中配置的順序有關，配置在前的則位於鏈的前端。當請求通過了鏈中所有過濾器后就可以訪問資源文件了，如果不能通過，則可能在中間某個過濾器中被處理掉。

     在doFilter（）方法中，chain.doFilter()前的一般是對request執行的過濾操作，chain.doFilter后面的代碼一般是對response執行的操作。過濾鏈代碼的執行順序如下：

    

     過濾器一般用於登錄權限驗證、資源訪問權限控制、敏感詞匯過濾、字符編碼轉換等等操作，便於代碼重用，不必每個servlet中還要進行相應的操作。

     下面是過濾器的簡單應用：

    1：創建過濾器

   

    如圖，新建一個class，實現接口Filter（注意：是javax.servlet中的Filter）。

    2：重寫過濾器的doFilter(request，response，chain)方法。另外兩個init()、destroy()方法一般不需要重寫。在doFilter方法中進行過濾操作。

    常用代碼有：獲取請求、獲取響應、獲取session、放行。

    剩下的代碼就是根據session的屬性進行過濾操作、設置編碼格式等等了，看情況而定。

HttpServletRequest request=(HttpServletRequest) arg0;//獲取request對象
HttpServletResponse response=(HttpServletResponse) arg1;//獲取response對象
HttpSession session=request.getSession();//獲取session對象

過濾操作代碼......

chain.doFilter(request, response);//放行，通過了當前過濾器，遞交給下一個filter進行過濾

    3：在web.xml中配置過濾器。這里要謹記一條原則：在web.xml中，監聽器>過濾器>servlet。也就是說web.xml中監聽器配置在過濾器之前，過濾器配置在servlet之前，否則會出錯。

<filter>  
    <filter-name>loginFilter<／filter-name>／／過濾器名稱  
    <filter-class>com.ygj.control.loginFilter<／filter-class>／／過濾器類的包路徑
<init—param> //可選 
    <param—name>參數名<／param-name>／／過濾器初始化參數
    <param-value>參數值<／param-value>  
<／init—pamm>  
<／filter> 
 
<filter-mapping>／／過濾器映射  
    <filter-name>loginFilter<／filter-name>  
<url—pattern>指定過濾器作用的對象</url-pattern>

    在配置中需要注意的有兩處：一是<filter-class>指明過濾器類所在的包路徑。二是<url-pattren>處定義過濾器作用的對象。一般有以下規則：

    1：作用與所有web資源：<url—pattern>/*</url-pattern>。則客戶端請求訪問任意資源文件時都要經過過濾器過濾，通過則訪問文件，否則攔截。

    2：作用於某一文件夾下所有文件：<url—pattern>/dir/*</url-pattern>

    3：作用於某一種類型的文件：<url—pattern>*.擴展名</url-pattern>。比如<url—pattern>*.jsp</url-pattern>過濾所有對jsp文件的訪問請求。

    4：作用於某一文件夾下某一類型文件：<url—pattern>/dir/*.擴展名</url-pattern>

    如果一個過濾器需要過濾多種文件，則可以配置多個<filter-mapping>，一個mapping定義一個url-pattern來定義過濾規則。

   <filter>
      <filter-name>loginFilter</filter-name>
      <filter-class>com.ygj.control.loginFilter</filter-class>
  </filter>
  <filter-mapping>
      <filter-name>loginFilter</filter-name>
      <url-pattern>*.jsp</url-pattern>
  </filter-mapping>
  <filter-mapping>
      <filter-name>loginFilter</filter-name>
      <url-pattern>*.do</url-pattern>
  </filter-mapping>

    例1：用過濾器實現登錄驗證，沒登錄則駁回訪問請求並重定向到登錄頁面。

public void doFilter(ServletRequest arg0, ServletResponse arg1,
            FilterChain arg2) throws IOException, ServletException {
        
        HttpServletRequest request=(HttpServletRequest) arg0;
        HttpServletResponse response=(HttpServletResponse) arg1;
        HttpSession session=request.getSession();
        
        String path=request.getRequestURI();
        
        Integer uid=(Integer)session.getAttribute("userid");
        
        if(path.indexOf("/login.jsp")>-1){//登錄頁面不過濾
            arg2.doFilter(arg0, arg1);//遞交給下一個過濾器
            return;
        }
        if(path.indexOf("/register.jsp")>-1){//注冊頁面不過濾
            arg2.doFilter(request, response);
            return;
        }
        
        if(uid!=null){//已經登錄
            arg2.doFilter(request, response);//放行，遞交給下一個過濾器
            
        }else{
            response.sendRedirect("login.jsp");
        }

    }

     例2：設置字符編碼

public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
          HttpServletRequest request2=(HttpServletRequest) request;
          HttpServletResponse response2=(HttpServletResponse) response;
          
          request2.setCharacterEncoding("UTF-8");  
          response2.setCharacterEncoding("UTF-8"); 
          
          chain.doFilter(request, response); 

    }