zoukankan      html  css  js  c++  java

  • JavaWeb学习篇之----Servlet过滤器Filter和监听器

    JavaWeb学习篇之----Servlet过滤器Filter和监听器

    首先来看一下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 在CODE上查看代码片派生到我的代码片
    1. <!-- 请求url日志记录过滤器 -->    
    2.     <filter>    
    3.         <filter-name>logfilter</filter-name>    
    4.         <filter-class>com.weijia.filterservlet.LogFilter</filter-class>    
    5.     </filter>    
    6.     <filter-mapping>    
    7.         <filter-name>logfilter</filter-name>    
    8.         <url-pattern>/*</url-pattern>    
    9.     </filter-mapping>  
    10.       
    11. <!-- 编码过滤器 -->    
    12.     <filter>    
    13.         <filter-name>setCharacterEncoding</filter-name>    
    14.         <filter-class>com.weijia.filterservlet.EncodingFilter</filter-class>    
    15.         <init-param>    
    16.             <param-name>encoding</param-name>    
    17.             <param-value>utf-8</param-value>    
    18.         </init-param>    
    19.     </filter>    
    20.     <filter-mapping>    
    21.         <filter-name>setCharacterEncoding</filter-name>    
    22.         <url-pattern>/*</url-pattern>    
    23.     </filter-mapping>    


    然后看一下编码过滤器：

    [java] view plain copy 在CODE上查看代码片派生到我的代码片
    1. package com.weijia.filterservlet;  
    2.   
    3. import java.io.IOException;  
    4. import java.util.Enumeration;  
    5. import java.util.HashMap;  
    6.   
    7. import javax.servlet.Filter;  
    8. import javax.servlet.FilterChain;  
    9. import javax.servlet.FilterConfig;  
    10. import javax.servlet.ServletException;  
    11. import javax.servlet.ServletRequest;  
    12. import javax.servlet.ServletResponse;  
    13.   
    14. public class EncodingFilter implements Filter {    
    15.     private String encoding;    
    16.     private HashMap<String,String> params = new HashMap<String,String>();    
    17.     // 项目结束时就已经进行销毁    
    18.     public void destroy() {    
    19.         System.out.println("end do the encoding filter!");    
    20.         params=null;    
    21.         encoding=null;    
    22.     }    
    23.     public void doFilter(ServletRequest req, ServletResponse resp,FilterChain chain) throws IOException, ServletException {    
    24.         System.out.println("before encoding " + encoding + " filter！");    
    25.         req.setCharacterEncoding(encoding);    
    26.         chain.doFilter(req, resp);          
    27.         System.out.println("after encoding " + encoding + " filter！");    
    28.         System.err.println("----------------------------------------");    
    29.     }    
    30.      
    31.     // 项目启动时就已经进行读取    
    32.     public void init(FilterConfig config) throws ServletException {    
    33.         System.out.println("begin do the encoding filter!");    
    34.         encoding = config.getInitParameter("encoding");    
    35.         for (Enumeration<?> e = config.getInitParameterNames(); e.hasMoreElements();) {    
    36.             String name = (String) e.nextElement();    
    37.             String value = config.getInitParameter(name);    
    38.             params.put(name, value);    
    39.         }    
    40.     }    
    41.  }    


    日志过滤器：

    [java] view plain copy 在CODE上查看代码片派生到我的代码片
    1. package com.weijia.filterservlet;  
    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. import javax.servlet.http.HttpServletRequest;  
    12.   
    13. public class LogFilter implements Filter {    
    14.       
    15.     public FilterConfig config;    
    16.      
    17.     public void destroy() {    
    18.         this.config = null;    
    19.         System.out.println("end do the logging filter!");  
    20.     }    
    21.      
    22.     public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {    
    23.         System.out.println("before the log filter!");    
    24.         // 将请求转换成HttpServletRequest 请求    
    25.         HttpServletRequest hreq = (HttpServletRequest) req;    
    26.         // 记录日志    
    27.         System.out.println("Log Filter已经截获到用户的请求的地址:"+hreq.getServletPath() );    
    28.         try {    
    29.             // Filter 只是链式处理，请求依然转发到目的地址。    
    30.             chain.doFilter(req, res);    
    31.         } catch (Exception e) {    
    32.             e.printStackTrace();    
    33.         }    
    34.         System.out.println("after the log filter!");    
    35.     }    
    36.      
    37.     public void init(FilterConfig config) throws ServletException {    
    38.         System.out.println("begin do the log filter!");    
    39.         this.config = config;    
    40.     }    
    41.      
    42.  }    


    测试Servlet:

    [java] view plain copy 在CODE上查看代码片派生到我的代码片
    1. package com.weijia.filterservlet;  
    2.   
    3. import java.io.IOException;  
    4.   
    5. import javax.servlet.ServletException;  
    6. import javax.servlet.http.HttpServlet;  
    7. import javax.servlet.http.HttpServletRequest;  
    8. import javax.servlet.http.HttpServletResponse;  
    9.   
    10. public class FilterServlet extends HttpServlet {  
    11.   
    12.     private static final long serialVersionUID = 1L;  
    13.   
    14.     public void doGet(HttpServletRequest request, HttpServletResponse response)  
    15.             throws ServletException, IOException {  
    16.         response.setDateHeader("expires", -1);  
    17.     }  
    18.   
    19.     public void doPost(HttpServletRequest request, HttpServletResponse response)  
    20.             throws ServletException, IOException {  
    21.     }  
    22.   
    23. }  


    访问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代码  收藏代码
    1. public class QuartzListener implements ServletContextListener {  
    2.   
    3.     private Logger logger = LoggerFactory.getLogger(QuartzListener.class);  
    4.   
    5.     public void contextInitialized(ServletContextEvent sce) {  
    6.   
    7.     }  
    8.   
    9.     /** 
    10.      *在服务器停止运行的时候停止所有的定时任务 
    11.      */  
    12.     @SuppressWarnings("unchecked")  
    13.     public void contextDestroyed(ServletContextEvent arg0) {  
    14.         try {  
    15.             Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();  
    16.             List<JobExecutionContext> jobList = scheduler.getCurrentlyExecutingJobs();  
    17.             for (JobExecutionContext jobContext : jobList) {  
    18.                 Job job = jobContext.getJobInstance();  
    19.                 if (job instanceof InterruptableJob) {  
    20.                     ((InterruptableJob) job).interrupt();  
    21.                 }  
    22.             }  
    23.             scheduler.shutdown();  
    24.         } catch (SchedulerException e) {  
    25.             logger.error("shut down scheduler happened error", e);  
    26.         }  
    27.     }  
    28. }  

     

     
    2．  ServletContextAttributeListener：用于监听WEB应用属性改变的事件，包括：增加属性、删除属性、修改属性，监听器类需要实现javax.servlet.ServletContextAttributeListener接口。 

    3．  HttpSessionListener：用于监听Session对象的创建和销毁，监听器类需要实现 javax.servlet.http.HttpSessionListener接口或者 javax.servlet.http.HttpSessionActivationListener接口，或者两个都实现。

    Java代码  收藏代码
    1. /** 
    2.  *  
    3.  * 会话监听器 
    4.  * <p /> 
    5.  * 
    6.  */  
    7. public class SessionListener implements HttpSessionListener {  
    8.   
    9.     @Override  
    10.     public void sessionCreated(HttpSessionEvent arg0) {  
    11.   
    12.     }  
    13.   
    14.     @Override  
    15.     public void sessionDestroyed(HttpSessionEvent event) {  
    16.         HttpSession session = event.getSession();  
    17.         User user = (BrsSession) session.getAttribute("currUser");  
    18.         if (user != null) {  
    19.             //TODO something  
    20.         }  
    21.     }  
    22.   
    23. }  

     
    4．  HttpSessionActivationListener：用于监听Session对象的钝化/活化事件，监听器类需要实现 javax.servlet.http.HttpSessionListener接口或者 javax.servlet.http.HttpSessionActivationListener接口，或者两个都实现。 

    5．  HttpSessionAttributeListener：用于监听Session对象属性的改变事件，监听器类需要实现javax.servlet.http.HttpSessionAttributeListener接口。 

    部署： 
           监听器的部署在web.xml文件中配置，在配置文件中，它的位置应该在过滤器的后面Servlet的前面

     

    web.xml配置文件：

     

    Java代码  收藏代码
    1. <!-- Quartz监听器 -->  
    2. <listener>  
    3.     <listener-class>  
    4.         com.flyer.lisenter.QuartzListener  
    5.     </listener-class>  
    6. </listener>  
  • 相关阅读:
    解决Tomcat无法shutdown进程
    ConcurrentHashMap Put()操作示例代码
    Spring Data JPA
    JAVA CAS原理
    多线程
    多线程
    java 虚拟机--新生代与老年代GC
    TCP协议中的三次握手和四次挥手
    java中volatile关键字
    Java多线程
  • 原文地址：https://www.cnblogs.com/shsgl/p/5439591.html
Copyright © 2011-2022 走看看