2011级-csdn-java-张侃— 过滤器

Filter简介

l      Filter也称之为过滤器，它是Servlet技术中最激动人心的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

l      Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截，如下所示：

Filter实现拦截的

l      Filter接口中有一个doFilter方法，当开发人员编写好Filter，并配置对哪个web资源进行拦截后，WEB服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：

•         调用目标资源之前，让一段代码执行

•         是否调用目标资源（即是否让用户访问web资源）。

•         web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。

•         调用目标资源之后，让一段代码执行

l      实验： Filter开发，见下页PPT中的开发流程

Filter开发入门

l      Filter开发分为二个步骤：

•        编写java类实现Filter接口，并实现其doFilter方法。

•        在 web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源。（动手实验）

l      Filter链

•        在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。

•        web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。

•        Filter链实验（查看filterChain API文档）

Servlet过滤器

l      需注意，Filter不是一个Servlet，它不能产生一个response，它能够在一个request到达Servlet之前预处理request，也可以在离开Servlet时处理response。

l      将多个过滤器组成过滤器链，每个过滤器在应用程序中执行一个任务，这样有助于确保它们的模块性和复用性。

l       当Web容器收到一个请求时，将发生多个操作：

•        Web容器对请求执行自己的预处理。在这一步中发生的事情由容器供应商负责。

•        Web容器检查有没有与所请求的URL匹配的URL模式的过滤器。

•        Web容器使用一个匹配的URL模式定位第一个过滤器。执行该过滤器的代码。

•        如果还有其他具有匹配URL模式的过滤器，则执行其代码，持续该过程，直到不再有其他具有匹配URL模式的过滤器。

•        如果没有发生错误，则将请求传递到目标Servlet。

•        该Servlet将应答传回其调用者。应用到请求上的最后一个过滤器将成功为应用到应答上的第一个过滤器。

•        最初应用到请求上的第一个过滤器将应答传递给Web容器。

•        public voiddoFilter(ServletRequest req,ServletResponse res,FilterChain chain);是Filter中最核心的方法。

•        参数FilterChain类型的对象是保存多个过滤器执行顺序的对象。

Filter的生命周期

l       init(FilterConfig filterConfig)throws ServletException：

•        和我们编写的Servlet程序一样，Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（注：filter对象只会创建一次，init方法也只会执行一次。示例 ）

•        开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。(filterConfig对象见下页PPT)

l       destroy()：

•        在Web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。

FilterConfig接口

l      用户在配置filter时，可以使用<init-param>为filter配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时，通过filterConfig对象的方法，就可获得：

•        String getFilterName()：得到filter的名称。

•        String getInitParameter(Stringname)： 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.

•        EnumerationgetInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。

•        public ServletContextgetServletContext()：返回Servlet上下文对象的引用。

l      实验：得到filter配置信息

Filter的部署—注册Filter

<filter>
           <filter-name>testFitler</filter-name>
           <filter-class>org.test.TestFiter</filter-class>
            <init-param>
               <param-name>word_file</param-name>   
               <param-value>/WEB-INF/word.txt</param-value>
            </init-param>
</filter>

l      <filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。

l      <filter-class>元素用于指定过滤器的完整的限定类名。

l      <init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。

Filter的部署—映射Filter

l      <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 对资源的多种调用方式进行拦截。

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

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

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

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

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

Filter高级开发

l      由于开发人员在filter中可以得到代表用户请求和响应的request、response对象，因此在编程中可以使用Decorator(装饰器)模式对request、response对象进行包装，再把包装对象传给目标资源，从而实现一些特殊需求。

Decorator设计模式

l      当某个对象的方法不适应业务需求时，通常有2种方式可以对方法进行增强：

•        编写子类，覆盖需增强的方法

•        使用Decorator设计模式对方法进行增强

l      疑问：在实际应用中遇到需增强对象的方法时，到底选用哪种方式呢？

•        没有具体的定式，不过有一种情况下，必须使用Decorator设计模式：即被增强的对象，开发人员只能得到它的对象，无法得到它的class文件。

•        比如request、response对象，开发人员之所以在servlet中能通过sun公司定义的HttpServletRequest\response接口去操作这些对象，是因为Tomcat服务器厂商编写了request、response接口的实现类。web服务器在调用servlet时，会用这些接口的实现类创建出对象，然后传递给servlet程序。

•        此种情况下，由于开发人员根本不知道服务器厂商编写的request、response接口的实现类是哪个？在程序中只能拿到服务器厂商提供的对象，因此就只能采用Decorator设计模式对这些对象进行增强。

l      Decorator设计模式的实现

•        1.首先看需要被增强对象继承了什么接口或父类，编写一个类也去继承这些接口或父类。

•        2.在类中定义一个变量，变量类型即需增强对象的类型。

•        3.在类中定义一个构造函数，接收需增强的对象。

•        4.覆盖需增强的方法，编写增强的代码。

request对象的增强

l      Servlet API 中提供了一个request对象的Decorator设计模式的默认实现类HttpServletRequestWrapper ， （HttpServletRequestWrapper 类实现了request 接口中的所有方法，但这些方法的内部实现都是仅仅调用了一下所包装的的 request 对象的对应方法）以避免用户在对request对象进行增强时需要实现request接口中的所有方法。