JSP 過濾器
JSP 和Servlet 中的過濾器都是Java 類。
過濾器可以動態地攔截請求和響應,以變換或使用包含在請求或響應中的信息。
可以將一個或多個過濾器附加到一個Servlet 或一組Servlet。 過濾器也可以附加到JavaServer Pages (JSP) 文件和HTML 頁面。
過濾器是可用於Servlet 編程的Java 類,可以實現以下目的:
- 在客戶端的請求訪問後端資源之前,攔截這些請求。
- 在服務器的響應發送回客戶端之前,處理這些響應。
根據規范建議的各種類型的過濾器:
- 身份驗證過濾器(Authentication Filters)。
- 數據壓縮過濾器(Data compression Filters)。
- 加密過濾器(Encryption Filters)。
- 觸發資源訪問事件過濾器。
- 圖像轉換過濾器(Image Conversion Filters)。
- 日誌記錄和審核過濾器(Logging and Auditing Filters)。
- MIME-TYPE 鏈過濾器(MIME-TYPE Chain Filters)。
- 標記化過濾器(Tokenizing Filters)。
- XSL/T 過濾器(XSL/T Filters),轉換XML 內容。
過濾器通過Web 部署描述符(web.xml)中的XML 標籤來聲明,然後映射到您的應用程序的部署描述符中的Servlet 名稱或URL 模式。
當Web 容器啟動Web 應用程序時,它會為您在部署描述符中聲明的每一個過濾器創建一個實例。
Filter的執行順序與在web.xml配置文件中的配置順序一致,一般把Filter配置在所有的Servlet之前。
Servlet 過濾器方法
過濾器是一個實現了javax.servlet.Filter 接口的Java 類。 javax.servlet.Filter 接口定義了三個方法:
序号 | 方法 & 描述 |
---|---|
1 | public void doFilter (ServletRequest, ServletResponse, FilterChain) 该方法完成实际的过滤操作,当客户端请求方法与过滤器设置匹配的URL时,Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。 |
2 | public void init(FilterConfig filterConfig) web 应用程序启动时,web 服务器将创建Filter 的实例对象,并调用其init方法,读取web.xml配置,完成对象的初始化功能,从而为后续的用户请求作好拦截的准备工作(filter对象只会创建一次,init方法也只会执行一次)。开发人员通过init方法的参数,可获得代表当前filter配置信息的FilterConfig对象。 |
3 | public void destroy() Servlet容器在销毁过滤器实例前调用该方法,在该方法中释放Servlet过滤器占用的资源。 |
FilterConfig 使用
Filter 的init 方法中提供了一個FilterConfig 對象。
如web.xml 文件配置如下:
<filter> <filter-name>LoginFilter</filter-name> <filter-class>com.w3big.test.LogFilter</filter-class> <init-param> <param-name>Site</param-name> <param-value>本教程</param-value> </init-param> </filter>
在init 方法使用FilterConfig 對象獲取參數:
public void init(FilterConfig config) throws ServletException { // 获取初始化参数 String site = config.getInitParameter("Site"); // 输出初始化参数 System.out.println("网站名称: " + site); }
JSP 過濾器實例
以下是Servlet 過濾器的實例,將輸出網站名稱和地址。 本實例讓您對Servlet 過濾器有基本的了解,您可以使用相同的概念編寫更複雜的過濾器應用程序:
//导入必需的 java 库 import javax.servlet.*; import java.util.*; //实现 Filter 类 public class LogFilter implements Filter { public void init(FilterConfig config) throws ServletException { // 获取初始化参数 String site = config.getInitParameter("Site"); // 输出初始化参数 System.out.println("网站名称: " + site); } public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException { // 输出站点名称 System.out.println("站点网址:http://www.w3big.com"); // 把请求传回过滤链 chain.doFilter(request,response); } public void destroy( ){ /* 在 Filter 实例被 Web 容器从服务移除之前调用 */ } }
DisplayHeader.java 文件代碼如下:
//导入必需的 java 库 import java.io.IOException; import java.io.PrintWriter; import java.util.Enumeration; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @WebServlet("/DisplayHeader") //扩展 HttpServlet 类 public class DisplayHeader extends HttpServlet { // 处理 GET 方法请求的方法 public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { // 设置响应内容类型 response.setContentType("text/html;charset=UTF-8"); PrintWriter out = response.getWriter(); String title = "HTTP Header 请求实例 - 本教程实例"; String docType = "<!DOCTYPE html> \n"; out.println(docType + "<html>\n" + "<head><meta charset=\"utf-8\"><title>" + title + "</title></head>\n"+ "<body bgcolor=\"#f0f0f0\">\n" + "<h1 align=\"center\">" + title + "</h1>\n" + "<table width=\"100%\" border=\"1\" align=\"center\">\n" + "<tr bgcolor=\"#949494\">\n" + "<th>Header 名称</th><th>Header 值</th>\n"+ "</tr>\n"); Enumeration headerNames = request.getHeaderNames(); while(headerNames.hasMoreElements()) { String paramName = (String)headerNames.nextElement(); out.print("<tr><td>" + paramName + "</td>\n"); String paramValue = request.getHeader(paramName); out.println("<td> " + paramValue + "</td></tr>\n"); } out.println("</table>\n</body></html>"); } // 处理 POST 方法请求的方法 public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } }
Web.xml 中的Servlet 過濾器映射(Servlet Filter Mapping)
定義過濾器,然後映射到一個URL 或Servlet,這與定義Servlet,然後映射到一個URL 模式方式大致相同。 在部署描述符文件web.xml中為filter標籤創建下面的條目:
<?xml version="1.0" encoding="UTF-8"?> <web-app> <filter> <filter-name>LogFilter</filter-name> <filter-class>com.w3big.test.LogFilter</filter-class> <init-param> <param-name>Site</param-name> <param-value>本教程</param-value> </init-param> </filter> <filter-mapping> <filter-name>LogFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <servlet> <!-- 类名 --> <servlet-name>DisplayHeader</servlet-name> <!-- 所在的包 --> <servlet-class>com.w3big.test.DisplayHeader</servlet-class> </servlet> <servlet-mapping> <servlet-name>DisplayHeader</servlet-name> <!-- 访问的网址 --> <url-pattern>/TomcatTest/DisplayHeader</url-pattern> </servlet-mapping> </web-app>
上述過濾器適用於所有的Servlet,因為我們在配置中指定/* 。 如果您只想在少數的Servlet 上應用過濾器,您可以指定一個特定的Servlet 路徑。
現在試著以常用的方式調用任何Servlet,您將會看到在Web 服務器中生成的日誌。 您也可以使用Log4J 記錄器來把上面的日誌記錄到一個單獨的文件中。
接下來我們訪問這個實例地址http://localhost:8080/TomcatTest/DisplayHeader ,然後在控制台看下輸出內容,如下所示:
使用多個過濾器
Web 應用程序可以根據特定的目的定義若干個不同的過濾器。 假設您定義了兩個過濾器AuthenFilter和LogFilter 。 您需要創建一個如下所述的不同的映射,其餘的處理與上述所講解的大致相同:
<filter> <filter-name>LogFilter</filter-name> <filter-class>com.w3big.test.LogFilter</filter-class> <init-param> <param-name>test-param</param-name> <param-value>Initialization Paramter</param-value> </init-param> </filter> <filter> <filter-name>AuthenFilter</filter-name> <filter-class>com.w3big.test.AuthenFilter</filter-class> <init-param> <param-name>test-param</param-name> <param-value>Initialization Paramter</param-value> </init-param> </filter> <filter-mapping> <filter-name>LogFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>AuthenFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
過濾器的應用順序
web.xml 中的filter-mapping 元素的順序決定了Web 容器應用過濾器到Servlet 的順序。 若要反轉過濾器的順序,您只需要在web.xml 文件中反轉filter-mapping 元素即可。
例如,上面的實例將先應用LogFilter,然後再應用AuthenFilter,但是下面的實例將顛倒這個順序:
<filter-mapping> <filter-name>AuthenFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>LogFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
web.xml配置各節點說明
-
<filter>
指定一個過濾器。-
<filter-name>
用於為過濾器指定一個名字,該元素的內容不能為空。 -
<filter-class>
元素用於指定過濾器的完整的限定類名。 -
<init-param>
元素用於為過濾器指定初始化參數,它的子元素<param-name>
指定參數的名字,<param-value>
指定參數的值。 - 在過濾器中,可以使用
FilterConfig
接口對象來訪問初始化參數。
-
-
<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
:如果目標資源是通過聲明式異常處理機制調用時,那麼該過濾器將被調用。 除此之外,過濾器不會被調用。
-