Servlet过滤器原理分析

Servlet过滤器是J2EE Web应用程序级的Java代码组件，是一种类似于Servlet，由窗口管理的对象，它能够以声明的方式插入到HTTP请求响应的过程中。它们拦截和响 应，以便查看、提取或以某各方式操作正在客户机和服务器之间交换的数据。它是通常封装了一些功能的类，实现了对Web应用程序中的预处理和后期逻辑。

　　过滤器提供一种面向对象的模块化机制，用以将公共任务封装到可插入的组件中。这些组件通过Web部署描述符 (web.xml)配置文件恶声明，可以方便地添加和删除过滤器，无需改动任何应用程序代码或JSP页面，并由Servlet窗口进行动态调用。通过在请 求/响应链中使用过滤器，可以对应用程序 （而不是以任何方式替代）的Servlet或JSP页面提供的核心处理进行补充，而不会破坏Servlet或JSP页面的功能。由于是纯Java实现，所 以Servlet过滤器是跨平台的模块化和可重用性，使得它们很容易地被部署到任何相容的J2EE环境中。

1.原理

　　1.1　过滤器工作原理

　　　　　　　　　　　

　　当客户端发出Web资源的请求时，Web服务器根据应用程序配置文件设置的过滤规则进行检查，客户请求满足 过滤规则，则对客户请求/响应进行拦截，对请求头和请求数据进行检查或改动，并依次通过过滤器链，最后把请求/响应交给请求的Web资源处理。请求信息在 过滤器链中可以被修改，也可以根据条件让请求不发往资源处理器，并直接向客户发回一个响应。当资源处理器完成了对资源的处理后，响应信息将逐级逆向返回。 同样在这个过程中，用户可以修改响应信息，从而完成一定的任务。如图1所示：在Servlet2.4规范中，对2.3规范进行了扩展，使得Servlet 过滤器可以应用在客户机和Servlet之间。Servlet和Servlet或JSP页面之间，以及各个JSP页面之间。

　　1.2　Servlet过滤器API

　　Servlet过滤器API包含了3个接口，它们都在javax.servlet包中，分别是Filter接口，FilterChain接口和FilterConfig接口.

　　1.2.1　public Interface Filter

　　所有的过滤器都必须实现Filter接口。该接口定义了init(),doFilter(),destory()三个方法：

(1)　public void init (FilterConfig filterConfig) throws ServletException

　　当开始使用servlet过滤器服务时，Web窗口调用此方法一次，为服务过滤器;然后在需要使用过滤器的时候调用doFilter()，传送给此方法的FilterConfig对象，包含servlet过滤器的初始化参数。

(2)　public void doFilter(ServletRequest request  request,ServletResponse  response,FilterChain  chain )throws java.io.IOException,ServletException

　　每个过滤器都接受当前的请求和响应，而FilterChain包含的过滤器则仍然必须被处理。 doFilter方法中，过滤器可以对请求和响应做它想做和一切，通过调用他们的方法收集数据，或者给对象添加新的行为。过滤器通过传送到此方法的 FilterChain参数，调用chain.doFilter()将控制权传送给下一个过滤器。当这个调用返回后，过滤器可以在它的doFilter方 法的最后对响应做些其他的工作。如果过滤器想要终止请求的处理或得到对响应的完全控制，则可以不调用下一个过滤器，而将其重定向到其它一些页面。当链中的 最后一个过滤器调用chain.doFilter()方法时，将运行最初请求的Servlet。

(3)　public void destory()

　　一旦doFilter()方法里的所有线程退出或已超时，容器调用此方法。服务器调用destory()以指出过滤器已结束服务，用于释放过滤器占用的资源。

　　1.2.2　public interface FilterChain

　　方法public void doFilter(ServletRequest request,ServletResponse response,FilterChain chain)throws java.io.IOException,ServletException 是由Servlet容器提供给开发者的，用于对资源请求过滤链的依次调用，通过FilterCain调用过滤链中的下一个过滤器，如果是最后一个过滤器， 则下一个就调用目标资源。

　　1.2.3　public interface FilterConfig

　　FilterConfig接口检索过滤器名、初始化参数以及活动的Servlet上下文。该接口提供了以下4个方法：

　　(1) public java.lang.String getFilterName()返回web.xml部署文件中定义的该过滤器的名称。

　　(2) public ServletContext getServletContext()返回调用者所处的servlet上下文。

　　(3) public java.lang.String getInitParameter(java.lang.String name)返回过滤器初始化参数值的字符串形式，当参数不存在时，返回null,name初始化参数名。

　　(4) public java.util.Enumeration getInitParameterNames()以Enumeration形式返回过滤器所有初始化参数值，如果没有初始化参数，返回为空。

　　1.3 过滤器相关接口工作流程

　　从编程的角度看，过滤器类将实现Filter接口，然后使用这个过滤器类中的FilterChain和 FilterConfig接口。该过滤器类的一个引用将传递给FilterChain对象，以允许过滤器把控制权传递给链中的下一个资源。 FilterConfig 对象将由容器提供给过滤器，以允许访问该过滤器的初始化数据。详细流程如图2所示。

                           

　　1.4 过滤器配置

　　过滤器通过Web应用程序中的配置描述符web.xml文件中的XML标签来声明，包括两个部分：第一部分 是过滤器定义，由<filter>元素表示，主要包括<filter-name>和<filter-class>两 个必需的子元素和<icon>、<init-param>、<display- name>.<description>这4个可选的子元素。<filter-name>了元素定义了一个过滤器的名字 <filter-class>指定了由容器载入的实际类。<init-param>子元素为过滤器实例提供初始化参数。另一部分 是对过滤器规则的配置，由<filter-mapping>元素表示，主要由<filter- name>,<servlet-name>和<url-pattern>子元素组成。        <servlet-name>将过滤器映射到一个或多个Serlvet<url-pattern>将过滤器映射到一个或多个任意 特征的URL的JSP页面

2  应用实例

　　从上面分析可知，实现Servlet过滤器，需要两步：第一步开发过滤器，设计一个实现Filter接口的类;第二步通过web.xml配置过滤器，实现过滤器和Servlet、jsp页面之间的映射。

　　以下设计一个简单的IP地址过滤器，根据用户的IP地址进行对网站的访问控制。

　　(1) 过滤器类的设计 ipfilter.java

　　package ipf;

        import javax..servlet.*;

　　import  java.io.IOException;

　　public class ipfilter implements Filter　　//实现Filter接口

　　{　protected FilterConfig config;

　　　　protected String rejectedIP;

　　　　public void init(FilterConfig filterConfig)throws ServletException

　　　　{　this.config=filterConfig;　　//从Web服务器获取过滤器配置对象

　　　　　rejectedIP=config.getInitParameter("RejectedIP");　　//从配置中取得过滤ＩＰ

　　　　　if(rejectedIP==null) {rejectedIP=""}

　　　　}

　　　　public void doFilter(ServletRequest request,ServletResponse response,FilterChain )

                       throwsIOException

　　　　{RequestDispatcher dispatcher=request.getRequestDispatcher("rejectedError.jsp"); 

                 String remoteIP=request.getRemoteAddr();　　　//获取客户请求IP

　　　　　int i=remoteIP.lastIndexOf(".");

　　　　　int r=rejectedIP.lastIndexOf(".");

　　　　　String reIPscope= rejectedIP.substring(0,r);　　//过滤ＩＰ 段                                                                        　　　　                    if (reIPscope.equals(remoteIP.substring(0,i)))
                    { dispatcher.forward(request, response);　　　//重定向到rejectedError.jsp 页面
                       return; 　　 //阻塞, 直接返Web回客户端 }
                    else { chain.doFilter(request, response);　　　// 调用过滤链上的下一个过滤器   

                     }

　　}

        public void destroy(){}　　//过滤器功能完成后，由Web服务器调用执行，回收

        }//过滤器资源

　　注意：chain.doFilter()语句以前的代码用于对客户请求的处理，以后的代码用于对响应进行处理。

　　(2) 配置过滤器

　　　在应用程序WEB-INF目录下的web.xml描述符文件中添加以下代码：　　 <filter>                                                                                                                                                                                         　<filter-name>ipfilter</filter-name>//过滤器名称 

<filter-class>ipf.ipfilter</filter-class>//实现过滤器类

<init-param>

<param-name>RejectedIP</parame-name>

//过滤器初始化参数名RejectedIP

<param-value>192.168.12.*</param-value>

//参数RejectedIP的值

</init-param>

</filter>

<filter-mapping>//过滤器映射

<filter-name>ipfilter</filter-name>

<url-pattern>/*</url-pattern>

//映射到Web应用根目录下所有jsp文件

</filter-mapping>

通过以上设计与配置，就禁止了IP地址处在192.168.12网段的用户对网站的访问

3　结束语

　　Servlet过滤器功能强大，应用广泛，除支持Servlet和jsp页面的基本功能，比如日志记录、性 能、安全、会话处理、XSLT转换等外，在J2EE应用程序中使用Java Servlet过滤器转换其输出，以便兼容任何类型客户端也表现出了很好的前景。Servlet过滤器能够侦测到来自使用WAP协议无线应用协议的移动客 户端的呼叫，并且将答复内容转换成WML (无线标记语言)格式。Servlet过滤器也能检测到来自iMode无线客户的呼叫，并将其转变成cHTML(紧凑HTML)格式等等。因而，深刻理解 Servlet过滤器的工作机制熟练掌握编程技术，在实际的开发过程中，可以不断地发现新的用途，增强组件的可重用性，提高Web应用程序的可维护性。

 

本文来自优快云博客，转载请标明出处： http://blog.youkuaiyun.com/machy123/archive/2007/11/23/1899871.aspx