ServletContextListener监听器使用

ServletContextListener监听器使用(附网站计数器例子)

在Servlet API中有一个ServletContextListener接口，它能够监听ServletContext对象的生命周期，实际上就是监听Web应用的生命周期。

当Servlet容器启动或终止Web应用时，会触发 ServletContextEvent事件，该事件由 ServletContextListener 来处理。在 ServletContextListener 接口中定义了处理ServletContextEvent事件的两个方法。

contextInitialized(ServletContextEvent sce)：当Servlet容器启动Web应用时调用该方法。在调用完该方法之后，容器再对Filter初始化，并且对那些在Web应用启动时就需要被初始化的Servlet进行初始化。

contextDestroyed(ServletContextEvent sce)：当Servlet容器终止Web应用时调用该方法。在调用该方法之前，容器会先销毁所有的Servlet和Filter过滤器。

下面通过一个例子来介绍ServletContextListener的用法。本章 4.4.1节的例程4-9的CounterServlet类只能统计当Web应用启动后，网页被客户端访问的次数。如果重新启动Web应用，计数器又会重新从1开始统计访问次数。在实际应用中，往往需要统计自Web应用被发布后网页被客户端访问的次数，这就要求当Web应用被终止时，计数器的数值被永久存储在一个文件中或者数据库中，等到Web应用重新启动时，先从文件或数据库中读取计数器的初始值，然后在此基础上继续计数。

向文件中写入或读取计数器的数值的功能可以由自定义的 MyServletContextListener类（参见例程4-11）来完成，它具有以下功能：

在 Web 应用启动时从文件中读取计数器的数值，并把表示计数器的 Counter对象存放到 Web 应用范围内。存放计数器的文件的路径为helloapp/count/count.txt。

在Web应用终止时把Web应用范围内的计数器的数值保存到count.txt文件中。

例程4-11 MyServletContextListener.java
Java代码

   1. public class MyServletContextListener implements ServletContextListener{ 
   2.  
   3. public void contextInitialized(ServletContextEvent sce){ 
   4.  
   5. System.out.println("helloapp application is Initialized."); 
   6.  
   7.     //获取ServletContext对象 
   8.  
   9. ServletContext context=sce.getServletContext(); 
  10.  
  11.     try{ 
  12.  
  13. //从文件中读取计数器的数值 
  14.  
  15. BufferedReader reader=new BufferedReader( 
  16.  
  17. new InputStreamReader(context.getResourceAsStream("/count/count.txt"))); 
  18.  
  19. int count=Integer.parseInt(reader.readLine()); 
  20.  
  21. reader.close(); 
  22.  
  23.  //创建计数器对象 
  24.  
  25. Counter counter=new Counter(count); 
  26.  
  27. //把计数器对象保存到Web应用范围 
  28.  
  29. context.setAttribute("counter",counter); 
  30.  
  31. }catch(IOException e){e.printStackTrace();} 
  32.  
  33. } 
  34.  
  35. public void contextDestroyed(ServletContextEvent sce){ 
  36.  
  37. System.out.println("helloapp application is Destroyed."); 
  38.  
  39.     //获取ServletContext对象 
  40.  
  41. ServletContext context=sce.getServletContext(); 
  42.  
  43.     //从Web应用范围获得计数器对象 
  44.  
  45. Counter counter=(Counter)context.getAttribute("counter"); 
  46.  
  47.     if(counter!=null){ 
  48.  
  49. try{ 
  50.  
  51. //把计数器的数值写到count.txt文件中 
  52.  
  53. String filepath=context.getRealPath("/count"); 
  54.  
  55. filepath=filepath+"/count.txt"; 
  56.  
  57. PrintWriter pw=new PrintWriter(filepath); 
  58.  
  59. pw.println(counter.getCount()); 
  60.  
  61. pw.close(); 
  62.  
  63. }catch(IOException e){e.printStackTrace();} 
  64.  
  65. } 
  66.  
  67. } 
  68.  
  69. } 

public class MyServletContextListener implements ServletContextListener{

public void contextInitialized(ServletContextEvent sce){

System.out.println("helloapp application is Initialized.");

    //获取ServletContext对象

ServletContext context=sce.getServletContext();

    try{

//从文件中读取计数器的数值

BufferedReader reader=new BufferedReader(

new InputStreamReader(context.getResourceAsStream("/count/count.txt")));

int count=Integer.parseInt(reader.readLine());

reader.close();

//创建计数器对象

Counter counter=new Counter(count);

//把计数器对象保存到Web应用范围

context.setAttribute("counter",counter);

}catch(IOException e){e.printStackTrace();}

}

public void contextDestroyed(ServletContextEvent sce){

System.out.println("helloapp application is Destroyed.");

    //获取ServletContext对象

ServletContext context=sce.getServletContext();

    //从Web应用范围获得计数器对象

Counter counter=(Counter)context.getAttribute("counter");

    if(counter!=null){

try{

//把计数器的数值写到count.txt文件中

String filepath=context.getRealPath("/count");

filepath=filepath+"/count.txt";

PrintWriter pw=new PrintWriter(filepath);

pw.println(counter.getCount());

pw.close();

}catch(IOException e){e.printStackTrace();}

}

}

}

用户自定义的MyServletContextListener监听器只有先向Servlet容器注册，Servlet容器在启动或终止Web应用时，才会调用该监听器的相关方法。在web.xml文件中，<listener>元素用于向容器注册监听器：
Xml代码

   1. Tips 
   2.  
   3. <listener> 
   4.  
   5. <listener-class>mypack.MyServletContextListener<listener-class /> 
   6.  
   7. </listener> 

Tips

<listener>

<listener-class>mypack.MyServletContextListener<listener-class />

</listener>



下面按如下步骤演示MyServletContextListener监听器的作用。

（1）在helloapp/count目录下创建count.txt文件，在该文件中存放了一个数字“5”。

（2）启动 Tomcat。在浏览器中通过 http://localhost:8080/helloapp/counter 访问CounterServlet，在第一次访问该Servlet时，浏览器端显示计数器的值为5。

（3）刷新上述访问 CounterServlet 的页面，会看到每刷新一次，计数器的值增加1，假定最后一次刷新后的计数器的值为10。

（4）手工终止helloapp应用。查看helloapp/count/count.txt文件，会发现在该文件中存放的数字变为10。

（5）手工重新启动 helloapp 应用。在浏览器中再次访问 CounterServlet，当第一次访问该Servlet时，浏览器端显示计数器的值为10。

从上述实验中可以看出，MyServletContextListener 监听器与 CounterServlet 共享Web应用范围内的代表计数器的Counter对象。监听器在Web应用启动或终止时会操纵Counter对象，而Servlet在每次响应客户请求时会操纵Counter对象。

观察MyServletContextListener及本章4.3.4节的名为 lifeInit的 LifeServlet在 Tomcat 控制台的打印结果的先后顺序，会发现当 Web 应用启动时，Servlet容器先调用MyServletContextListener的contextInitialized()方法，再调用 lifeInit的init()方法；当Web应用终止时，Servlet容器先调用lifeInit的destroy()方法，再调用 MyServletContextListener的contextDestroyed()方法。由此可见，在Web应用的生命周期中，ServletContext对象最早被创建，最晚被销毁。

评论

1 楼 tataky 2010-05-21  

这是哪本书里写的