Java对Servlet中的ServletContext（上下文），HttpSession，ServletRequest这三种对象提供了一些监听的接口，我们可以自定义监听器来实现这些接口，对这三种对象的一些事件进行监听。

本文要实现的监听器接口列表

一，对ServletContext的监听 ServletContextListener：Servlet上下文初始化和销毁时的监听器。 ServletContextAttributeListener：Servlet上下文参数变化时的监听器。 二，对HttpSession的监听 HttpSessionListener：HttpSession初始化和销毁时的监听器。 HttpSessionAttributeListener：HttpSession参数变化时的监听器。 三，对ServletRequest的监听 ServletRequestListener：ServletRequest初始化和销毁时的监听器。 ServletRequestAttributeListener：ServletRequest参数变化时的监听器。

对于这三种对象的监听器不止这些，每种监听器分别监听了这些对象发生的不同的事件。

自定义的监听器实例

1，ServletContextListener

代码：

  1. package com.web.system.listener;
  3. import java.util.ArrayList;
  4. import javax.servlet.ServletContextEvent;
  5. import javax.servlet.ServletContextListener;
  7. /**
  8. * 自定义的ServletContext监听器，可以在ServletContext加载时做一些初始化的工作
  9. */
  11. public class MyServletContextListener implements ServletContextListener {
  13.     @Override
  14.     public void contextDestroyed(ServletContextEvent arg0) {
  16.         System.out.println("MyServletContextListener Destoryed");
  18.     }
  19. /**
  20. * servletContext初始化
  21. */
  23.     @Override
  24.     public void contextInitialized(ServletContextEvent arg0) {
  26.         System.out.println("MyServletContextListener Init");
  28.         ArrayList<String> expressList=new ArrayList<String>();
  30.         expressList.add("顺丰速递");
  32.         expressList.add("如风达");
  34.         expressList.add("宅急送");
  36.         expressList.add("EMS");
  38.         arg0.getServletContext().setAttribute("expressList", expressList);
  40.     }
  42. }

在web.xml中的配置：

  1. <listener>
  2.             <listener-class>com.web.system.listener.MyServletContextListener</listener-class>
  3. </listener>

contextInitialized()方法就是在上下文加载时，监听器触发的方法，在这个方法中可以进行一些自定义的参数初始化的工作。
在上面的例子中我初始化了一个列表并放入上下文中，在应用层的代码中可以用以下方式获得这个列表：

  1.  //方法1
  2. ServletContext servletContext= request.getServletContext();
  3. ArrayList<String> expressList=(ArrayList<String>)servletContext.getAttribute("expressList");
  5. //方法2
  6. org.springframework.web.context.WebApplicationContext webApplicationContext = org.springframework.web.context.ContextLoader.getCurrentWebApplicationContext(); 
  7. ServletContext servletContext2 = webApplicationContext.getServletContext();
  8. ArrayList<String> expressList2=(ArrayList<String>)servletContext2.getAttribute("expressList");

第一个方法是需要有HttpRequest的场合才能使用的。

2，ServletContextAttributeListener

代码：

  1. package com.web.system.listener;
  3. import javax.servlet.ServletContextAttributeEvent;
  4. import javax.servlet.ServletContextAttributeListener;
  6. public class MyServletContextAttributeListener implements ServletContextAttributeListener{
  8.     @Override
  9.     public void attributeAdded(ServletContextAttributeEvent arg0) {
  11.         System.out.println("新增上下文参数，name:"+arg0.getName()+",value:"+arg0.getValue());
  13.     }
  15.     @Override
  16.     public void attributeRemoved(ServletContextAttributeEvent arg0) {
  18.         System.out.println("删除上下文参数，name:"+arg0.getName()+",value:"+arg0.getValue());
  20.     }
  22.     @Override
  23.     public void attributeReplaced(ServletContextAttributeEvent arg0) {
  25.         System.out.println("修改上下文参数，name:"+arg0.getName()+",value:"+arg0.getValue());
  27.     }
  29. }

在web.xml中的配置：

  1. <listener>
  3.   <listener-class>com.web.system.listener.MyServletContextAttributeListener</listener-class>
  5. </listener>

监听器中的三个方法分别监听了Servlet上下文的参数在新增、修改、删除时的事件，如果在应用层代码中修改上下文的参数：

  1. request.getSession().getServletContext().setAttribute("testContextAttribute", "abc");
  3. request.getSession().getServletContext().setAttribute("testContextAttribute", "def");
  5. request.getSession().getServletContext().removeAttribute("testContextAttribute");

监听器就可以监听到这些事件并输出：

新增上下文参数，name:testContextAttribute,value:abc 修改上下文参数，name:testContextAttribute,value:abc 删除上下文参数，name:testContextAttribute,value:def

3，HttpSessionListener

代码：

  1. package com.web.system.listener;
  3. import javax.servlet.http.HttpSessionEvent;
  4. import javax.servlet.http.HttpSessionListener;
  6. public class MyHttpSessionListener implements HttpSessionListener{
  8.     /**
  9.      * 新增session
  10.      */
  11.     @Override
  12.     public void sessionCreated(HttpSessionEvent arg0) {
  14.         System.out.println("MyHttpSessionListener Created,sessionId:"+arg0.getSession().getId());
  16.         Integer count=null;//session数量
  18.         Object sessionCount=arg0.getSession().getServletContext().getAttribute("sessionCount");
  20.         if(sessionCount==null){
  22.             count=0;
  24.         }else{
  26.             count=Integer.valueOf(sessionCount.toString());
  28.         }
  30.         count++;
  32.         System.out.println("当前session数："+count.toString());
  34.         arg0.getSession().getServletContext().setAttribute("sessionCount", count);
  36.         arg0.getSession().setAttribute("testName", "this is a name");
  38.     }
  40.     /**
  41.      * 销毁session
  42.      */
  44.     @Override
  45.     public void sessionDestroyed(HttpSessionEvent arg0) {
  47.         System.out.println("MyHttpSessionListener Destory,sessionId:"+arg0.getSession().getId());
  49.         Integer count=null;//session数量
  51.         Object sessionCount=arg0.getSession().getServletContext().getAttribute("sessionCount");
  53.         if(sessionCount==null){
  55.             count=0;
  57.         }else{
  59.             count=Integer.valueOf(sessionCount.toString());
  61.         }
  63.         count--;
  65.         System.out.println("当前session数："+count.toString());
  67.         arg0.getSession().getServletContext().setAttribute("sessionCount", count);
  69.     }
  71. }

在web.xml中的配置：

  1. <listener>
  3.   <listener-class>com.web.system.listener.MyHttpSessionListener</listener-class>
  5. </listener>

sessionCreated()方法就是在创建一个session时的监听，具体时间点是在session创建完成之后，所以可以在方法中对刚创建的session进行操作。
在这个例子中，代码维护了一个当前WebService中的session数，当session创建时加一，session销毁时减一，这个session数是放在上下文中的。同时还往当前session中添加了一个叫testName的参数。
这个例子中的session数和testName参数，可以在应用层中的以下代码获得：

  1. String sessionCount=request.getSession().getServletContext().getAttribute("sessionCount").toString();
  3. String testName=request.getSession().getAttribute("testName").toString();

4，HttpSessionAttributeListener

代码：

  1. 1. package com.web.system.listener;
  2. 2. 
  3. 3. import javax.servlet.http.HttpSessionAttributeListener;
  4. 4. import javax.servlet.http.HttpSessionBindingEvent;
  5. 5. 
  6. 6. public class MyHttpSessionAttributeListener implements HttpSessionAttributeListener{
  7. 7. 
  8. 8.          @Override
  9. 9.          public void attributeAdded(HttpSessionBindingEvent arg0) {
  10. 10.                    System.out.println(arg0.getSession().getId()+"新增session参数，name:"+arg0.getName()+",value:"+arg0.getValue());
  11. 11.                   
  12. 12.          }
  13. 13. 
  14. 14.          @Override
  15. 15.          public void attributeRemoved(HttpSessionBindingEvent arg0) {
  16. 16.                    System.out.println(arg0.getSession().getId()+"删除session参数，name:"+arg0.getName()+",value:"+arg0.getValue());
  17. 17.                   
  18. 18.          }
  19. 19. 
  20. 20.          @Override
  21. 21.          public void attributeReplaced(HttpSessionBindingEvent arg0) {
  22. 22.                    System.out.println(arg0.getSession().getId()+"修改session参数，name:"+arg0.getName()+",value:"+arg0.getValue());
  23. 23.                   
  24. 24.          }
  25. 25. 
  26. 26. }

在web.xml中的配置：

  1. 1. <listener>
  2. 2. 
  3. 3. <listener-class>com.web.system.listener.MyHttpSessionAttributeListener</listener-class>
  4. 4. 
  5. 5. </listener>

这个监听器提供了session参数在新增、修改、删除时的监听，如果在应用层代码中对session参数进行操作：

  1. 1. request.getSession().setAttribute("testContextAttribute", "abc");
  2. 2. 
  3. 3. request.getSession().setAttribute("testContextAttribute", "def");
  4. 4. 
  5. 5. request.getSession().removeAttribute("testContextAttribute");

监听器就会有如下输出：

26E7704D5B524C997B34E54021D46E44新增session参数，name:testContextAttribute,value:abc 26E7704D5B524C997B34E54021D46E44修改session参数，name:testContextAttribute,value:abc 26E7704D5B524C997B34E54021D46E44删除session参数，name:testContextAttribute,value:def

5，ServletRequestListener

代码：

  1. package com.web.system.listener;
  3. import javax.servlet.ServletRequestEvent;
  4. import javax.servlet.ServletRequestListener;
  5. import javax.servlet.http.HttpServletRequest;
  7. public class MyServletRequestListener implements ServletRequestListener{
  9.     @Override
  10.     public void requestDestroyed(ServletRequestEvent arg0) {
  12.         System.out.println("MyServletRequestListener Destory");
  14.     }
  16.     @Override
  17.     public void requestInitialized(ServletRequestEvent arg0) {
  19.         System.out.println("MyServletRequestListener Init");
  21.         Integer count=null;//请求数量
  23.         Object requestCount=arg0.getServletContext().getAttribute("requestCount");
  25.         if(requestCount==null){
  27.             count=0;
  29.         }else{
  31.             count=Integer.valueOf(requestCount.toString());
  33.         }
  35.         count++;
  37.         System.out.println("当前请求数："+count.toString());
  39.         arg0.getServletContext().setAttribute("requestCount", count);
  41.         //serverName
  42.         String serverName=arg0.getServletRequest().getServerName();
  44.         System.out.println("serverName:"+serverName);
  46.         //serverPort
  47.         int serverPort=arg0.getServletRequest().getServerPort();
  49.         System.out.println("serverPort:"+serverPort);
  51.         HttpServletRequest servletRequest=(HttpServletRequest)arg0.getServletRequest();
  53.         //requestURI
  54.         String requestURI=servletRequest.getRequestURI();
  56.         System.out.println("requestURI:"+requestURI);
  58.         //requestURL
  59.         String requestURL=servletRequest.getRequestURL().toString();
  61.         System.out.println("requestURL:"+requestURL);
  63.         //servletPath
  64.         String servletPath=servletRequest.getServletPath();
  66.         System.out.println("servletPath:"+servletPath);
  68.         //queryString
  69.         String queryString=servletRequest.getQueryString();
  71.         System.out.println("queryString:"+queryString);
  73.     }
  75. }

在xml中的配置：

  1. 1. <listener>
  2. 2. 
  3. 3.     <listener-class>com.web.system.listener.MyServletRequestListener</listener-class>
  4. 4. 
  5. 5. </listener>

requestInitialized()方法就是在一个HttpRequest创建完成时的监听，在该方法中可以对刚组建好的HttpRequest进行操作。
在上面的例子中，代码维护了一个WebService的request请求数并放到了上下文中。另外，方法中还输出了这个请求的ServerName，端口，URL，URI等信息。
如果用户提交了一个这样的请求：

http://localhost:9080/dangwebx-tst/tms/bms/billingQaReportController/datagrid.do?field=id,code,applyDate,filename,reportType,applyUser,outPath

那么监听器可能会有这样的输出：

MyServletRequestListener Init 当前请求数：19 serverName:localhost serverPort:9080 requestURI:/dangwebx-tst/tms/bms/billingQaReportController/datagrid.do requestURL:http://localhost:9080/dangwebx-tst/tms/bms/billingQaReportController/datagrid.do servletPath:/tms/bms/billingQaReportController/datagrid.do queryString:field=id,code,applyDate,filename,reportType,applyUser,outPath

6，ServletRequestAttributeListener

代码：

  1. 1. package com.web.system.listener;
  2. 2. 
  3. 3. import javax.servlet.ServletRequestAttributeEvent;
  4. 4. import javax.servlet.ServletRequestAttributeListener;
  5. 5. import javax.servlet.http.HttpServletRequest;
  6. 6. 
  7. 7. public class MyServletRequestAttributeListener implements ServletRequestAttributeListener{
  8. 8. 
  9. 9.          @Override
  10. 10.          public void attributeAdded(ServletRequestAttributeEvent arg0) {
  11. 11.                    HttpServletRequest servletRequest=(HttpServletRequest)arg0.getServletRequest();
  12. 12.                    System.out.println(servletRequest.getRequestURL().toString()+"新增request参数，name:"+arg0.getName()+",value:"+arg0.getValue());
  13. 13.                   
  14. 14.          }
  15. 15. 
  16. 16.          @Override
  17. 17.          public void attributeRemoved(ServletRequestAttributeEvent arg0) {
  18. 18.                    HttpServletRequest servletRequest=(HttpServletRequest)arg0.getServletRequest();
  19. 19.                    System.out.println(servletRequest.getRequestURL().toString()+"删除request参数，name:"+arg0.getName()+",value:"+arg0.getValue());
  20. 20.                   
  21. 21.          }
  22. 22. 
  23. 23.          @Override
  24. 24.          public void attributeReplaced(ServletRequestAttributeEvent arg0) {
  25. 25.                    HttpServletRequest servletRequest=(HttpServletRequest)arg0.getServletRequest();
  26. 26.                    System.out.println(servletRequest.getRequestURL().toString()+"修改request参数，name:"+arg0.getName()+",value:"+arg0.getValue());
  27. 27.                   
  28. 28.          }
  29. 29. 
  30. 30. }

在web.xml中的配置：

  1. 1. <listener>
  2. 2. 
  3. 3. <listener-class>com.web.system.listener.MyServletRequestAttributeListener</listener-class>
  4. 4. 
  5. 5. </listener>

这个监听中提供了对HttpRequest的参数在进行新增、修改、删除时的监听，如果在应用层代码中修改请求的参数：

  1. 1. request.setAttribute("testContextAttribute", "abc");
  2. 2. 
  3. 3. request.setAttribute("testContextAttribute", "def");
  4. 4. 
  5. 5. request.removeAttribute("testContextAttribute");

那么监听器可能会有这样的输出：

http://localhost:9080/dangwebx-tst/tms/bms/billingQaReportController/list.do新增request参数，name:testContextAttribute,value:abc http://localhost:9080/dangwebx-tst/tms/bms/billingQaReportController/list.do修改request参数，name:testContextAttribute,value:abc http://localhost:9080/dangwebx-tst/tms/bms/billingQaReportController/list.do删除request参数，name:testContextAttribute,value:def

在实际项目中，HttpRequestAttribute的监听器输出的内容可能比想象中的要多，因为不管是java还是项目中的其他组件都有可能对请求进行一些必要的装配，所以可能会出现一些这样的输出：

http://localhost:9080/dangwebx-tst/tms/bms/billingQaReportController/list.do新增request参数，name:javax.servlet.jsp.jstl.fmt.locale.request,value:zh_CN http://localhost:9080/dangwebx-tst/tms/bms/billingQaReportController/list.do新增request参数，name:javax.servlet.jsp.jstl.fmt.localizationContext.request,value:org.springframework.web.servlet.support.JstlUtils$SpringLocalizationContext@486f7c41 http://localhost:9080/dangwebx-tst/tms/bms/billingQaReportController/list.do删除request参数，name:__spring_security_scpf_applied,value:true http://localhost:9080/dangwebx-tst/tms/bms/billingQaReportController/list.do删除request参数，name:__dangwebx_context_persistence_filter,value:true http://localhost:9080/dangwebx-tst/tms/bms/billingQaReportController/list.do删除request参数，name:encodingFilter.FILTERED,value:true http://localhost:9080/dangwebx-tst/tms/bms/billingQaReportController/list.do删除request参数，name:openSessionInViewFilter.FILTERED,value:true


以上就是关于Servlet监听器的几个最简单的例子，另外，在SpringFramework中对这些监听器简直玩出了花，可以看看。