Filter介紹

Filter可認為是Servlet的一種“變種”，它主要用於對使用者請求進行預處理，也可以對HttpServletResponse進行後處理，是個典型的處理鏈。它與Servlet的區別在於：它不能直接向用戶生成響應。完整的流程是：Filter對使用者請求進行預處理，接著將請求交給Servlet進行處理並生成響應，最後Filter再對伺服器響應進行後處理。

Filter有如下幾個用處。

• 在HttpServletRequest到達Servlet之前，攔截客戶的HttpServletRequest。
• 根據需要檢查HttpServletRequest，也可以修改HttpServletRequest頭和資料。
• 在HttpServletResponse到達客戶端之前，攔截HttpServletResponse。
• 根據需要檢查HttpServletResponse，也可以修改HttpServletResponse頭和資料。

Filter有如下幾個種類。

• 使用者授權的Filter：Filter負責檢查使用者請求，根據請求過濾使用者非法請求。
• 日誌Filter：詳細記錄某些特殊的使用者請求。
• 負責解碼的Filter：包括對非標準編碼的請求解碼。
• 能改變XML內容的XSLT Filter等。
• Filter可負責攔截多個請求或響應；一個請求或響應也可被多個請求攔截。

建立一個Filter只需兩個步驟：

• 建Filter處理類；
• web.xml檔案中配置Filter。

下面先介紹一個簡單的記錄日誌的Filter，這個Filter負責攔截所有的使用者請求，並將請求的資訊記錄在日誌中。

LogFilter過濾器類

package com.ljq.servlet;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
 
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;

publicclass LogFilter implements Filter {
// FilterConfig可用於訪問Filter的配置資訊private FilterConfig config;

// 實現初始化方法publicvoid init(FilterConfig config) {
this.config = config;
    }

// 實現銷燬方法publicvoid destroy() {
this.config =null;
    }

// 執行過濾的核心方法publicvoid doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
// ---------下面程式碼用於對使用者請求執行預處理---------
// 獲取ServletContext物件，用於記錄日誌        ServletContext context =this.config.getServletContext();
long before = System.currentTimeMillis();
        System.out.println("開始過濾...");
// 將請求轉換成HttpServletRequest請求        HttpServletRequest hrequest = (HttpServletRequest) request;
// 記錄日誌        context.log("Filter已經截獲到使用者的請求地址： "+ hrequest.getServletPath());
// Filter只是鏈式處理，請求依然放行到目的地址        chain.doFilter(request, response);

// ---------下面程式碼用於對伺服器響應執行後處理---------long after = System.currentTimeMillis();
// 記錄日誌        context.log("過濾結束");
// 再次記錄日誌        context.log("請求被定位到"+ hrequest.getRequestURI() +"所花的時間為: "+ (after - before));
    }

}

web.xml

<?xml version="1.0" encoding="UTF-8"?><web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee     http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"><filter><filter-name>LogFilter</filter-name><filter-class>com.ljq.servlet.LogFilter</filter-class></filter><filter-mapping><filter-name>LogFilter</filter-name><url-pattern>/*</url-pattern>
    </filter-mapping>

    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

上面程式實現了doFilter()方法，實現該方法就可實現對使用者請求進行預處理，也可實現對伺服器響應進行後處理——它們的分界線為是否呼叫了chain.doFilter()，執行該方法之前，即對使用者請求進行預處理；執行該方法之後，即對伺服器響應進行後處理。

在上面的請求Filter中，僅在日誌中記錄請求的URL，對所有的請求都執行chain.doFilter (request,reponse)方法，當Filter對請求過濾後，依然將請求傳送到目的地址。如果需要檢查許可權，可以在Filter中根據使用者請求 的HttpSession，判斷使用者許可權是否足夠。如果許可權不夠，直接呼叫重定向即可，無須呼叫chain.doFilter(request,reponse)方法。

下面是一個例項：

package com.ljq.servlet;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

publicclass AuthorityFilter implements Filter {
private FilterConfig config;

// 實現初始化方法publicvoid init(FilterConfig config) {
this.config = config;
    }

// 實現銷燬方法publicvoid destroy() {
this.config =null;
    }

// 執行過濾的核心方法publicvoid doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
// 獲取該Filter的配置引數        String encoding = config.getInitParameter("encoding");
        String login = config.getInitParameter("login");

// 設定request編碼用的字符集        request.setCharacterEncoding(encoding); 
        HttpServletRequest req = (HttpServletRequest) request;
        HttpSession session = req.getSession();
// 獲取客戶請求的路徑        String requestPath = req.getServletPath();


// 如果session範圍的user為null，即表明沒有登入
// 且使用者請求的既不是登入頁面，也不是處理登入的頁面if (session.getAttribute("user") ==null&&!requestPath.endsWith(login)) {
// forward到登入頁面            request.setAttribute("tip", "您還沒有登入");
            request.getRequestDispatcher(login).forward(request, response);
        }
// 放行請求else {
            chain.doFilter(request, response);
        }
    }
}

上面Filter的doFilter方法裡2行斜體字程式碼用於獲取Filter的配置引數，而程式中粗體字程式碼則是此Filter的核心，①號程式碼 按配置引數設定了request編碼所用的字符集，接下來的粗體字程式碼判斷session範圍內是否有user屬性——沒有該屬性即認為沒有登入，如果既沒有登入，而且請求地址也不是登入頁，系統直接跳轉到登入頁面。

在web.xml檔案中配置該Filter，使用init-param元素為該Filter配置引數，init-param可接受如下兩個子元素：

param-name：指定引數名。

param-value：指定引數值。

該Filter的配置片段如下：

<?xml version="1.0" encoding="UTF-8"?><web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee     http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"><!-- 定義Filter --><filter><filter-name>authority</filter-name><filter-class>com.ljq.servlet.AuthorityFilter</filter-class><!-- 下面3個init-param元素配置了3個引數 --><init-param><param-name>encoding</param-name><param-value>UTF-8</param-value></init-param><init-param><param-name>login</param-name><param-value>/login.jsp</param-value></init-param></filter><filter-mapping><filter-name>authority</filter-name><url-pattern>/*</url-pattern>
    </filter-mapping>


    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

上面配置片段中粗體字程式碼為該Filter指定了2個配置引數，指定login為/login.jsp，這表明：如果沒有登入該應用，普通使用者只能訪問/login.jsp。只有當用戶登入該應用後才可自由訪問其他頁面。