一、 Filter 的介紹及使用

什么是過濾器？

與 Servlet 相似，過濾器是一些 web 應用程序組件，可以綁定到一個 web 應用程序中。但是與其他 web 應用程序組件不同的是，過濾器是 " 鏈 " 在容器的處理過程中的。這就意味著它們會在 servlet 處理器之前訪問一個進入的請求，并且在外發響應信息返回到客戶前訪問這些響應信息。這種訪問使得過濾器可以檢查并修改請求和響應的內容。

過濾器適用于那些地方？

l 為一個 web 應用程序的新功能建立模型 ( 可被添加到 web 應用程序中或者從 web 應用程序中刪除而不需要重寫基層應用程序代碼 ) ；

l 向過去的代碼添加新功能。

過濾器放在容器結構的什么位置？

過濾器放在 web 資源之前，可以在請求抵達它所應用的 web 資源 ( 可以是一個 Servlet 、一個 Jsp 頁面，甚至是一個 HTML 頁面 ) 之前截獲進入的請求，并且在它返回到客戶之前截獲輸出請求。 Filter ：用來攔截請求，處于客戶端與被請求資源之間，目的是重用代碼。 Filter 鏈，在 web.xml 中哪個先配置，哪個就先調用。在 filter 中也可以配置一些初始化參數。

Java 中的 Filter 并不是一個標準的 Servlet ，它不能處理用戶請求，也不能對客戶端生成響應。 主要用于對 HttpServletRequest 進行預處理，也可以對 HttpServletResponse 進行后處理，是個典型的處理鏈。

Filter 有如下幾個用處：

l 在 HttpServletRequest 到達 Servlet 之前，攔截客戶的 HttpServletRequest 。

l 根據需要檢查 HttpServletRequest ，也可以修改 HttpServletRequest 頭和數據。

l 在 HttpServletResponse 到達客戶端之前，攔截 HttpServletResponse 。

l 根據需要檢查 HttpServletResponse ，可以修改 HttpServletResponse 頭和數據。

Filter 有如下幾個種類：

l 用戶授權的 Filter: Filter 負責檢查用戶請求，根據請求過濾用戶非法請求。

l 日志 Filter: 詳細記錄某些特殊的用戶請求。

l 負責解碼的 Filter: 包括對非標準編碼的請求解碼。

l 能改變 XML 內容的 XSLTFilter 等。

一個 Filter 可負責攔截多個請求或響應 : 一個請求或響應也可被多個請求攔截。

創建一個 Filter 只需兩個步驟 :
(1) 創建 Filter 處理類 :

(2) 在 web.xml 文件中配置 Filter 。
創建 Filter 必須實現 javax.servlet.Filter 接口，在該接口中定義了三個方法。
? void init(FilterConfig config): 用于完成 Filter 的初始化。
? void destroy(): 用于 Filter 銷毀前，完成某些資源的回收。
? void doFilter(ServletRequest request, ServletResponse response,FilterChain chain): 實現過濾功能，該方法就是對每個請求及響應增加的額外處理。

過濾器 Filter 也具有生命周期： init()->doFilter()->destroy() ，由部署文件中的 filter 元素驅動。在 servlet2.4 中，過濾器同樣可以用于請求分派器，但須在 web.xml 中聲明， <dispatcher>INCLUDE 或 FORWARD 或 REQUEST 或 ERROR</dispatcher> 該元素位于 filter-mapping 中。

Filter 常用的場景：

例一、 日志的記錄，當有請求到達時，在該過濾器中進行日志的記錄。處理完成后，進入后續的 Filter 或者處理。

步驟 1 ：編寫 Filter 類

package test.filter;

import javax.servlet.Filter;

import javax.servlet.FilterChain;

import javax.servlet.FilterConfig;

import javax.servlet.ServletContext;

import javax.servlet.ServletRequest;

import javax.servlet.ServletResponse;

import javax.servlet.http.HttpServletRequest;

public class LogFilter implements Filter {

private FilterConfig config ;

// 實現初始化方法

public void init(FilterConfig config) {

this . config = config;

}

// 實現銷毀方法

public void destroy() {

this . config = null ;

}

public void doFilter(ServletRequest request, ServletResponse response,

FilterChain chain) {

// 獲取 ServletContext 對象，用于記錄日志

ServletContext context = this . config .getServletContext();

long before = System. currentTimeMillis ();

System. out .println( " 開始過濾 ... " );

// 將請求轉換成 HttpServletRequest 請求

HttpServletRequest hrequest = (HttpServletRequest) request;

// 記錄日志

context.log( "Filter 已經截獲到用戶的請求的地址 : " + hrequest.getServletPath());

try {

// Filter 只是鏈式處理，請求依然轉發到目的地址。

chain.doFilter(request, response);

} catch (Exception e) {

e.printStackTrace();

}

long after = System. currentTimeMillis ();

// 記錄日志

context.log( " 過濾結束 " );

// 再次記錄日志

context.log( " 請求被定位到 " + ((HttpServletRequest) request).getRequestURI()

+ " 所花的時間為 : " + (after - before));

}

}

在上面的請求 Filter 中，僅在日志中記錄請求的 URL ，對所有的請求都執行 chain.doFilter(request ， reponse) 方法，當 Filter 對請求過濾后，依然將請求發送到目的地址。

步驟 2 ：在 web.xml 中配置 Filter

<!-- 定義 Filter -->

<filter>

<!-- Filter 的名字 -->

<filter-name>log</filter-name>

<!-- Filter 的實現類 -->

<filter-class> test.filter.LogFilter</filter-class>

</filter>

<!-- 定義 Filter 攔截地址 -->

<filter-mapping>

<!-- Filter 的名字 -->

<filter-name>log</filter-name>

<!-- Filter 負責攔截的 URL -->

<url-pattern>/filter/*</url-pattern>

</filter-mapping>

通過上述步驟的操作，此時就可以通過 URI 進行訪問。具體訪問后會在 log 文件中的 localhost 文件中產生具體的訪問日志。如下所示：

2010-12-28 21:12:50 org.apache.catalina.core.ApplicationContext log

信息 : 請求被定位到 /examples/jsp/jsp2/el/basic-arithmetic.jsp 所花的時間為 : 0

2010-12-28 21:14:55 org.apache.catalina.core.ApplicationContext log

信息 : Filter 已經截獲到用戶的請求的地址 : /jsp/jsp2/el/basic-comparisons.jsp

2010-12-28 21:14:56 org.apache.catalina.core.ApplicationContext log

信息 : 過濾結束

例二、 進行編碼的修正，當有新的請求時，需要將用戶傳送過來的字符進行重新編碼，以使其可以滿足服務器的編碼格式。

1、 編寫 EncodingFilter 類

package test.filter;

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;

public class EncodingFilter implements Filter {

private FilterConfig filterConfig = null ;

private String encoding = null ;

// 實現銷毀方法

public void destroy() {

encoding = null ;

}

// 進行具體的過濾

public void doFilter(ServletRequest request, ServletResponse response,

FilterChain chain) throws IOException, ServletException {

// 獲取 ServletContext 對象，用于記錄日志

ServletContext context = this . filterConfig .getServletContext();

context.log( " 開始設置編碼格式 " );

String encoding = getEncoding();

if (encoding == null ){

encoding = "gb2312" ;

}

// 在請求里設置上指定的編碼

request.setCharacterEncoding(encoding);

chain.doFilter(request, response);

context.log( " 成功設置了編碼格式 " );

}

// 初始化配置

public void init(FilterConfig filterConfig) throws ServletException {

this . filterConfig = filterConfig;

this . encoding = filterConfig.getInitParameter( "encoding" );

}

private String getEncoding() {

return this . encoding ;

}

}

步驟 2 ：在 web.xml 中配置 Filter

<!-- 定義 Filter -->

<filter>

<!-- Filter 的名字 -->

<filter-name>encoding</filter-name>

<!-- Filter 的實現類 -->

<filter-class> test.filter.EncodingFilter</filter-class>

<init-param>

<param-name>encoding</param-name>

<param-value>gb2312</param-value>

</init-param>

</filter>

<!-- 定義 Filter 攔截地址 -->

<filter-mapping>

<!-- Filter 的名字 -->

<filter-name> encoding </filter-name>

<!-- Filter 負責攔截的 URL -->

<url-pattern>/encode/*</url-pattern>

</filter-mapping>

通過上述步驟的操作，此時就可以通過 URI 進行訪問。

例三、 用戶權限的認證，當用戶發送請求時，可以對用戶的身份信息進行驗證，如果能夠通過驗證則接下來再進行其它操作，否則直接不進入下一步的處理。

1、 編寫身份認證 SecurityFilter 類

package test.filter;

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;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpSession;

public class SecurityFilter implements Filter {

private FilterConfig filterConfig ;

// 初始化方法實現

@Override

public void init(FilterConfig filterConfig) throws ServletException {

this . filterConfig = filterConfig;

}

// 身份認證的過濾

@Override

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

throws IOException, ServletException {

ServletContext context = this . filterConfig .getServletContext();

HttpServletRequest req = (HttpServletRequest) request;

HttpServletResponse res = (HttpServletResponse) response;

HttpSession session = req.getSession();

// 登錄后才能進入下一步處理，否則直接進入錯誤提示頁面

if (session.getAttribute( "username" ) != null ) {

context.log( " 身份認證通過，進入下一步處理 " );

chain.doFilter(request, response);

} else {

context.log( " 身份認證失敗，直接返回 " );

res.sendRedirect( "../failure.jsp" );

}

}

// 實現銷毀方法

@Override

public void destroy() {

this . filterConfig = null ;

}

}

步驟 2 ：在 web.xml 中配置 Filter

<!-- 定義 Filter -->

<filter>

<!-- Filter 的名字 -->

<filter-name>security</filter-name>

<!-- Filter 的實現類 -->

<filter-class> test.filter.SecurityFilter</filter-class>

</filter>

<!-- 定義 Filter 攔截地址 -->

<filter-mapping>

<!-- Filter 的名字 -->

<filter-name> security </filter-name>

<!-- Filter 負責攔截的 URL -->

<url-pattern>/security/*</url-pattern>

</filter-mapping>

通過上述步驟的操作，此時就可以通過 URI 進行訪問。此時如果能夠取得 Session 中的 username 值時，會直接進入下一步處理，否則直接進入錯誤頁面。

二、過濾鏈 FilterChain

兩個過濾器， EncodingFilter 負責設置編碼， SecurityFilter 負責控制權限，服務器會按照 web.xml 中過濾器定義的先后循序組裝成一條鏈，然后一次執行其中的 doFilter() 方法。執行的順序就如下圖所示，執行第一個過濾器的 chain.doFilter() 之前的代碼，第二個過濾器的 chain.doFilter() 之前的代碼，請求的資源，第二個過濾器的 chain.doFilter() 之后的代碼，第一個過濾器的 chain.doFilter() 之后的代碼，最后返回響應。

執行的代碼順序是：

l 執行 EncodingFilter.doFilter() 中 chain.doFilter() 之前的部分； request.setCharacterEncoding(encoding);

l 執行 SecurityFilter.doFilter() 中 chain.doFilter() 之前的部分：判斷用戶是否已登錄。

l 如果用戶已登錄，則訪問請求的資源。

l 如果用戶未登錄，則頁面重定向到： /failure.jsp 。

l 執行 SecurityFilter.doFilter() 中 chain.doFilter() 之后的部分：這里沒有代碼。

l 執行 EncodingFilter.doFilter() 中 chain.doFilter() 之后的部分：寫入已經完成的日志。

過濾鏈的好處是，執行過程中任何時候都可以打斷，只要不執行 chain.doFilter() 就不會再執行后面的過濾器和請求的內容。而在實際使用時，就要特別注意過濾鏈的執行順序問題，像 EncodingFilter 就一定要放在所有 Filter 之前，這樣才能確保在使用請求中的數據前設置正確的編碼。

Filter及FilterChain的使用詳解