web上下文监听器ServletContextListener 例子 .

这个J2EE小提示阐述了ServletContextListener的用法。这个事件类作为Web应用服务的一部分，处理Web应用的 servlet上下文(context)的变化的通知。这可以解释为，好像有个人在服务器旁不断地通知我们服务器在发生什么事件。那当然需要监听者了。因此，在通知上下文(context)初始化和销毁的时候，ServletContextListner非常有用。
Java代码 复制代码 收藏代码
  1. package com.listeners;   
  2. import javax.servlet.ServletContextListener;   
  3.   
  4. import javax.servlet.ServletContextEvent;   
  5. import javax.servlet.*;   
  6. public class MyContextListener implements ServletContextListener {   
  7. private ServletContext context = null;   
  8.   
  9.  public void contextDestroyed(ServletContextEvent event){   
  10.   //Output a simple message to the server's console   
  11.   System.out.println("The Simple Web App. Has Been Removed");   
  12.   this.context = null;   
  13. }   
  14.  // 这个方法在Web应用服务做好接受请求的时候被调用。   
  15. public void contextInitialized(ServletContextEvent event){   
  16.   this.context = event.getServletContext();   
  17.   //Output a simple message to the server's console   
  18.   System.out.println("The Simple Web App. Is Ready");   
  19. }   
  20. }  
[java] view plaincopyprint?
  1. package com.listeners;  
  2. import javax.servlet.ServletContextListener;  
  3.   
  4. import javax.servlet.ServletContextEvent;  
  5. import javax.servlet.*;  
  6. public class MyContextListener implements ServletContextListener {  
  7. private ServletContext context = null;  
  8.   
  9.  public void contextDestroyed(ServletContextEvent event){  
  10.   //Output a simple message to the server's console   
  11.   System.out.println("The Simple Web App. Has Been Removed");  
  12.   this.context = null;  
  13. }  
  14.  // 这个方法在Web应用服务做好接受请求的时候被调用。   
  15. public void contextInitialized(ServletContextEvent event){  
  16.   this.context = event.getServletContext();  
  17.   //Output a simple message to the server's console   
  18.   System.out.println("The Simple Web App. Is Ready");  
  19. }  
  20. }  
package com.listeners;
import javax.servlet.ServletContextListener;

import javax.servlet.ServletContextEvent;
import javax.servlet.*;
public class MyContextListener implements ServletContextListener {
private ServletContext context = null;

 public void contextDestroyed(ServletContextEvent event){
  //Output a simple message to the server's console
  System.out.println("The Simple Web App. Has Been Removed");
  this.context = null;
}
 // 这个方法在Web应用服务做好接受请求的时候被调用。
public void contextInitialized(ServletContextEvent event){
  this.context = event.getServletContext();
  //Output a simple message to the server's console
  System.out.println("The Simple Web App. Is Ready");
}
}

在WEB.XML中
Xml代码 复制代码 收藏代码
  1. <web-app>  
  2. <listener>  
  3.   <listener-class>  
  4.    com.listeners.MyContextListener   
  5.   </listener-class>  
  6. </listener>  
  7. <servlet/>  
  8. <servlet-mapping/>  
  9. </web-app>  
[xml] view plaincopyprint?
  1. <web-app>  
  2. <listener>  
  3.   <listener-class>  
  4.    com.listeners.MyContextListener  
  5.   </listener-class>  
  6. </listener>  
  7. <servlet/>  
  8. <servlet-mapping/>  
  9. </web-app>  
<web-app>
<listener>
  <listener-class>
   com.listeners.MyContextListener
  </listener-class>
</listener>
<servlet/>
<servlet-mapping/>
</web-app>


ServletContextListener接口有两方需要实现的方法:
contextInitialized()和contextDestroyed();
Listener,译为监听者.顾名思义,它会监听Servlet容器,当应用开始的时候它会调用contextInitialized()方法;
当应用关闭的时候,它同样会调用contextDestroyed()方法.
我们可以利用这个特性初始化一些信息,当然我们也可以利用Servlet类init()方法,并在配置文件中让它启动应用的时候
就执行,并且在关闭的时候执行destroy()方法.但是继承此接口应该更符合容器的应用.
举个简单的例子:在一些论坛,社区及聊天室当中,删除在线的超时用户就可以利用这个接口来实现.
可以利用JAVA的TimerTask及Timer类来实现每隔一定的时间进行自动检测.
实例代码如下:

UserOnlineTimerTask.java
Java代码 复制代码 收藏代码
  1. package com.bcxy.servlet;   
  2. import java.util.TimerTask;   
  3. import org.apache.commons.logging.Log;   
  4. import org.apache.commons.logging.LogFactory;   
  5. public class UserOnlineTimerTask extends TimerTask {   
  6. Log log = LogFactory.getLog(UserOnlineTimerTask.class);   
  7. public void run() {   
  8. // 删除超时在线用户   
  9. log.info("删除在线的超时用户....");   
  10. }   
  11. }  
[java] view plaincopyprint?
  1. package com.bcxy.servlet;  
  2. import java.util.TimerTask;  
  3. import org.apache.commons.logging.Log;  
  4. import org.apache.commons.logging.LogFactory;  
  5. public class UserOnlineTimerTask extends TimerTask {  
  6. Log log = LogFactory.getLog(UserOnlineTimerTask.class);  
  7. public void run() {  
  8. // 删除超时在线用户   
  9. log.info("删除在线的超时用户....");  
  10. }  
  11. }  
package com.bcxy.servlet;
import java.util.TimerTask;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
public class UserOnlineTimerTask extends TimerTask {
Log log = LogFactory.getLog(UserOnlineTimerTask.class);
public void run() {
// 删除超时在线用户
log.info("删除在线的超时用户....");
}
}


SysListener.java
Java代码 复制代码 收藏代码
  1. package com.bcxy.servlet;   
  2. import java.io.IOException;   
  3. import java.util.Timer;   
  4. import javax.servlet.ServletContextEvent;   
  5. import javax.servlet.ServletContextListener;   
  6. import javax.servlet.ServletException;   
  7. import javax.servlet.ServletRequest;   
  8. import javax.servlet.ServletResponse;   
  9. import javax.servlet.http.HttpServlet;   
  10. import org.apache.commons.logging.Log;   
  11. import org.apache.commons.logging.LogFactory;   
  12. public class SysListener   
  13. extends HttpServlet   
  14. implements ServletContextListener {   
  15. Log log = LogFactory.getLog(SysListener.class);   
  16. Timer timer = new Timer();   
  17. public void service(ServletRequest request, ServletResponse response)   
  18. throws ServletException, IOException {   
  19. //   
  20.   
  21. }   
  22. public void contextInitialized(ServletContextEvent sce) {   
  23. log.info("initial context....");   
  24. timer.schedule(new UserOnlineTimerTask(), 0, 10000);   
  25.   
  26. }   
  27. public void contextDestroyed(ServletContextEvent sce) {   
  28. log.info("destory context....");   
  29. timer.cancel();   
  30. }   
  31.   
  32. }  
[java] view plaincopyprint?
  1. package com.bcxy.servlet;  
  2. import java.io.IOException;  
  3. import java.util.Timer;  
  4. import javax.servlet.ServletContextEvent;  
  5. import javax.servlet.ServletContextListener;  
  6. import javax.servlet.ServletException;  
  7. import javax.servlet.ServletRequest;  
  8. import javax.servlet.ServletResponse;  
  9. import javax.servlet.http.HttpServlet;  
  10. import org.apache.commons.logging.Log;  
  11. import org.apache.commons.logging.LogFactory;  
  12. public class SysListener  
  13. extends HttpServlet  
  14. implements ServletContextListener {  
  15. Log log = LogFactory.getLog(SysListener.class);  
  16. Timer timer = new Timer();  
  17. public void service(ServletRequest request, ServletResponse response)  
  18. throws ServletException, IOException {  
  19. //   
  20.   
  21. }  
  22. public void contextInitialized(ServletContextEvent sce) {  
  23. log.info("initial context....");  
  24. timer.schedule(new UserOnlineTimerTask(), 0, 10000);  
  25.   
  26. }  
  27. public void contextDestroyed(ServletContextEvent sce) {  
  28. log.info("destory context....");  
  29. timer.cancel();  
  30. }  
  31.   
  32. }  
package com.bcxy.servlet;
import java.io.IOException;
import java.util.Timer;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServlet;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
public class SysListener
extends HttpServlet
implements ServletContextListener {
Log log = LogFactory.getLog(SysListener.class);
Timer timer = new Timer();
public void service(ServletRequest request, ServletResponse response)
throws ServletException, IOException {
//

}
public void contextInitialized(ServletContextEvent sce) {
log.info("initial context....");
timer.schedule(new UserOnlineTimerTask(), 0, 10000);

}
public void contextDestroyed(ServletContextEvent sce) {
log.info("destory context....");
timer.cancel();
}

}

如果你没有使用log4j的话,你可以把log.info()改为System.out.println()会得到同样的结果.

 

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

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

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

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

 

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>元素用于向容器注册监听器：

 

 

 

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对象最早被创建，最晚被销毁

ServletContextListener接口有两方需要实现的方法:contextInitialized()和contextDestroyed();

Listener,译为监听者.顾名思义,它会监听Servlet容器,当应用开始的时候它会调用contextInitialized()方法;

当应用关闭的时候,它同样会调用contextDestroyed()方法.我们可以利用这个特性初始化一些信息,当然我们

也可以利用Servlet类init()方法,并在配置文件中让它启动应用的时候就执行,并且在关闭的时候执行destroy()方

法.但是继承此接口应该更符合容器的应用

posted @ 2013-06-14 19:19  嗨,你的益达~~~  阅读(19497)  评论(0)  编辑  收藏  举报