Servlet过滤器Filter和监听器

原文地址：http://blog.csdn.net/jiangwei0910410003/article/details/23372847

首先来看一下Servlet的过滤器内容:

一、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过滤器的特点： *************************************************************************************** A．Servlet过滤器可以检查和修改ServletRequest和ServletResponse对象 B．Servlet过滤器可以被指定和特定的URL关联，只有当客户请求访问该URL时，才会触发过滤器 C．Servlet过滤器可以被串联在一起，形成管道效应，协同修改请求和响应对象 *************************************************************************************** 三、Servlet过滤器的作用： *************************************************************************************** A．查询请求并作出相应的行动。 B．阻塞请求-响应对，使其不能进一步传递。 C．修改请求的头部和数据。用户可以提供自定义的请求。 D．修改响应的头部和数据。用户可以通过提供定制的响应版本实现。 E．与外部资源进行交互。 *************************************************************************************** 四、Servlet过滤器的适用场合： *************************************************************************************** A．认证过滤 B．登录和审核过滤 C．图像转换过滤  D．数据压缩过滤  E．加密过滤  F．令牌过滤  G．资源访问触发事件过滤  H．XSL/T过滤  I．Mime-type过滤 *************************************************************************************** 五、Servlet过滤器接口的构成： *************************************************************************************** 所有的Servlet过滤器类都必须实现javax.servlet.Filter接口。这个接口含有3个过滤器类必须实现的方法： A.init(FilterConfig)： 这是Servlet过滤器的初始化方法，Servlet容器创建Servlet过滤器实例后将调用这个方法。在这个方法中可以读取web.xml文件中Servlet过滤器的初始化参数 B.doFilter(ServletRequest,ServletResponse,FilterChain)： 这个方法完成实际的过滤操作，当客户请求访问于过滤器关联的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain参数用于访问后续过滤器 C.destroy()： Servlet容器在销毁过滤器实例前调用该方法，这个方法中可以释放Servlet过滤器占用的资源 *************************************************************************************** 六、Servlet过滤器的创建步骤： *************************************************************************************** A．实现javax.servlet.Filter接口 B．实现init方法，读取过滤器的初始化函数 C．实现doFilter方法，完成对请求或过滤的响应 D．调用FilterChain接口对象的doFilter方法，向后续的过滤器传递请求或响应 E．销毁过滤器 *************************************************************************************** 七、Servlet过滤器对请求的过滤： *************************************************************************************** A．Servlet容器创建一个过滤器实例 B．过滤器实例调用init方法，读取过滤器的初始化参数 C．过滤器实例调用doFilter方法，根据初始化参数的值判断该请求是否合法 D．如果该请求不合法则阻塞该请求 E．如果该请求合法则调用chain.doFilter方法将该请求向后续传递 *************************************************************************************** 八、Servlet过滤器对响应的过滤： *************************************************************************************** A．过滤器截获客户端的请求 B．重新封装ServletResponse，在封装后的ServletResponse中提供用户自定义的输出流 C．将请求向后续传递 D．Web组件产生响应 E．从封装后的ServletResponse中获取用户自定义的输出流 F．将响应内容通过用户自定义的输出流写入到缓冲流中 G．在缓冲流中修改响应的内容后清空缓冲流，输出响应内容 *************************************************************************************** 九、Servlet过滤器的发布： *************************************************************************************** A．发布Servlet过滤器时，必须在web.xml文件中加入<filter>元素和<filter-mapping>元素。 B．<filter>元素用来定义一个过滤器： 属性                   含义 filter-name    指定过滤器的名字 filter-class    指定过滤器的类名 init-param    为过滤器实例提供初始化参数，可以有多个 C．<filter-mapping>元素用于将过滤器和URL关联： 属性                     含义 filter-name    指定过滤器的名字 url-pattern    指定和过滤器关联的URL，为”/*”表示所有URL *************************************************************************************** 十一、Servlet过滤器使用的注意事项 *************************************************************************************** A．由于Filter、FilterConfig、FilterChain都是位于javax.servlet包下，并非HTTP包所特有的，所以其中所用到的请求、响应对象ServletRequest、ServletResponse在使用前都必须先转换成HttpServletRequest、HttpServletResponse再进行下一步操作。 B．在web.xml中配置Servlet和Servlet过滤器，应该先声明过滤器元素，再声明Servlet元素 C．如果要在Servlet中观察过滤器生成的日志，应该确保在server.xml的localhost对应的<host>元素中配置如下<logger>元素： <Logger className = “org.apache.catalina.logger.FileLogger” directory = “logs”prefix = “localhost_log.”suffix=”.txt” timestamp = “true”/>

***************************************************************************************

十二、一个实例

首先来看一下web.xml的配置：

[html]  view plain  copy <!-- 请求url日志记录过滤器 -->         <filter>             <filter-name>logfilter</filter-name>             <filter-class>com.weijia.filterservlet.LogFilter</filter-class>         </filter>         <filter-mapping>             <filter-name>logfilter</filter-name>             <url-pattern>/*</url-pattern>         </filter-mapping>          <!-- 编码过滤器 -->         <filter>             <filter-name>setCharacterEncoding</filter-name>             <filter-class>com.weijia.filterservlet.EncodingFilter</filter-class>             <init-param>                 <param-name>encoding</param-name>                 <param-value>utf-8</param-value>             </init-param>         </filter>         <filter-mapping>             <filter-name>setCharacterEncoding</filter-name>             <url-pattern>/*</url-pattern>         </filter-mapping>     然后看一下编码过滤器：

[java]  view plain  copy package com.weijia.filterservlet;      import java.io.IOException;   import java.util.Enumeration;   import java.util.HashMap;      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 EncodingFilter implements Filter {         private String encoding;         private HashMap<String,String> params = new HashMap<String,String>();         // 项目结束时就已经进行销毁         public void destroy() {             System.out.println("end do the encoding filter!");             params=null;             encoding=null;         }         public void doFilter(ServletRequest req, ServletResponse resp,FilterChain chain) throws IOException, ServletException {             System.out.println("before encoding " + encoding + " filter！");             req.setCharacterEncoding(encoding);             chain.doFilter(req, resp);                   System.out.println("after encoding " + encoding + " filter！");             System.err.println("----------------------------------------");         }               // 项目启动时就已经进行读取         public void init(FilterConfig config) throws ServletException {             System.out.println("begin do the encoding filter!");             encoding = config.getInitParameter("encoding");             for (Enumeration<?> e = config.getInitParameterNames(); e.hasMoreElements();) {                 String name = (String) e.nextElement();                 String value = config.getInitParameter(name);                 params.put(name, value);             }         }      }     日志过滤器：

[java]  view plain  copy package com.weijia.filterservlet;      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;   import javax.servlet.http.HttpServletRequest;      public class LogFilter implements Filter {                public FilterConfig config;               public void destroy() {             this.config = null;             System.out.println("end do the logging filter!");       }               public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {             System.out.println("before the log filter!");             // 将请求转换成HttpServletRequest 请求             HttpServletRequest hreq = (HttpServletRequest) req;             // 记录日志             System.out.println("Log Filter已经截获到用户的请求的地址:"+hreq.getServletPath() );             try {                 // Filter 只是链式处理，请求依然转发到目的地址。                 chain.doFilter(req, res);             } catch (Exception e) {                 e.printStackTrace();             }             System.out.println("after the log filter!");         }               public void init(FilterConfig config) throws ServletException {             System.out.println("begin do the log filter!");             this.config = config;         }            }     测试Servlet:

[java]  view plain  copy package com.weijia.filterservlet;      import java.io.IOException;      import javax.servlet.ServletException;   import javax.servlet.http.HttpServlet;   import javax.servlet.http.HttpServletRequest;   import javax.servlet.http.HttpServletResponse;      public class FilterServlet extends HttpServlet {          private static final long serialVersionUID = 1L;          public void doGet(HttpServletRequest request, HttpServletResponse response)               throws ServletException, IOException {           response.setDateHeader("expires", -1);       }          public void doPost(HttpServletRequest request, HttpServletResponse response)               throws ServletException, IOException {       }      }  

访问FilterServlet

运行结果：

before the log filter! Log Filter已经截获到用户的请求的地址:/FilterServlet before encoding utf-8 filter！ after encoding utf-8 filter！ ---------------------------------------- after the log filter!

我们从运行结果可以看到这个过滤器的调用关系：

类似于C++中的构造函数和析构函数的调用顺序，

这里我们在web.xml中注册的是先注册日志过滤器的，然后再注册

当我们重新部署应用的时候发现：

会先销毁上次的过滤器，然后再重新注册一下

下面在来看一下Servlet的监听器

Servlet监听器用于监听一些重要事件的发生，监听器对象可以在事情发生前、发生后可以做一些必要的处理。下面将介绍几种常用的监听器，以及它们都适合运用于那些环境。 

分类及介绍： 1．  ServletContextListener：用于监听WEB 应用启动和销毁的事件，监听器类需要实现javax.servlet.ServletContextListener 接口。 

Java代码   public class QuartzListener implements ServletContextListener {          private Logger logger = LoggerFactory.getLogger(QuartzListener.class);          public void contextInitialized(ServletContextEvent sce) {          }          /**       *在服务器停止运行的时候停止所有的定时任务       */       @SuppressWarnings("unchecked")       public void contextDestroyed(ServletContextEvent arg0) {           try {               Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();               List<JobExecutionContext> jobList = scheduler.getCurrentlyExecutingJobs();               for (JobExecutionContext jobContext : jobList) {                   Job job = jobContext.getJobInstance();                   if (job instanceof InterruptableJob) {                       ((InterruptableJob) job).interrupt();                   }               }               scheduler.shutdown();           } catch (SchedulerException e) {               logger.error("shut down scheduler happened error", e);           }       }   }  

 

  2．  ServletContextAttributeListener：用于监听WEB应用属性改变的事件，包括：增加属性、删除属性、修改属性，监听器类需要实现javax.servlet.ServletContextAttributeListener接口。  3．  HttpSessionListener：用于监听Session对象的创建和销毁，监听器类需要实现javax.servlet.http.HttpSessionListener接口或者javax.servlet.http.HttpSessionActivationListener接口，或者两个都实现。

Java代码   /**   *    * 会话监听器   * <p />   *   */   public class SessionListener implements HttpSessionListener {          @Override       public void sessionCreated(HttpSessionEvent arg0) {          }          @Override       public void sessionDestroyed(HttpSessionEvent event) {           HttpSession session = event.getSession();           User user = (BrsSession) session.getAttribute("currUser");           if (user != null) {               //TODO something           }       }      }  

  4．  HttpSessionActivationListener：用于监听Session对象的钝化/活化事件，监听器类需要实现javax.servlet.http.HttpSessionListener接口或者javax.servlet.http.HttpSessionActivationListener接口，或者两个都实现。  5．  HttpSessionAttributeListener：用于监听Session对象属性的改变事件，监听器类需要实现javax.servlet.http.HttpSessionAttributeListener接口。  部署：         监听器的部署在web.xml文件中配置，在配置文件中，它的位置应该在过滤器的后面Servlet的前面

 

web.xml配置文件：

 

Java代码   <!-- Quartz监听器 -->   <listener>       <listener-class>           com.flyer.lisenter.QuartzListener       </listener-class>   </listener>