Servlet-编写过滤器

Servlet过滤器是Java类，出于以下目的，可以在Servlet编程中使用它们：

• 在客户端访问后端之前拦截客户端的请求。
• 在服务器将响应发送回客户端之前对其进行操作。

规格建议使用多种类型的过滤器：

• 身份验证过滤器。
• 数据压缩过滤器。
• 加密过滤器。
• 触发资源访问事件的过滤器。
• 图像转换过滤器。
• 日志和审核过滤器。
• MIME-TYPE链式过滤器。
• 标记化过滤器。
• 转换XML内容的XSL/T过滤器。

过滤器部署在部署描述符文件web.xml中，然后映射到应用程序的部署描述符中的servlet名称或URL模式。

Web容器启动Web应用程序时，它将为您在部署描述符中声明的每个过滤器创建一个实例。过滤器按照在部署描述符中声明的顺序执行。

Servlet过滤器方法

过滤器只是实现javax.servlet.Filter接口的Java类。javax.servlet.Filter接口定义了三种方法：

序号	方法与说明
1	public void doFilter (ServletRequest, ServletResponse, FilterChain)：每当客户端对链末端的资源请求时，容器每次request/response对通过链时，容器都会调用此方法。
2	public void init(FilterConfig filterConfig)：Web容器调用此方法，以向过滤器指示它已投入使用。
3	public void destroy()：Web容器调用此方法，以向过滤器指示该方法已停止使用。

Servlet过滤器-示例

以下是Servlet过滤器示例，该示例将显示客户端IP地址和当前日期时间。该示例将使您对Servlet过滤器有基本的了解，但是您可以使用相同的概念编写更复杂的过滤器应用程序：

// Import required java libraries
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;

// Implements Filter class
public class LogFilter implements Filter  {
   public void  init(FilterConfig config) throws ServletException {
      
      // Get init parameter 
      String testParam = config.getInitParameter("test-param"); 

      //Print the init parameter 
      System.out.println("Test Param: " + testParam); 
   }
   
   public void  doFilter(ServletRequest request, ServletResponse response,
      FilterChain chain) throws java.io.IOException, ServletException {

      // Get the IP address of client machine.
      String ipAddress = request.getRemoteAddr();

      // Log the IP address and current timestamp.
      System.out.println("IP "+ ipAddress + ", Time " + new Date().toString());

      // Pass request back down the filter chain
      chain.doFilter(request,response);
   }

   public void destroy( ) {
      /* Called before the Filter instance is removed from service by the web container*/
   }
}

以常规方式编译LogFilter.java并将类文件放入<Tomcat安装目录>/webapps/ROOT/WEB-INF/classes中。

Web.xml中的Servlet过滤器映射

定义过滤器，然后将其映射到URL或Servlet，与定义Servlet然后将其映射到URL模式几乎相同。在部署描述符文件web.xml中为过滤器标签创建以下条目：

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>LogFilter</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>

上面的过滤器将应用于所有servlet，因为我们在配置中指定了/*。如果只想对几个servlet应用过滤器，则可以指定一个特定的servlet路径。

现在尝试以通常的方式调用任何servlet，您将在Web服务器日志中看到生成的日志。您可以使用Log4J记录器在单独的文件上方记录日志。

使用多个过滤器

您的Web应用程序可能会针对特定目的定义几个不同的过滤器。考虑一下，您定义了两个过滤器AuthenFilter和LogFilter。其余过程将按上述说明进行，只是您需要按如下所述创建其他映射

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>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>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中过滤器映射元素的顺序确定了Web容器将过滤器应用于servlet的顺序。要颠倒过滤器的顺序，您只需要颠倒web.xml文件中的过滤器映射元素。

例如，上面的示例将首先应用LogFilter，然后将AuthenFilter应用于任何servlet，但是下面的示例将颠倒顺序：

<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>

上一篇：Servlet-Http状态代码
下一篇：Servlet-异常