Servlet 编写过滤器

Servlet 过滤器可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息。

可以将一个或多个 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 接口定义了三个方法：

序号方法描述1public void init(FilterConfig filterConfig)web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。2public void doFilter (ServletRequest, ServletResponse, FilterChain)该方法完成实际的过滤操作，当客户端请求方法与过滤器设置匹配的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。3public void destroy()Servlet容器在销毁过滤器实例前调用该方法，在该方法中释放Servlet过滤器占用的资源。

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.baidu.com"); // 把请求传回过滤链 chain.doFilter(request,response); } public void destroy( ){ /* 在 Filter 实例被 Web 容器从服务移除之前调用 */ } }

Servlet 过滤器映射（Servlet Filter Mapping）

在Web.xml 中配置的Servlet映射和Servlet过滤器映射。

定义过滤器，然后映射到一个 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.jeiker.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>HelloWorldServlet</servlet-name> <!-- 所在的包 --> <servlet-class>com.jeiker.test.HelloWorldServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>HelloWorldServlet</servlet-name> <!-- 访问的网址 --> <url-pattern>/TomcatTest/HelloWorldServlet</url-pattern> </servlet-mapping> </web-app>

上述过滤器适用于所有的 Servlet，因为我们在配置中指定 /* 。如果您只想在少数的 Servlet 上应用过滤器，您可以指定一个特定的 Servlet 路径。

使用多个过滤器

Web 应用程序可以根据特定的目的定义若干个不同的过滤器。假设您定义了两个过滤器 AuthenFilter 和 LogFilter。您需要创建一个如下所述的不同的映射，其余的处理与上述所讲解的大致相同：

<filter> <filter-name>LogFilter</filter-name> <filter-class>com.jeiker.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.jeiker.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配置各节点

web.xml配置各节点说明：

<!-- 指定一个过滤器 --> <filter> <!-- 用于为过滤器指定一个名字，该元素的内容不能为空 --> <filter-name>LogFilter</filter-name> <!-- 元素用于指定过滤器的完整的类名 --> <filter-class>com.jeiker.test.LogFilter</filter-class> <!-- 用于为过滤器指定初始化参数 --> <init-param> <!-- 初始化参数的key --> <param-name>test-param</param-name> <!-- 初始化参数的value --> <param-value>Initialization Paramter</param-value> </init-param> </filter> <!-- 用于设置一个 Filter 所负责拦截的资源 --> <filter-mapping> <!-- 用于设置filter的注册过的名称。该值必须是在<filter>元素中声明过的过滤器的名字 --> <filter-name>LogFilter</filter-name> <!-- Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径 --> <url-pattern>/*</url-pattern> </filter-mapping> <!-- 指定一个Servlet --> <servlet> <!-- servlet的名称 --> <servlet-name>HelloWorldServlet</servlet-name> <!-- 所在的包 --> <servlet-class>com.jeiker.test.HelloWorldServlet</servlet-class> </servlet> <!-- 用于设置一个 Servlet 所负责拦截的资源 --> <servlet-mapping> <!-- 对应的servlet名称,与servlet一一对应 --> <servlet-name>HelloWorldServlet</servlet-name> <!-- 访问的网址 --> <url-pattern>/TomcatTest/HelloWorldServlet</url-pattern> </servlet-mapping>

<dispatcher>子元素可以设置的值及其意义：

REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。

INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该 过滤器将被调用。除此之外，该过滤器不会被调用。

FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。

ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。