ServletContextListener接口的使用心得

转载自 3SeeFans

最终编辑 海盗王克莱普

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

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

我们可以利用这个特性初始化一些信息,当然我们也可以利用Servlet类init()方法,并在配置文件中让它启动应用的时候
就执行,并且在关闭的时候执行destroy()方法.但是继承此接口应该更符合容器的应用.

举个简单的例子:在一些论坛,社区及聊天室当中,删除在线的超时用户就可以利用这个接口来实现.
可以利用JAVA的TimerTask及Timer类来实现每隔一定的时间进行自动检测.
实例代码如下:

UserOnlineTimerTask.java
-----------------
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
-----------------------------------
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()会得到同样的结果.

如果你想配置log4j,请点击日志记录的使用方法


这个J2EE小提示阐述了ServletContextListener的用法。这个事件类作为Web应用程序的一部分，处理Web应用程序的servlet上下文(context)的变化的通知。这可以解释为，好像有个人在服务器旁不断地通知我们服务器在发生什么事件。那当然需要监听者了。因此，在通知上下文(context)初始化和销毁的时候，ServletContextListner非常有用。

import javax.servlet.ServletContextListener;
import javax.servlet.ServletContextEvent;
import javax.servlet.*;

public class MyListener implements ServletContextListener {

private ServletContext context = null;

/* 这个方法在Web应用服务被移除，没有能力再接受请求的时候被调用。
  */
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-app>
<listener>
  <listener-class>
   com.listeners.MyContextListener
  </listener-class>
</listener>
<servlet/>
<servlet-mapping/>
</web-app>

ServletContext 被 Servlet 程序用来与 Web 容器通信。例如写日志，转发请求。每一个 Web 应用程序含有一个Context，被Web应用内的各个程序共享。因为Context可以用来保存资源并且共享，所以我所知道的 ServletContext 的最大应用是Web缓存----把不经常更改的内容读入内存，所以服务器响应请求的时候就不需要进行慢速的磁盘I/O了。ServletContextListener 是 ServletContext 的监听者，如果 ServletContext 发生变化，如服务器启动时 ServletContext 被创建，服务器关闭时 ServletContext 将要被销毁。在JSP文件中，application 是 ServletContext 的实例，由JSP容器默认创建。Servlet 中调用 getServletContext()方法得到 ServletContext 的实例。我们使用缓存的思路大概是：服务器启动时，ServletContextListener 的 contextInitialized()方法被调用，所以在里面创建好缓存。可以从文件中或者从数据库中读取取缓存内容生成类，用 ervletContext.setAttribute()方法将缓存类保存在 ServletContext 的实例中。程序使用 ServletContext.getAttribute()读取缓存。如果是 JSP，使用a pplication.getAttribute()。如果是 Servlet，使用 getServletContext().getAttribute()。如果缓存发生变化(如访问计数)，你可以同时更改缓存和文件/数据库。或者你等变化积累到一定程序再保存，也可以在下一步保存。服务器将要关闭时，ServletContextListener 的 contextDestroyed()方法被调用，所以在里面保存缓存的更改。将更改后的缓存保存回文件或者数据库，更新原来的内容。import User; //my own class
import DatabaseManager; // my own class
import javax.servlet.ServletContext;
import javax.servlet.ServletContextListener;

public class MyContextListener

implements ServletContextListener {
private ServletContext context = null;

public void contextInitialized(ServletContextEvent event) {
  context = event.getServletContext();
  User user = DatabaseManager.getUserById(1);
  context.setAttribute("user1", user);
}

public void contextDestroyed(ServletContextEvent event) {
  User user = (User)context.getAttribute("user1");
  DatabaseManager.updateUserData(user);
  this.context = null;
}
}
布署 ServletContextListener
你实现(implements)了 ServletContextListener 编译后，把它放在正确的WEB-INF/classes目录下，更改WEB-INF目录下的 web.xml文件，在web-app节点里添加
<listener>
<listener-class>MyServletContextListener</listener-class>
</listener>