Servlet中的Filter怎么使用?

Posted benming

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Servlet中的Filter怎么使用?相关的知识,希望对你有一定的参考价值。

一、Filter简介

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

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

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

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

调用目标资源之前,让一段代码执行。

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

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

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

三、Filter开发入门

3.1Filter开发步骤

  Filter开发分为二个步骤:

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

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

  过滤器范例:

  package me.gacl.web.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;

 /**

 @ClassName: FilterDemo01

@Description:filter的三种典型应用:

1、可以在filter中根据条件决定是否调用chain.doFilter(request, response)方法,即是否让目标资源执行

2、在让目标资源执行之前,可以对request esponse作预处理,再让目标资源执行

3、在目标资源执行之后,可以捕获目标资源的执行结果,从而实现一些特殊的功能

 * @author: 孤傲苍狼

 * @date: 2014-8-31 下午10:09:24

 */

 public class FilterDemo01 implements Filter {

     @Override

     public void init(FilterConfig filterConfig) throws ServletException {

         System.out.println("----过滤器初始化----");

    }

     @Override

    public void doFilter(ServletRequest request, ServletResponse response,

             FilterChain chain) throws IOException, ServletException {         

         //requestresponse进行一些预处理

         request.setCharacterEncoding("UTF-8");

         response.setCharacterEncoding("UTF-8");

         response.setContentType("text/html;charset=UTF-8");        

         System.out.println("FilterDemo01执行前!!!");

         chain.doFilter(request, response);  //让目标资源执行,放行

         System.out.println("FilterDemo01执行后!!!");

     }

     @Override

     public void destroy() {

         System.out.println("----过滤器销毁----");

     }

 }

  在web. xml中配置过滤器:

 <?xml version="1.0" encoding="UTF-8"?>

  <web-app version="3.0"

      xmlns="http://java.sun.com/xml/ns/javaee"

      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

      xsi:schemaLocation="http://java.sun.com/xml/ns/javaee

     http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">

    <display-name></display-name>    

    <welcome-file-list>

      <welcome-file>index.jsp</welcome-file>

   </welcome-file-list>   

   <!--配置过滤器-->

   <filter>

       <filter-name>FilterDemo01</filter-name>

       <filter-class>me.gacl.web.filter.FilterDemo01</filter-class>

   </filter>   

   <!--映射过滤器-->

   <filter-mapping>

       <filter-name>FilterDemo01</filter-name>

       <!--/*”表示拦截所有的请求 -->

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

   </filter-mapping>

 </web-app>

3.2Filter

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

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

四、Filter的生命周期

4.1Filter的创建

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

4.2Filter的销毁

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

4.3FilterConfig接口

  用户在配置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配置信息

 package me.gacl.web.filter;

  import java.io.IOException;

  import java.util.Enumeration;

 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 FilterDemo02 implements Filter {

 

    /* 过滤器初始化

      * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)

     */

     @Override

     public void init(FilterConfig filterConfig) throws ServletException {

         System.out.println("----过滤器初始化----");

         /**

         *  <filter>

                   <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>

                       <filter-mapping>

                   <filter-name>FilterDemo02</filter-name>

                   <!--/*”表示拦截所有的请求 -->

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

              </filter-mapping>

          */

         //得到过滤器的名字

         String filterName = filterConfig.getFilterName();

         //得到在web.xml文件中配置的初始化参数

         String initParam1 = filterConfig.getInitParameter("name");

         String initParam2 = filterConfig.getInitParameter("like");

         //返回过滤器的所有初始化参数的名字的枚举集合。

         Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();         

         System.out.println(filterName);

         System.out.println(initParam1);

         System.out.println(initParam2);

         while (initParameterNames.hasMoreElements()) {

             String paramName = (String) initParameterNames.nextElement();

             System.out.println(paramName);

         }

     }

     @Override

     public void doFilter(ServletRequest request, ServletResponse response,

            FilterChain chain) throws IOException, ServletException {

        System.out.println("FilterDemo02执行前!!!");

         chain.doFilter(request, response);  //让目标资源执行,放行

         System.out.println("FilterDemo02执行后!!!");

     }

     @Override

     public void destroy() {

         System.out.println("----过滤器销毁----");

     }

 }

五、Filter的部署

  Filter的部署分为两个步骤:

  1、注册Filter

  2、映射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>

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

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

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

  <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>

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

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

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

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

  <dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式,可以是REQUEST,INCLUDE,FORWARDERROR之一,默认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容器将会调用过滤器。如果目标资源是通过RequestDispatcherinclude()forward()方法访问时,那么该过滤器就不会被调用。

INCLUDE:如果目标资源是通过RequestDispatcherinclude()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。

FORWARD:如果目标资源是通过RequestDispatcherforward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。

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

作用及用法:Servlet 过滤器可以动态地拦截请求和响应,以变换或使用包含在请求或响应中的信息。可以将一个或多个 Servlet 过滤器附加到一个 Servlet 或一组 ServletServlet 过滤器也可以附加到 JavaServer Pages (JSP) 文件和 HTML 页面。调用 Servlet 前调用所有附加的 Servlet 过滤器。

实现的功能(可用于Servlet编程的Java类):

a.在客户端的请求访问后端资源之前,拦截这些请求。

b. 在服务器的响应发送回客户端之前,处理这些响应。

过滤器的类型

 a.身份验证过滤器(Authentication Filters)。

 b.数据压缩过滤器(Data compression Filters)。

 c.加密过滤器(Encryption Filters)。

 d.触发资源访问事件过滤器。

 e.图像转换过滤器(Image Conversion Filters)。

 f.日志记录和审核过滤器(Logging and Auditing Filters)。

 g.MIME-TYPE 链过滤器(MIME-TYPE Chain Filters)。

 h.标记化过滤器(Tokenizing Filters)。

 i.XSL/T 过滤器(XSL/T Filters),转换 XML 内容。

主要方法:

public void doFilter (ServletRequest, ServletResponse, FilterChain)

//过滤操作,当客户端请求方法与过滤器设置匹配的URL时,Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。

public void init(FilterConfig filterConfig)

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

public void destroy()

//Servlet容器在销毁过滤器实例前调用该方法,在该方法中释放Servlet过滤器占用的资源。

过滤器的应用场景:

.执行目标资源之前做"预处理"工作,例如设置编码,这种通常都会放行,只是在目标资源执行之前做一些准备工作。(例如:几乎是所有的Servlet中都需要写request.setCharacteEncoding(),可以把它放入到一个Filter中。)这种过滤器没有拦截功能。

.通过条件判断是否放行,例如校验当前用户是否已经登录,或者用户IP是否已经被禁用。(有拦截操作) (粗粒度权限控制,会员有会员的权利、游客有游客的权利)

.在目标资源执行后,做一些后续的特殊处理工作。例如把目标资源输出的数据进行处理。

6.代码示例:

//导入必需的 java

import javax.servlet.*;

import javax.servlet.annotation.WebFilter;

import java.io.IOException;

@WebFilter("/*")

//实现 Filter

public class CharsetFilter implements Filter {

    @Override

    public void init(FilterConfig filterConfig) throws ServletException {

        //输出初始化参数

        System.out.println("CharsetFilter.init");

    }

    @Override

    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

        // 输出站点名称

        System.out.println("CharsetFilter.doFilter");

        //解决字符乱码问题

        servletRequest.setCharacterEncoding("utf-8");

        servletResponse.setCharacterEncoding("utf-8");

        // 把请求传回过滤链

        filterChain.doFilter(servletRequest,servletResponse);

    }

    @Override

    public void destroy() {

        /* Filter 实例被 Web 容器从服务移除之前调用 */

        System.out.println("CharsetFilter.destroy");

    }

}

7.多个过滤器的执行顺序:

Web应用程序可以根据特定的目的定义若干个不同的过滤器,那么就需要在web.xml中对多个过滤器进行多个配置。而在web.xml中使用来控制多个过滤器的执行顺序,即哪个过滤器的配置在web.xml中的顺序排在前面那这个过滤器就先执行。

代码示例:

web.xml

<filter>

   <filter-name>Frist</filter-name>

   <filter-class>com.test.Frist</filter-class>

   <init-param>

      <param-name>test-param</param-name>

      <param-value>Initialization Paramter</param-value>

   </init-param>

</filter>

<filter>

   <filter-name>Second</filter-name>

   <filter-class>com.test.Second</filter-class>

   <init-param>

      <param-name>test-param</param-name>

      <param-value>Initialization Paramter</param-value>

   </init-param>

</filter>

<filter-mapping>

   <filter-name>Frist</filter-name>

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

</filter-mapping>

<filter-mapping>

   <filter-name>Second</filter-name>

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

</filter-mapping>

/*先执行First,然后再执行Second*/

以上是关于Servlet中的Filter怎么使用?的主要内容,如果未能解决你的问题,请参考以下文章

Spring Boot参考教程Spring Boot配置Servlet,Filter,Listener,Interceptor

过滤器的使用

servlet容器(tomcat),springmvc,filter,interceptor等关系

Filter及FilterChain的使用详解

day22(过滤器Filter)

maven中的cannot be cast to javax.servlet.Filter怎么解决