servlet 过滤器Filter

• Filter 简介

Filter 的基本功能是对 Servlet 容器调用 Servlet 的过程进行拦截，从而在 Servlet 进行响应处理的前后实现一些特殊的功能。
在 Servlet API 中定义了三个接口类来开供开发人员编写 Filter 程序：Filter, FilterChain, FilterConfig。
Filter 程序是一个实现了 Filter 接口的 Java 类，与 Servlet 程序相似，它由 Servlet 容器进行调用和执行。
Filter 程序需要在 web.xml 文件中进行注册和设置它所能拦截的资源：Filter 程序可以拦截 Jsp, Servlet, 静态图片文件和静态 html 文件
Filter 体系结构
Filter并不是从真正意义上对来自客户端的请求做出最终响应，而是进行部分的过滤工作，对请求数据进行检测或者安全性检查等工作。
Filter只有在客户端请求或者发出响应时才会自动进行调用，所以没有必要把这些Filter字节嵌入到整个Web应用系统的框架中，而是通过配置文件来设定。
当然，大部分情况下，并不需要给Web应用程序设置Filter，因为它不是必需的。如果需要设置Filter，除了可以设置单个Filter关联外，还可以设置Web应用程序与一个Filter链（多个单Filter相串联）相关联。
Filter的工作过程的相关步骤：
首先，通过部署描述器web.xml中对Filter的配置，特定Filter会捕捉到客户端的请求信息。
Filter调用内置方法来检查捕获到的请求对象，根据分析结果来决定是把该请求传递给下一个Filter（如果存在另一个Filter的话），还是中止该请求并向客户端发出一个响应。如果不存在Filter链，即仅仅为单个Filter，则上一个Filter直接把客户请求转发给Web服务器进行相应处理。
如果CSS应用程序关联了Filter，在客户端请求设法通过各个Filter被服务器处理时，最终的响应将以相反的顺序通过Filter链，最后发送给客户端。
Filter 基本工作原理
当在 web.xml 中注册了一个 Filter 来对某个 Servlet 程序进行拦截处理时，这个 Filter 就成了 Servlet 容器与该 Servlet 程序的通信线路上的一道关卡，该 Filter 可以对 Servlet 容器发送给 Servlet 程序的请求和 Servlet 程序回送给 Servlet 容器相应进行拦截，可以决定是否将请求继续传递给 Servlet 程序，以及对请求和相应信息是否进行修改。
在一个 web 应用程序中可以注册多个 Filter 程序，每个 Filter 程序都可以对一个或一组 Servlet 程序进行拦截。
若有多个 Filter 程序对某个 Servlet 程序的访问过程进行拦截，当针对该 Servlet 的访问请求到达时，web 容器将把多个 Filter 程序组合成一个 Filter 链(过滤器链)。Filter 链中各个 Filter 的拦截顺序与它们在应用程序的 web.xml 中映射的顺序一致。
Filter的实现步骤
实现一个Filter的三个步骤：
首先编写Filter的实现类程序。
其次，需要把实现的Filter添加到Web应用程序中，也就是说，需要在Web部署描述文件Web.xml中声明该Filter。
最后，将相关联的Filter与应用程序一起打包并部署。
Filter的主要作用及Filter API
Filter的主要作用
对用户请求进行统一认证
对用户的访问请求进行记录和审核
对用户发送的数据进行过滤和替换
转换图象格式
对响应内容进行压缩，减少传输量
对请求或响应进行加解密处理
触发资源访问事件
对XML的输出应用XSLT
Filter API
与Filter开发相关的接口与类都包含在javax.servlet和javax.servlet.http包中，主要有下面的接口和类。
javax.servlet.Filter接口
javax.servlet.FilterConfig接口
javax.servlet.FilterChain接口
javax.servlet.ServletRequestWrapper类
javax.servlet.ServletResponseWrapper类
javax.servlet.http.HttpServletRequestWrapper类
javax.servlet.http.HttpServletResponseWrapper类
Filter接口
开发Filter要实现javax.servlet.Filter接口，与开发Servlet要实现javax.servlet.Servlet接口类似。提供了一个公开的不带参数的构造方法。
在Filter接口中，定义了下面三个方法。
Filter接口的方法
public void init(FilterConfig filterConfig) throws ServletException
在 web 应用程序启动时，web 服务器将根据 web.xml 文件中的配置信息来创建每个注册的 Filter 实例对象，并将其保存在服务器的内存中。Web容器创建 Filter 对象实例后，将立即调用该 Filter 对象的 init 方法。Init 方法在 Filter 生命周期中仅执行一次，web 容器在调用 init 方法时，会传递一个包含 Filter 的配置和运行环境的 FilterConfig 对象(FilterConfig的用法和ServletConfig类似)。利用FilterConfig对象可以得到ServletContext对象，以及部署描述符中配置的过滤器的初始化参数。在这个方法中，可以抛出ServletException异常，通知容器该过滤器不能正常工作。
public void doFilter(ServletRequest request,ServletResponse response,FilterChain chain) throws IOException,ServletException
doFilter()方法类似于Servlet接口的service()方法。当客户端请求目标资源的时候，容器就会调用与这个目标资源相关联的过滤器的 doFilter()方法。其中参数 request, response 为 web 容器或 Filter 链的上一个 Filter 传递过来的请求和相应对象；参数 chain 为代表当前 Filter 链的对象，在特定的操作完成后，可以调用 FilterChain 对象的 chain.doFilter(request,response)方法将请求交付给 Filter 链中的下一个 Filter 或者目标 Servlet 程序去处理，也可以直接向客户端返回响应信息，或者利用RequestDispatcher的forward()和include()方法，以及 HttpServletResponse的sendRedirect()方法将请求转向到其他资源。这个方法的请求和响应参数的类型是 ServletRequest和ServletResponse，也就是说，过滤器的使用并不依赖于具体的协议。
public void destroy()
Web容器调用该方法指示Filter的生命周期结束。在这个方法中，可以释放Filter使用的资源。
与开发Servlet不同的是，Filter接口并没有相应的实现类可供继承，要开发过滤器，只能直接实现Filter接口。
FilterChain接口
代表当前 Filter 链的对象，由容器实现，容器将其实例作为参数传入过滤器对象的doFilter()方法中。过滤器对象使用FilterChain对象调用过滤器链中的下一个过滤器，如果该过滤器是链中最后一个过滤器，那么将调用目标资源。
FilterChain接口只有一个方法。
FilterChain接口的方法
public void doFilter(ServletRequest request,ServletResponse response) throws IOException
调用该方法将使过滤器链中的下一个过滤器被调用。如果是最后一个过滤器，会调用目标资源。
FilterConfig接口
javax.servlet.FilterConfig接口类似于javax.servlet.ServletConfig接口，用于在Filter初始化时向其传递信息。FilterConfig接口有容器实现，容器将其作为参数传入Filter对象的init()方法中。
在FilterConfig接口中，定义了四个方法。
FilterConfig接口的方法
public String getFilterName()
得到描述符中指定的过滤器的名字。
public String getInitParameter(String name)
返回在部署描述中指定的名字为name的初始化参数的值。如果不存在返回null。
public Enumeration getInitParameterNames()
返回过滤器的所有初始化参数的名字的枚举集合。
public ServletContext getSerlvetContext()
返回Servlet上下文对象的引用
Filter的部署
在实现一个Filter后，需要在部署描述符中对Filter进行配置，这是通过<filter>和<filter-mapping>元素来完成的。
<filter>元素
用于在Web应用程序中声明一个Filter。
在<filter>元素内，<description>、<display-name>、<icon>元素和以往serlvet的配置中的相同。
<filter-name>用于为Filter指定一个名称，该元素的内容不能为空。
<filter-class>元素用于指定Filter的完整的限定类名。
<init-param>元素用于为Filter指定初始化参数。它的子元素<param-name>指定参数的名称；<param-value>指定参数的值。
在Filter中，可以使用FilterConfig接口对象来访问初始化参数。
<filter-mapping>元素
用于指定Filter关联的url样式或者Servlet。
<filter-name>子元素的值必须是在<filter>元素中声明过的Filter的名字。
<url-pattern>元素指定Filter关联的URL样式。
<servlet-name>元素指定Filter对应的Servlet。
<url-pattern>元素和<servlet-name>元素可以选择一个；用户在访问<url-pattern>元素指定的URL上的资源或<servlet-name>元素指定的Servlet时，该Filter才会被容器调用。
 
-------------------------------
Filter演示示例
创建一个简单的Filter（TimeTrackFilter.java），跟踪满足一个客户机的Web请求大致所花的时间。
创建Filter
TimeTrackFilter.java
package cn.jbit.auction.servlet; 
import java.io.IOException; 
import java.util.Date; 
import javax.servlet.Filter;
 import javax.servlet.FilterChain;
 import javax.servlet.FilterConfig; 
import javax.servlet.ServletException; 
import javax.servlet.ServletRequest; 
import javax.servlet.ServletResponse; 
public class TimeTrackFilter implements Filter { 
   private FilterConfig filterConfig = null; 
  // 初始化Filter public void init(FilterConfig filterConfig) throws ServletException {
     // TODO Auto-generated method stub this.filterConfig = filterConfig;
   } 
   // 执行Filter功能 
   public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { 
     // TODO Auto-generated method stub Date startTime,endTime;
     double totalTime; startTime = new Date(); 
     // 把处理发送到下一个
     Filter chain.doFilter(request, response); 
    // 接下来的语句就是处理请求的过程：计算开始到结束的时间 
     endTime = new Date();
    totalTime = endTime.getTime()-startTime.getTime();
      totalTime = totalTime / 1000; 
     System.out.println("============================="); 
     System.out.println("Total elapsed time is: " + totalTime + " seconds."); 
     System.out.println("=============================");
     filterConfig.getServletContext(); 
 } 
  public void destroy() {
    // TODO Auto-generated method stub this.filterConfig = null;
   } 
}
配置Filter
实现了Filter后，还需要通过web.xml文件中的两上XML元素来声明该Filter。
配置web.xml
<filter> 
   <filter-name>requestTimer</filter-name> 
    <filter-class>cn.jbit.auction.servlet.TimeTrackFilter</filter-class>
 </filter>
 <filter-mapping>
     <filter-name>requestTimer</filter-name>
    <url-pattern>/*</url-pattern> 
</filter-mapping>