Filter基本原理和使用

 

一、Filter简介

  Filter也称之为过滤器,它是Servlet技术中最激动人心的技术,WEB开发人员通过Filter技术,对web服务器管理的所有web资源:例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截,从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
  Servlet API中提供了一个Filter接口,开发web应用时,如果编写的Java类实现了这个接口,则把这个java类称之为过滤器Filter。通过Filter技术,开发人员可以实现用户在访问某个目标资源之前,对访问的请求和响应进行拦截,如下所示:

  Filter基本原理和使用

二、Filter是如何实现拦截的?

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

  1. 调用目标资源之前,让一段代码执行。
  2. 是否调用目标资源(即是否让用户访问web资源)。
  3. 调用目标资源之后,让一段代码执行。

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

三、Filter开发入门

3.1、Filter开发步骤

  Filter开发分为二个步骤:

  1. 编写java类实现Filter接口,并实现其doFilter方法。
  2. 在 web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册,并设置它所能拦截的资源。

  过滤器范例:

1 package me.gacl.web.filter;
 2 
 3 import java.io.IOException;
 4 
 5 import javax.servlet.Filter;
 6 import javax.servlet.FilterChain;
 7 import javax.servlet.FilterConfig;
 8 import javax.servlet.ServletException;
 9 import javax.servlet.ServletRequest;
10 import javax.servlet.ServletResponse;
11 
12 /**
13 * @ClassName: FilterDemo01
14 * @Description:filter的三种典型应用:
15 *                     1、可以在filter中根据条件决定是否调用chain.doFilter(request, response)方法,
16 *                        即是否让目标资源执行
17 *                     2、在让目标资源执行之前,可以对request\response作预处理,再让目标资源执行
18 *                     3、在目标资源执行之后,可以捕获目标资源的执行结果,从而实现一些特殊的功能
19 * @author: 孤傲苍狼
20 * @date: 2014-8-31 下午10:09:24
21 */ 
22 public class FilterDemo01 implements Filter {
23 
24     @Override
25     public void init(FilterConfig filterConfig) throws ServletException {
26         System.out.println("----过滤器初始化----");
27     }
28 
29     @Override
30     public void doFilter(ServletRequest request, ServletResponse response,
31             FilterChain chain) throws IOException, ServletException {
32         
33         //对request和response进行一些预处理
34         request.setCharacterEncoding("UTF-8");
35         response.setCharacterEncoding("UTF-8");
36         response.setContentType("text/html;charset=UTF-8");
37         
38         System.out.println("FilterDemo01执行前!!!");
39         chain.doFilter(request, response);  //让目标资源执行,放行
40         System.out.println("FilterDemo01执行后!!!");
41     }
42 
43     @Override
44     public void destroy() {
45         System.out.println("----过滤器销毁----");
46     }
47 }

  在web. xml中配置过滤器:

1 <?xml version="1.0" encoding="UTF-8"?>
 2 <web-app version="3.0" 
 3     xmlns="http://java.sun.com/xml/ns/javaee" 
 4     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 5     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
 6     http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
 7   <display-name></display-name>    
 8   <welcome-file-list>
 9     <welcome-file>index.jsp</welcome-file>
10   </welcome-file-list>
11   
12   <!--配置过滤器-->
13   <filter>
14       <filter-name>FilterDemo01</filter-name>
15       <filter-class>me.gacl.web.filter.FilterDemo01</filter-class>
16   </filter>
17   
18   <!--映射过滤器-->
19   <filter-mapping>
20       <filter-name>FilterDemo01</filter-name>
21       <!--/*表示拦截所有的请求 -->
22       <url-pattern>/*</url-pattern>
23   </filter-mapping>
24   
25 </web-app>

3.2、Filter链

  在一个web应用中,可以开发编写多个Filter,这些Filter组合起来称之为一个Filter链。
  web服务器根据Filter在web.xml文件中的注册顺序,决定先调用哪个Filter,当第一个Filter的doFilter方法被调用时,web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中,开发人员如果调用了FilterChain对象的doFilter方法,则web服务器会检查FilterChain对象中是否还有filter,如果有,则调用第2个filter,如果没有,则调用目标资源。

四、Filter的生命周期

4.1、Filter的创建

  Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时,web 服务器将创建Filter 的实例对象,并调用其init方法,完成对象的初始化功能,从而为后续的用户请求作好拦截的准备工作,filter对象只会创建一次,init方法也只会执行一次。通过init方法的参数,可获得代表当前filter配置信息的FilterConfig对象。

4.2、Filter的销毁

  Web容器调用destroy方法销毁Filter。destroy方法在Filter的生命周期中仅执行一次。在destroy方法中,可以释放过滤器使用的资源。

4.3、FilterConfig接口

  用户在配置filter时,可以使用<init-param>为filter配置一些初始化参数,当web容器实例化Filter对象,调用其init方法时,会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时,通过filterConfig对象的方法,就可获得:
  String getFilterName():得到filter的名称。
  String getInitParameter(String name): 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.
  Enumeration getInitParameterNames():返回过滤器的所有初始化参数的名字的枚举集合。
  public ServletContext getServletContext():返回Servlet上下文对象的引用。
范例:利用FilterConfig得到filter配置信息

 1 package me.gacl.web.filter;
 2 
 3 import java.io.IOException;
 4 import java.util.Enumeration;
 5 import javax.servlet.Filter;
 6 import javax.servlet.FilterChain;
 7 import javax.servlet.FilterConfig;
 8 import javax.servlet.ServletException;
 9 import javax.servlet.ServletRequest;
10 import javax.servlet.ServletResponse;
11 
12 public class FilterDemo02 implements Filter {
13 
14     /* 过滤器初始化
15      * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
16      */
17     @Override
18     public void init(FilterConfig filterConfig) throws ServletException {
19         System.out.println("----过滤器初始化----");
20         /**
21          *  <filter>
22                   <filter-name>FilterDemo02</filter-name>
23                   <filter-class>me.gacl.web.filter.FilterDemo02</filter-class>
24                   <!--配置FilterDemo02过滤器的初始化参数-->
25                   <init-param>
26                       <description>配置FilterDemo02过滤器的初始化参数</description>
27                       <param-name>name</param-name>
28                       <param-value>gacl</param-value>
29                   </init-param>
30                   <init-param>
31                       <description>配置FilterDemo02过滤器的初始化参数</description>
32                       <param-name>like</param-name>
33                       <param-value>java</param-value>
34                   </init-param>
35             </filter>
36             
37              <filter-mapping>
38                   <filter-name>FilterDemo02</filter-name>
39                   <!--“/*”表示拦截所有的请求 -->
40                   <url-pattern>/*</url-pattern>
41              </filter-mapping>
42          */
43         //得到过滤器的名字
44         String filterName = filterConfig.getFilterName();
45         //得到在web.xml文件中配置的初始化参数
46         String initParam1 = filterConfig.getInitParameter("name");
47         String initParam2 = filterConfig.getInitParameter("like");
48         //返回过滤器的所有初始化参数的名字的枚举集合。
49         Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();
50         
51         System.out.println(filterName);
52         System.out.println(initParam1);
53         System.out.println(initParam2);
54         while (initParameterNames.hasMoreElements()) {
55             String paramName = (String) initParameterNames.nextElement();
56             System.out.println(paramName);
57         }
58     }
59 
60     @Override
61     public void doFilter(ServletRequest request, ServletResponse response,
62             FilterChain chain) throws IOException, ServletException {
63         System.out.println("FilterDemo02执行前!!!");
64         chain.doFilter(request, response);  //让目标资源执行,放行
65         System.out.println("FilterDemo02执行后!!!");
66     }
67 
68     @Override
69     public void destroy() {
70         System.out.println("----过滤器销毁----");
71     }
72 }

五、Filter的部署

  Filter的部署分为两个步骤:

  1、注册Filter

  2、映射Filter

5.1、注册Filter

  开发好Filter之后,需要在web.xml文件中进行注册,这样才能够被web服务器调用

  在web.xml文件中注册Filter范例:

1 <filter>
 2           <description>FilterDemo02过滤器</description>
 3           <filter-name>FilterDemo02</filter-name>
 4           <filter-class>me.gacl.web.filter.FilterDemo02</filter-class>
 5           <!--配置FilterDemo02过滤器的初始化参数-->
 6           <init-param>
 7               <description>配置FilterDemo02过滤器的初始化参数</description>
 8               <param-name>name</param-name>
 9               <param-value>gacl</param-value>
10           </init-param>
11           <init-param>
12               <description>配置FilterDemo02过滤器的初始化参数</description>
13               <param-name>like</param-name>
14               <param-value>java</param-value>
15           </init-param>
16 </filter>

  <description>用于添加描述信息,该元素的内容可为空,<description>可以不配置。

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

5.2、映射Filter

  在web.xml文件中注册了Filter之后,还要在web.xml文件中映射Filter

1  <!--映射过滤器-->
2   <filter-mapping>
3       <filter-name>FilterDemo02</filter-name>
4       <!--“/*”表示拦截所有的请求 -->
5       <url-pattern>/*</url-pattern>
6   </filter-mapping>

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

1 <filter-mapping>
2     <filter-name>testFilter</filter-name>
3    <url-pattern>/index.jsp</url-pattern>
4    <dispatcher>REQUEST</dispatcher>
5    <dispatcher>FORWARD</dispatcher>
6 </filter-mapping>

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

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

 Servlet过滤器可以对Servlet、JSP和HTML文件过滤。

  过滤器在实际开发中用得较多,是属于较重点的内容。

Servlet过滤器的概念

  Servlet过滤器是在Java Servlet规范2.3中定义的,它能够对Servlet容器的请求和响应对象进行检查、修改和拦截

  Servlet过滤器本身并不生成请求和响应对象,它只提供过滤作用。

  Servlet过滤器能够在Servlet被调用之前检查Request对象,修改Request Header和Request内容。

  在Servlet被调用之后检查Response对象,修改Response Header和Response内容。

  Servlet过滤器负责过滤的Web组件可以是Servlet、JSP或HTML文件。

Servlet过滤器的过滤过程

 Filter基本原理和使用

  过滤器的处理过程是一个链式的过程(FilterChain),即多个过滤器组成一个链,依次处理,最后交给过滤器之后的资源。

  其中链式过滤过程中也可以直接给出响应,即返回,而不是向后传递。

Filter接口

  所有的Servlet过滤器类都必须实现javax.servlet.Filter接口。

  这个接口含有3个过滤器类必须实现的方法:

  init(FilterConfig):这是Servlet过滤器的初始化方法,Servlet容器创建Servlet过滤器实例后将调用这个方法。

  在这个方法中可以读取web.xml文件中Servlet过滤器的初始化参数。

  比如web.xml中声明:

<filter>
        <filter-name>MyFilter1</filter-name>
        <filter-class>com.mengdd.filter.MyFilter1</filter-class>
        <init-param>
            <param-name>hello</param-name>
            <param-value>world</param-value>
        </init-param>
        <init-param>
            <param-name>name</param-name>
            <param-value>zhang</param-value>
        </init-param>
    </filter>

  在MyFilter1中:

 @Override
    public void init(FilterConfig filterConfig) throws ServletException {
 
        String paramValue1 = filterConfig.getInitParameter("hello");
        String paramValue2 = filterConfig.getInitParameter("name");
 
        ServletContext context = filterConfig.getServletContext();
    }

 

  注意:一旦一个过滤器启动失败,会导致整个Web应用启动失败。

 

  doFilter(ServletRequest, ServletResponse, FilterChain):这个方法完成实际的过滤操作。

  当客户请求访问与过滤器关联的URL时,Servlet容器将先调用过滤器的doFilter方法。

  FilterChain参数用于访问后续过滤器。

  在这个方法中调用chain.doFilter()方法,用于调用过滤器链中后续过滤器的doFilter()方法,假如没有后续过滤器,那么就把客户请求传给相应的Web组件。

  如果在这个方法中没有调用chain.doFilter()方法,客户请求不会到达所访问的Web组件。

 Filter基本原理和使用

  destroy():Servlet容器在销毁过滤器实例前调用该方法,在这个方法中可以释放Servlet过滤器占用的资源。

 

过滤器的例子

  比如用户登录之后,将信息传入session中,之后的其他页面入口可能需要检测是否存在session,以避免直接在地址栏输入地址访问页面而造成的session中没有用户信息的情况,如果在每个Servlet或JSP前面都要判断session中是否有相应属性,会有很多的代码重复,用过滤器可以很好地解决这个问题,如果不含登录信息,即转向到用户登录页面。

Filter基本原理和使用LoginFilter.java

  过滤器的配置和Servlet的配置相似,只不过URL配置的是要过滤请求的URL:

    <!-- filter一般配置在所有的Servlet上面 -->
    <filter>
        <filter-name>LoginFilter</filter-name>
        <filter-class>com.mengdd.filter.LoginFilter</filter-class>
    </filter>
 
    <filter-mapping>
        <filter-name>LoginFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    <!-- /*表示所有地址,即所有请求都会被送到这个过滤器 -->

  可以做很多练习例子,比如可以创建一个NoteFilter过滤器,它可以拒绝列在黑名单上的客户访问留言簿。(黑名单通过过滤器参数设置)。  

  也可以利用Filter进行一些关键词修改替换的工作。

串联过滤器的例子

  几点说明:

  1.串联过滤器的顺序是按照在web.xml中的配置顺序为准的。

 

   <filter>
        <filter-name>MyFilter1</filter-name>
        <filter-class>com.mengdd.filter.MyFilter1</filter-class>
        <init-param>
            <param-name>hello</param-name>
            <param-value>world</param-value>
        </init-param>
        <init-param>
            <param-name>name</param-name>
            <param-value>zhang</param-value>
        </init-param>
    </filter>
    <filter>
        <filter-name>MyFilter2</filter-name>
        <filter-class>com.mengdd.filter.MyFilter2</filter-class>
    </filter>
<filter-mapping> <filter-name>MyFilter1</filter-name> <url-pattern>/InfoServlet</url-pattern> </filter-mapping> <filter-mapping> <filter-name>MyFilter2</filter-name> <url-pattern>/InfoServlet</url-pattern> </filter-mapping>

 

  2.在Servlet过滤器中能访问application范围内的共享数据:先调用FilterConfig的getServletContext()方法获得ServletContext,再调用ServletContext的getAttribute()方法来获得application范围内的共享数据。

package com.mengdd.filter;
 
import java.io.IOException;
 
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
 
public class MyFilter1 implements Filter {
 
    @Override
    public void destroy() {
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
 
        System.out.println("MyFilter1 --> doFilter invoked!");
        System.out.println("MyFilter1 --> before chain.doFilter()");
        chain.doFilter(request, response);
        System.out.println("MyFilter1 --> after chain.doFilter()");
 
    }
 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
 
        String paramValue1 = filterConfig.getInitParameter("hello");
        String paramValue2 = filterConfig.getInitParameter("name");
 
        ServletContext context = filterConfig.getServletContext();
    }
 
}
package com.mengdd.filter;
 
import java.io.IOException;
 
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 MyFilter2 implements Filter{
 
    @Override
    public void destroy() { 
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        
        System.out.println("MyFilter2 --> doFilter invoked!");
        System.out.println("MyFilter2 --> before chain.doFilter()");
        chain.doFilter(request, response);
        System.out.println("MyFilter2 --> after chain.doFilter()"); 
    }
 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException { 
    }
 
}

 

Filter的基本原理

1.Filter?

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

2.工作原理

     当客户端发出Web资源的请求时,Web服务器根据应用程序配置文件设置的过滤规则进行检查,若客户请求满足过滤规则,则对客户请求/响应进行拦截,对请求头和请求数据进行检查或改动,并依次通过过滤器链,最后把请求/响应交给请求的Web资源处理。请求信息在过滤器链中可以被修改,也可以根据条件让请求不发往资源处理器,并直接向客户机发回一个响应。当资源处理器完成了对资源的处理后,响应信息将逐级逆向返回。同样在这个过程中,用户可以修改响应信息,从而完成一定的任务。

  两个过滤器同时过滤一个请求时,就要用到过滤链FilterChain.Filter的FilterChain中,服务器会按照web.xml中过滤器定义的先后循序组装成一条链,然后一次执行其中的doFilter()方法。执行的顺序就如下图所示,执行第一个过滤器的chain.doFilter()之前的代码,第二个过滤器的chain.doFilter()之前的代码,请求的资源,第二个过滤器的chain.doFilter()之后的代码,第一个过滤器的chain.doFilter()之后的代码,最后返回响应。

3.生命周期

        (1)实例化:Web容器在部署Web应用程序时对所有过滤器进行实例化。Web容器回调它的无参构造方法。

  (2)初始化:实例化完成之后,马上进行初始化工作。Web容器回调init()方法。

  (3)过滤:请求路径匹配过滤器的URL映射时。Web容器回调doFilter()方法--主要的工作方法。

  (4)销毁: Web容器在卸载Web应用程序前,Web容器回调destroy()方法。

4.Filter的主要方法

public void doFilter(ServletRequest request, ServletResponse response,
             FilterChain chain) throws IOException, ServletException{
}

 

Filter的最精华的部分是多了一个FilterChain对象,运行时调用FilterChain对象的doFilter(request, response)方法,来让请求和响应通过Filter。

5.Filter的配置

      (1)注册Filter

      (2)映射Filter

Filter的注册和映射与servlet的极其相似。如下:

注册Filter

<filter>
    <description>loginFilter过滤器</description>
    <filter-name>loginFilter</filter-name>
    <filter-class>com.javaweb.filter.LoginFilter</filter-class>
    <!--配置loginFilter过滤器的初始化参数-->
    <init-param>
        <param-name>name</param-name>
        <param-value>gacl</param-value>
    </init-param>
    <init-param>
        <param-name>like</param-name>
        <param-value>java</param-value>
    </init-param>
</filter></span>            

映射Filter

<filter-mapping>
    <filter-name>loginFilter</filter-name>
    <!--“/*”表示拦截所有的请求 -->
    <url-pattern>/*</url-pattern>
</filter-mapping>

 

上一篇:mysql 失效连接


下一篇:过滤器的使用