servlet過濾器

Filter簡介

Filter也稱之為過濾器，它是Servlet技術中最激動人心的技術，WEB開發人員通過Filter技術，對web伺服器管理的所有web資源：例如Jsp, Servlet, 靜态圖檔檔案或靜态 html 檔案等進行攔截，進而實作一些特殊的功能。例如實作URL級别的權限通路控制、過濾敏感詞彙、壓縮響應資訊等一些進階功能

Servlet API中提供了一個Filter接口，開發web應用時，如果編寫的Java類實作了這個接口，則把這個java類稱之為過濾器Filter。通過Filter技術，開發人員可以實作使用者在通路某個目标資源之前，對通路的請求和響應進行攔截

Filter是如何實作攔截的？

Filter接口中有一個doFilter方法，當開發人員編寫好Filter，并配置對哪個web資源進行攔截後，WEB伺服器每次在調用web資源的service方法之前，都會先調用一下filter的doFilter方法，是以，在該方法内編寫代碼可達到如下目的：

1、調用目标資源之前，讓一段代碼執行

2、是否調用目标資源（即是否讓使用者通路web資源）。

3、web伺服器在調用doFilter方法時，會傳遞一個filterChain對象進來，filterChain對象是filter接口中最重要的一個對象，它也提供了一個doFilter方法，開發人員可以根據需求決定是否調用此方法，調用該方法，則web伺服器就會調用web資源的service方法，即web資源就會被通路，否則web資源不會被通路。

Filter開發分為二個步驟：

編寫java類實作Filter接口，并實作其doFilter方法。

在 web.xml 檔案中使用<filter>和<filter-mapping>元素對編寫的filter類進行注冊，并設定它所能攔截的資源。

Filter鍊

在一個web應用中，可以開發編寫多個Filter，這些Filter組合起來稱之為一個Filter鍊。

web伺服器根據Filter在web.xml檔案中的注冊順序，決定先調用哪個Filter，當第一個Filter的doFilter方法被調用時，web伺服器會建立一個代表Filter鍊的FilterChain對象傳遞給該方法。在doFilter方法中，開發人員如果調用了FilterChain對象的doFilter方法，則web伺服器會檢查FilterChain對象中是否還有filter，如果有，則調用第2個filter，如果沒有，則調用目标資源。

Filter的生命周期

init(FilterConfig filterConfig) throws ServletException：

和我們編寫的Servlet程式一樣，Filter的建立和銷毀由WEB伺服器負責。 web 應用程式啟動時，web 伺服器将建立Filter 的執行個體對象，并調用其init方法，完成對象的初始化功能，進而為後續的使用者請求作好攔截的準備工作（注：filter對象隻會建立一次，init方法也隻會執行一次。示例）

開發人員通過init方法的參數，可獲得代表目前filter配置資訊的FilterConfig對象。(filterConfig對象見下頁PPT)

destroy()：

在Web容器解除安裝 Filter 對象之前被調用。該方法在Filter的生命周期中僅執行一次。在這個方法中，可以釋放過濾器使用的資源

FilterConfig接口

使用者在配置filter時，可以使用<init-param>為filter配置一些初始化參數，當web容器執行個體化Filter對象，調用其init方法時，會把封裝了filter初始化參數的filterConfig對象傳遞進來。是以開發人員在編寫filter時，通過filterConfig對象的方法，就可獲得：

String getFilterName()：得到filter的名稱。

String getInitParameter(String name)：傳回在部署描述中指定名稱的初始化參數的值。如果不存在傳回null.

Enumeration getInitParameterNames()：傳回過濾器的所有初始化參數的名字的枚舉集合。

public ServletContext getServletContext()：傳回Servlet上下文對象的引用。

Filter的部署

注冊Filter

<filter>
          <filter-name>testFitler</filter-name>
         <filter-class>org.test.TestFiter</filter-class>
         <init-param>
         <param-name>word_file</param-name>    
         <param-value>/WEB-INF/word.txt</param-value>
         </init-param>
</filter>

<filter-name>用于為過濾器指定一個名字，該元素的内容不能為空。

<filter-class>元素用于指定過濾器的完整的限定類名。

<init-param>元素用于為過濾器指定初始化參數，它的子元素<param-name>指定參數的名字，<param-value>指定參數的值。在過濾器中，可以使用FilterConfig接口對象來通路初始化參數。

映射Filter

<filter-mapping>
     <filter-name>testFilter</filter-name>
    <url-pattern>/test.jsp</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>testFilter</filter-name>
   <url-pattern>/index.jsp</url-pattern>
   <dispatcher>REQUEST</dispatcher>
   <dispatcher>FORWARD</dispatcher>
</filter-mapping>

<filter-mapping>元素用于設定一個 Filter 所負責攔截的資源。一個Filter攔截的資源可通過兩種方式來指定：Servlet 名稱和資源通路的請求路徑

<filter-name>子元素用于設定filter的注冊名稱。該值必須是在<filter>元素中聲明過的過濾器的名字

<url-pattern>設定 filter 所攔截的請求路徑(過濾器關聯的URL樣式)

<servlet-name>指定過濾器所攔截的Servlet名稱。

<dispatcher>指定過濾器所攔截的資源被 Servlet 容器調用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，預設REQUEST。使用者可以設定多個<dispatcher> 子元素用來指定 Filter 對資源的多種調用方式進行攔截。

<dispatcher> 子元素可以設定的值及其意義：

　　REQUEST：當使用者直接通路頁面時，Web容器将會調用過濾器。如果目标資源是通過RequestDispatcher的include()或forward()方法通路時，那麼該過濾器就不會被調用。

　　INCLUDE：如果目标資源是通過RequestDispatcher的include()方法通路時，那麼該過濾器将被調用。除此之外，該過濾器不會被調用。

　　FORWARD：如果目标資源是通過RequestDispatcher的forward()方法通路時，那麼該過濾器将被調用，除此之外，該過濾器不會被調用。

　　ERROR：如果目标資源是通過聲明式異常處理機制調用時，那麼該過濾器将被調用。除此之外，過濾器不會被調用。

filter執行個體-統一全站字元編碼的過濾器

1、建立一個類webFilter 并實作接口 Filter

1 package fnz.filter;
 2 import java.io.IOException;
 3 import java.lang.reflect.InvocationHandler;
 4 import java.lang.reflect.Method;
 5 import java.lang.reflect.Proxy;
 6 
 7 import javax.servlet.Filter;
 8 import javax.servlet.FilterChain;
 9 import javax.servlet.FilterConfig;
10 import javax.servlet.ServletException;
11 import javax.servlet.ServletRequest;
12 import javax.servlet.ServletResponse;
13 import javax.servlet.http.HttpServletRequest;
14 import javax.servlet.http.HttpServletResponse;
15 public class webFilter implements Filter {
16 
17     public void init(FilterConfig filterConfig) throws ServletException {
18         
19     }
20 　　
21     public void doFilter(ServletRequest req, ServletResponse res,
22             FilterChain chain) throws IOException, ServletException {
23         final HttpServletRequest request = (HttpServletRequest)req;
24         HttpServletResponse response = (HttpServletResponse)res;
25         request.setCharacterEncoding("utf-8");
26         response.setContentType("text/html;charset=utf-8");
27         //使用代理來擴充request對象的getParameter方法
28         HttpServletRequest _request = (HttpServletRequest)Proxy.newProxyInstance(request.getClass().getClassLoader()
29                 , new Class[]{HttpServletRequest.class}, new InvocationHandler() {
30                     
31                     public Object invoke(Object proxy, Method method, Object[] args)
32                             throws Throwable {
33                         String methodName = method.getName();
34                         if("getParameter".equals(methodName)){
35                             //request中的getParameter方法，當get送出時，需要對編碼進行處理
36                             if("GET".equals(request.getMethod())){
37                                 String content = (String)method.invoke(request, args[0].toString());//request.getParameter(args[0].toString());
38                                 return new String(content.getBytes("ISO8859-1"),"utf-8");
39                             }
40                         }
41                         return method.invoke(request, args);
42                     }
43                 });
44         
45         chain.doFilter(_request, response);//放行
46         request.getRequestDispatcher("index.jsp").forward(request, response);
47     }
48 
49     public void destroy() {
50         
51     }
52 
53 
54 }

2、在web.xml中配置好過濾器的映射關系

1 <?xml version="1.0" encoding="UTF-8"?>
 2 <web-app version="2.5" 
 3     xmlns="http://java.sun.com/xml/ns/javaee" 
 4     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 5     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
 6     http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
 7     <!------------------------Filter映射配置部分------------------------------->
 8     <filter>
 9         <filter-name>LoginFilter</filter-name>
10         <filter-class>fnz.filter.webFilter</filter-class>
11     </filter>
12     <filter-mapping>
13         <filter-name>LoginFilter</filter-name>
14         <url-pattern>/*</url-pattern>
15     </filter-mapping>
16     <!------------------------Filter映射配置部分------------------------------->
17   <display-name></display-name>
18   <servlet>
19     <description>This is the description of my J2EE component</description>
20     <display-name>This is the display name of my J2EE component</display-name>
21     <servlet-name>LoginServlet</servlet-name>
22     <servlet-class>fnz.servlet.LoginServlet</servlet-class>
23   </servlet>
24 
25   <servlet-mapping>
26     <servlet-name>LoginServlet</servlet-name>
27     <url-pattern>/LoginServlet</url-pattern>
28   </servlet-mapping>    
29   <welcome-file-list>
30     <welcome-file>index.jsp</welcome-file>
31   </welcome-file-list>
32 </web-app>

3、最後編寫一個servlet（LoginServlet.java）及前台頁面（index.jsp），用于測試Filter

LoginServlet.java

1 package fnz.servlet;
 2 
 3 import java.io.IOException;
 4 import java.io.PrintWriter;
 5 
 6 import javax.servlet.ServletException;
 7 import javax.servlet.http.HttpServlet;
 8 import javax.servlet.http.HttpServletRequest;
 9 import javax.servlet.http.HttpServletResponse;
10 
11 public class LoginServlet extends HttpServlet {
12     
13     public void doGet(HttpServletRequest request, HttpServletResponse response)
14             throws ServletException, IOException {
15         
16         System.out.println(request.getParameter("name"));
17     }
18     
19     public void doPost(HttpServletRequest request, HttpServletResponse response)
20             throws ServletException, IOException {
21         this.doGet(request, response);
22     }
23 }

index.jsp

1 <%@ page language="java" import="java.util.*" pageEncoding="utf-8"%>
 2 
 3 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 4 <html>
 5   <head>
 6     <title>My JSP 'index.jsp' starting page</title>
 7   </head>
 8   <body>
 9     <form action="${pageContext.request.contextPath}/LoginServlet" method="post">
10         <input type="text" name="name"/>
11         <input type="submit" value="POST送出"/>
12     </form>
13     <form action="${pageContext.request.contextPath}/LoginServlet" method="get">
14         <input type="text" name="name"/>
15         <input type="submit" value="GET送出"/>
16     </form>
17   </body>
18 </html>

此案例目錄結構：

end

servlet過濾器

Filter簡介

Filter是如何實作攔截的？

Filter開發分為二個步驟：

Filter鍊

Filter的生命周期

FilterConfig接口

Filter的部署

filter執行個體-統一全站字元編碼的過濾器

繼續閱讀

Servlet過濾器（Filter）

Servlet JSP 二重修煉：Filter過濾器前言過濾器案例代碼解釋Filter的設計後記

[Servlet&amp;JSP] 過濾器的使用過濾器的概念過濾器的實作

《Java EE 7精粹》—— 2.2 Servlet過濾器

Servlet3.0過濾器

Servlet---過濾器簡介web.xml 配置過濾器多個過濾器過濾器類别

Servlet（四）——Servlet過濾器和監聽器

Servlet過濾器和監聽器過濾器監聽器監聽器應用場景

Servlet之過濾器和監聽器_2

Servlet--Servlet進階API、過濾器、監聽器