Servlet Filter(过滤器)

1、Filter简介

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

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

这里写图片描述

2、Filter是如何实现拦截的

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

  • 调用目标资源以前,让一段代码执行。服务器

  • 是否调用目标资源(便是否让用户访问web资源)。app

  • 调用目标资源以后,让一段代码执行。 jsp

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

3、Filter开发入门

3.1 Filter开发步骤

  Filter开发分为两个步骤:spa

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

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

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,若是没有,则调用目标资源。

4、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上下文对象的引用。

5、Filter的部署

  Filter的部署分为两个步骤:

  • 注册Filter

  • 映射Filter

5.1 注册Filter

  开发好Filter以后,须要在web.xml文件中进行注册,这样才可以被web服务器调用。

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

<filter>
          <description>FilterDemo02过滤器</description>
          <filter-name>FilterDemo02</filter-name>
          <filter-class>me.gacl.web.filter.FilterDemo02</filter-class>
          <!--配置FilterDemo02过滤器的初始化参数-->
          <init-param>
              <description>配置FilterDemo02过滤器的初始化参数</description>
              <param-name>name</param-name>
              <param-value>gacl</param-value>
          </init-param>
          <init-param>
              <description>配置FilterDemo02过滤器的初始化参数</description>
              <param-name>like</param-name>
              <param-value>java</param-value>
          </init-param>
</filter>
  1. <description>用于添加描述信息,该元素的内容可为空,<description>能够不配置。

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

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

  4. <init-param>元素用于为过滤器指定初始化参数,它的子元素<param-name>指定参数的名字,<param-value>指定参数的值。在过滤器中,可使用FilterConfig接口对象来访问初始化参数。若是过滤器不须要指定初始化参数,那么<init-param>元素能够不配置。

5.2 映射Filter

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

<!--映射过滤器-->
   <filter-mapping>
      <filter-name>FilterDemo02</filter-name>
       <!--“/*”表示拦截全部的请求 -->
       <url-pattern>/*</url-pattern>
   </filter-mapping>
  1. <filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可经过两种方式来指定:Servlet 名称和资源访问的请求路径 

  2. <filter-name>子元素用于设置filter的注册名称。该值必须是在元素中声明过的过滤器的名字 

  3. <url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式) 

  4. <servlet-name>指定过滤器所拦截的Servlet名称。 

  5. <dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式,能够是REQUEST,INCLUDE,FORWARD和ERROR之一,默认REQUEST。用户能够设置多个<dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截。

<filter-mapping>
     <filter-name>testFilter</filter-name>
    <url-pattern>/index.jsp</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>FORWARD</dispatcher>
 </filter-mapping>

    <dispatcher> 子元素能够设置的值及其意义:

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

  • INCLUDE:若是目标资源是经过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此以外,该过滤器不会被调用。

  • FORWARD:若是目标资源是经过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此以外,该过滤器不会被调用。

  • ERROR:若是目标资源是经过声明式异常处理机制调用时,那么该过滤器将被调用。除此以外,过滤器不会被调用。

相关文章
相关标签/搜索