ServletContextListener接口使用

 

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 的實例。

我們使用緩存的思路大概是：

1. 服務器啓動時，ServletContextListener 的 contextInitialized()方法被調用，所以在裏面創建好緩存。可以從文件中或者從數據庫中讀取取緩存內容生成類，用 ervletContext.setAttribute()方法將緩存類保存在 ServletContext 的實例中。

2. 程序使用 ServletContext.getAttribute()讀取緩存。如果是 JSP，使用a pplication.getAttribute()。如果是 Servlet，使用 getServletContext().getAttribute()。如果緩存發生變化(如訪問計數)，你可以同時更改緩存和文件/數據庫。或者你等變化積累到一定程序再保存，也可以在下一步保存。

3. 服務器將要關閉時，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>