006_Java中的过滤器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 的基本工作原理

• 当在 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 接口

• 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异常，通知容器该过滤器不能正常工作。
• destroy()：在Web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源
• 与开发Servlet不同的是，Filter接口并没有相应的实现类可供继承，要开发过滤器，只能直接实现Filter接口。
• doFilter(ServletRequest request,ServletResponse response, FilterChain chain)throws java.io.IOException,ServletException：doFilter()方法类似于Servlet接口的service()方法。当客户端请求目标资源的时候，容器就会调用与这个目标资源相关联的过滤器的doFilter()方法。其中参数 request, response 为 web 容器或 Filter 链的上一个 Filter 传递过来的请求和相应对象；参数 chain 为代表当前 Filter 链的对象，在特定的操作完成后，可以在当前 Filter 对象的 doFilter 方法内部需要调用 FilterChain 对象的 chain.doFilter(request,response)方法才能把请求交付给 Filter 链中的下一个 Filter 或者目标 Servlet 程序去处理，也可以直接向客户端返回响应信息，或者利用RequestDispatcher的forward()和include()方法，以及HttpServletResponse的sendRedirect()方法将请求转向到其他资源。这个方法的请求和响应参数的类型是ServletRequest和ServletResponse，也就是说，过滤器的使用并不依赖于具体的协议。

FilterChain接口

• FilterChain接口：代表当前 Filter 链的对象。由容器实现，容器将其实例作为参数传入过滤器对象的doFilter()方法中。过滤器对象使用FilterChain对象调用过滤器链中的下一个过滤器（filter-mapping决定），如果该过滤器是链中最后一个过滤器，那么将调用目标资源。
• doFilter(ServletRequest request,ServletResponse response)throws java.io.IOException：调用该方法将使过滤器链中的下一个过滤器被调用。如果是最后一个过滤器，会调用目标资源。

FilterConfig 接口

• javax.servlet.FilterConfig接口：该接口类似于ServletConfig接口，由容器实现。Servlet规范将代表 ServletContext 对象和 Filter 的配置参数信息都封装在该对象中。Servlet 容器将其作为参数传入过滤器对象的init()方法中。
• String getFilterName()：得到描述符中指定的过滤器的名字。
• String getInitParameter(String name)： 返回在部署描述中指定的名字为name的初始化参数的值。如果不存在返回null.
• Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。
• public ServletContext getServletContext()：返回Servlet上下文对象的引用。

过滤器的部署

• 在实现一个过滤器后，需要在 web.xml 中进行注册和设置它所能拦截的资源。这可以通过< filter >和< filter-mapping >元素来完成的。

< filter > 元素（注册Filter）

• < filter >元素用于在Web应用程序中注册一个过滤器。

• 在< filter >元素内

  • < filter-name >用于为过滤器指定一个名字，该元素的内容不能为空。
  • < filter-class >元素用于指定过滤器的完整的限定类名。
  • < init-param >元素用于为过滤器指定初始化参数，它的子元素< param-name >指定参数的名字，< param-value >指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。

• Servlet容器对部署描述符中声明的每一个过滤器，只创建一个实例。与Servlet类似，容器将在同一个过滤器实例上运行多个线程来同时为多个请求服务，因此，开发过滤器时，也要注意线程安全的问题。

映射 Filter

• < filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径( url样式)

  • < filter-name>子元素用于设置filter的注册名称。该值必须是在元素中声明过的过滤器的名字
  • < url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)
  • < servlet-name>指定过滤器所拦截的Servlet名称。
  • < dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST. 可以设置多个 子元素用来指定 Filter 对资源的多种调用方式进行拦截。

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

  • REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
  • INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
  • FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
  • ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。
    
    
    

• 在同一个 web.xml 文件中可以为同一个 Filter 设置多个映射。若一个 Filter 链中多次出现了同一个 Filter 程序，这个 Filter 程序的拦截处理过程将被多次执行

测试代码

package com.mac.filter;import java.io.IOException;/* * Filter作用： *  Filter 的基本功能是对 Servlet 容器调用 Servlet 的过程进行拦截，从而在 Servlet 进行响应处理的前后实现一些特殊的功能（请求和响应都能拦截）。 *//* *  Filter步骤： *      1.编写Filter类。 *      2.配置web.xml文件中的Filter内容 *      3.拦截（顺序取决于web.xml中的filter-mapping），然后处理。 *//* *  调用方法的时机： *  1.init方法： *      web应用程序启动的时候就调用该方法，注册该Filter，完成对该Filter的初始化操作，Filter实例是单例的。 *  2.doFilter方法： *      每一次请求都会被调用 * 3.destory方法： *      在该web应用程序被销毁的时候调用 *//* * public interface javax.servlet Filter * 过滤器是执行过滤任务的对象，这些任务是针对对某一资源（servlet 或静态内容）的请求或来自某一资源的响应执行的，抑或同时针对这两者执行。 * Filter 用 doFilter 方法执行过滤。每个 Filter 都有对 FilterConfig 对象的访问权，可从该对象获得其初始化参数以及对它可以使用的  * ServletContext 的引用，以便为过滤任务加载所需的资源。 * Filter 是在 Web 应用程序的部署描述符中配置的。 * 已经标识用于此设计的示例是 *  1) 验证过滤器  *  2) 日志记录和审计过滤器  *  3) 图像转换过滤器  *  4) 数据压缩过滤器  *  5) 加密过滤器  *  6) 标记过滤器  *  7) 触发资源访问事件的过滤器  *  8) XSL/T 过滤器  *  9) Mime 类型链过滤器  */public class FilterServlet implements Filter {        /*        * public void   destroy()        * 由 Web 容器调用，指示将从服务中取出的过滤器。此方法仅在过滤器的 doFilter 方法中的所有线程都已退出之后调用一次，        * 或者在过了超时期之后调用。在调用此方法之后，Web 容器不会再对此过滤器实例调用 doFilter 方法。         * 此方法为过滤器提供了一个清除持有的所有资源（比如内存、文件句柄和线程）的机会，并确保任何持久状态都        * 与内存中该过滤器的当前状态保持同步。        */    @Override    public void destroy() {        System.out.println("destroy.....");    }    /*    * public void   doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException    * 每次由于对链末尾的某个资源的客户端请求而通过链传递请求/响应对时，容器都会调用 Filter 的 doFilter 方法。传入此方法的 FilterChain 允许    *  Filter 将请求和响应传递到链中的下一个实体。    *  此方法的典型实现遵循以下模式：-     *   1. 检查请求    *   2. 有选择地将带有自定义实现的请求对象包装到用于输入过滤的过滤器内容或头中     *   3. 有选择地将带有自定义实现的响应对象包装到用于输出过滤的过滤器内容或头中     *   4. a) 既可以使用 FilterChain 对象 (chain.doFilter()) 调用链中的下一个实体，     *   4. b) 也可以不将请求/响应对传递给过滤器链中的下一个实体，从而阻塞请求处理    *   5. 在调用过滤器链中的下一个实体之后直接设置响应上的头。    */    //请求，响应，Filter链    @Override    public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2)            throws IOException, ServletException {        System.out.println("doFilter......");        //拦截的逻辑代码应该写在这，每次请求都会调用这个方法        //这时候test.jsp的内容不会显示，因为被这里拦截了，但是没有过去        /*        * FilterChain：        * FilterChain 是 servlet 容器为开发人员提供的对象，它提供了对某一资源的已过滤请求调用链的视图。        * 过滤器使用 FilterChain 调用链中的下一个过滤器，如果调用的过滤器是链中的最后一个过滤器，        * 则调用链末尾的资源。        */        /*        * public void   doFilter(ServletRequest request, ServletResponse response) throws java.io.IOException, ServletException        * 导致链中的下一个过滤器被调用，如果调用的过滤器是链中的最后一个过滤器，则导致调用链末尾的资源。        * request           沿着链传递的请求。        * response      沿着链传递的响应。        */        //使用FilterChain对象（链），沿着链进行放行，这时候可以看到test.jsp的内容        arg2.doFilter(arg0, arg1);        //当去到的链完成之后，才会回来执行后面的代码        //...    }    /*    * public void   init(FilterConfig filterConfig) throws ServletException    * 由 Web 容器调用，指示将放入服务中的过滤器。servlet 容器只在实例化过滤器之后调用一次 init 方法。    * 在要求过滤器做任何过滤工作之前，init 方法必须成功完成。     * 如果 init 方法    *   1.抛出 ServletException     *   2.没有在 Web 容器定义的时间段内返回    * 则 Web 容器无法将过滤器放入服务中。    */    @Override    public void init(FilterConfig arg0) throws ServletException {        /*        * public interface javax.servlet    FilterConfig        * servlet 容器使用的过滤器配置对象，该对象在初始化期间将信息传递给过滤器。        */        System.out.println("init......");        //可以在web.xml中配置参数，在这里获得        String value = arg0.getInitParameter("name");        System.out.println(value);    }}

<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" metadata-complete="true" version="3.0">    <!-- 注册Filter -->    <filter>        <filter-name>helloServlet</filter-name>        <filter-class>com.mac.filter.FilterServlet</filter-class>               <init-param>            <param-name>name</param-name>            <param-value>value</param-value>        </init-param>    </filter>    <!-- 映射Filter，这个顺序决定了同一资源拦截的顺序（Filter链） -->    <filter-mapping>        <filter-name>helloServlet</filter-name>        <!-- 需要进行拦截的资源的路径（拦截根目录下的test.jsp），在访问该资源之前，Filter会进行拦截 -->        <url-pattern>/test.jsp</url-pattern>    </filter-mapping></web-app>

效果

init......value九月 30, 2017 5:24:20 下午 org.apache.catalina.startup.TldConfig execute信息: At least one JAR was scanned for TLDs yet contained no TLDs. Enable debug logging for this logger for a complete list of JARs that were scanned but no TLDs were found in them. Skipping unneeded JARs during scanning can improve startup time and JSP compilation time.九月 30, 2017 5:24:21 下午 org.apache.coyote.AbstractProtocol start信息: Starting ProtocolHandler ["http-bio-8080"]九月 30, 2017 5:24:21 下午 org.apache.coyote.AbstractProtocol start信息: Starting ProtocolHandler ["ajp-bio-8009"]九月 30, 2017 5:24:21 下午 org.apache.catalina.startup.Catalina start信息: Server startup in 1522 msdoFilter......

完整源码下载：

https://mp.weixin.qq.com/s/AarYRt8O8OrKGzZDBDwRjQ

欢迎加入Java讨论群：451826376