可以将一个或多个 Servlet 过滤器附加到一个 Servlet 或一组 Servlet。Servlet 过滤器也可以附加到 JavaServer Pages (JSP) 文件和 HTML 页面。调用 Servlet 前调用所有附加的 Servlet 过滤器。
Servlet 过滤器是可用于 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 接口定义了三个方法:
该方法完成实际的过滤操作,当客户端要求方法与过滤器设置匹配的URL时,Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。
2public void init(FilterConfig filterConfig)web 运用程序启动时,web 做事器将创建Filter 的实例工具,并调用其init方法,读取web.xml配置,完成工具的初始化功能,从而为后续的用户要求作好拦截的准备事情(filter工具只会创建一次,init方法也只会实行一次)。开拓职员通过init方法的参数,可得到代表当前filter配置信息的FilterConfig工具。
3public void destroy()Servlet容器在销毁过滤器实例前调用该方法,在该方法中开释Servlet过滤器占用的资源。
FilterConfig 利用
Filter 的 init 方法中供应了一个 FilterConfig 工具。
如 web.xml 文件配置如下:
<filter> <filter-name>LogFilter</filter-name> <filter-class>com.runoob.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); }
Servlet 过滤器实例
以下是 Servlet 过滤器的实例,将输出网站名称和地址。本实例让您对 Servlet 过滤器有基本的理解,您可以利用相同的观点编写更繁芜的过滤器运用程序:
package com.runoob.test;//导入必需的 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.runoob.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.runoob.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.runoob.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 记录器来把上面的日志记录到一个单独的文件中。
利用多个过滤器
Web 运用程序可以根据特定的目的定义多少个不同的过滤器。假设您定义了两个过滤器 AuthenFilter 和 LogFilter。您须要创建一个如下所述的不同的映射,别的的处理与上述所讲解的大致相同:
<filter> <filter-name>LogFilter</filter-name> <filter-class>com.runoob.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.runoob.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
:如果目标资源是通过声明式非常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用。