實現(xiàn)session監(jiān)聽器

Tom.Lin 2012-07-10

展開全文

監(jiān)聽器概述

1.Listener是Servlet的監(jiān)聽器
2.可以監(jiān)聽客戶端的請求、服務(wù)端的操作等。
3.通過監(jiān)聽器，可以自動激發(fā)一些操作，如監(jiān)聽在線用戶數(shù)量,當(dāng)增加一個HttpSession時，給在線人數(shù)加1。
4.編寫監(jiān)聽器需要實現(xiàn)相應(yīng)的接口
5.編寫完成后在web.xml文件中配置一下,就可以起作用了
6.可以在不修改現(xiàn)有系統(tǒng)基礎(chǔ)上,增加web應(yīng)用程序生命周期事件的跟蹤

常用的監(jiān)聽接口

Java代碼

1.ServletContextAttributeListener
監(jiān)聽對ServletContext屬性的操作，比如增加/刪除/修改
2.ServletContextListener
監(jiān)聽ServletContext,當(dāng)創(chuàng)建ServletContext時，激發(fā) contextInitialized(ServletContextEvent sce)方法；當(dāng)銷毀ServletContext時，激發(fā)contextDestroyed(ServletContextEvent sce)方法。
3.HttpSessionListener
監(jiān)聽HttpSession的操作。當(dāng)創(chuàng)建一個 Session時，激發(fā)session Created(SessionEvent se)方法；當(dāng)銷毀一個Session時，激發(fā)sessionDestroyed (HttpSessionEvent se)方法。
4.HttpSessionAttributeListener
監(jiān)聽HttpSession中的屬性的操作。當(dāng)在Session增加一個屬性時，激發(fā) attributeAdded(HttpSessionBindingEvent se) 方法；當(dāng)在Session刪除一個屬性時，激發(fā)attributeRemoved(HttpSessionBindingEvent se)方法；當(dāng)在Session屬性被重新設(shè)置時，激發(fā)attributeReplaced(HttpSessionBindingEvent se) 方法。

使用范例：
由監(jiān)聽器管理共享數(shù)據(jù)庫連接

生命周期事件的一個實際應(yīng)用由context監(jiān)聽器管理共享數(shù)據(jù)庫連接。在web.xml中如下定義監(jiān)聽器：

Java代碼

<listener>
<listener-class>XXX.MyConnectionManager</listener-class>
</listener>

server創(chuàng)建監(jiān)聽器的實例,接受事件并自動判斷實現(xiàn)監(jiān)聽器接口的類型。要記住的是由于監(jiān)聽器是配置在部署描述符web.xml中，所以不需要改變?nèi)魏未a就可以添加新的監(jiān)聽器。

Java代碼

public class MyConnectionManager implements ServletContextListener{
public void contextInitialized(ServletContextEvent e) {
Connection con = // create connection
e.getServletContext().setAttribute("con", con);
}
public void contextDestroyed(ServletContextEvent e) {
Connection con = (Connection) e.getServletContext().getAttribute("con");
try {
con.close();
}
catch (SQLException ignored) { } // close connection
}
}

監(jiān)聽器保證每新生成一個servlet context都會有一個可用的數(shù)據(jù)庫連接,并且所有的連接對會在context關(guān)閉的時候隨之關(guān)閉。

在web.xml中加入:

Java代碼

<listener><listener-class>servletlistener111111.SecondListener</listener-class> </listener>

==================================================

關(guān)于用戶超時的例子：

Java代碼

public class OnlineUserListener implements HttpSessionListener {
public void sessionCreated(HttpSessionEvent event) {
}
public void sessionDestroyed(HttpSessionEvent event) {
HttpSession session = event.getSession();
ServletContext application = session.getServletContext();
// 取得登錄的用戶名
String username = (String) session.getAttribute("username");
// 從在線列表中刪除用戶名
List onlineUserList = (List) application.getAttribute("onlineUserList");
onlineUserList.remove(username);
System.out.println(username + "超時退出。");
}
}

以下兩種情況下就會發(fā)生sessionDestoryed（會話銷毀）事件：

1.執(zhí)行session.invalidate()方法時。例如：request.getSession().invalidate();

2.如果用戶長時間沒有訪問服務(wù)器，超過了會話最大超時時間，服務(wù)器就會自動銷毀超時的session。會話超時時間可以在web.xml中進(jìn)行設(shè)置。

========================================

使用HttpSessionBindingListener

HttpSessionBindingListener雖然叫做監(jiān)聽器，但使用方法與HttpSessionListener完全不同。我們實際看一下它是如何使用的。

我們的OnlineUserBindingListener實現(xiàn)了HttpSessionBindingListener接口，接口中共定義了兩個方法：valueBound()和valueUnbound()，分別對應(yīng)數(shù)據(jù)綁定，和取消綁定兩個事件。

所謂對session進(jìn)行數(shù)據(jù)綁定，就是調(diào)用session.setAttribute()把HttpSessionBindingListener保存進(jìn)session中。我們在LoginServlet.java中進(jìn)行這一步。

// 把用戶名放入在線列表
session.setAttribute("onlineUserBindingListener", new OnlineUserBindingListener(username));

這就是HttpSessionBindingListener和HttpSessionListener之間的最大區(qū)別：HttpSessionListener只需要設(shè)置到web.xml中就可以監(jiān)聽整個應(yīng)用中的所有session。 HttpSessionBindingListener必須實例化后放入某一個session中，才可以進(jìn)行監(jiān)聽。

從監(jiān)聽范圍上比較，HttpSessionListener設(shè)置一次就可以監(jiān)聽所有session，HttpSessionBindingListener通常都是一對一的。

正是這種區(qū)別成就了HttpSessionBindingListener的優(yōu)勢，我們可以讓每個listener對應(yīng)一個username，這樣就不需要每次再去session中讀取username，進(jìn)一步可以將所有操作在線列表的代碼都移入listener，更容易維護(hù)。

valueBound()方法的代碼如下：

Java代碼

public void valueBound(HttpSessionBindingEvent event) {
HttpSession session = event.getSession();
ServletContext application = session.getServletContext();
// 把用戶名放入在線列表
List onlineUserList = (List) application.getAttribute("onlineUserList");
// 第一次使用前，需要初始化
if (onlineUserList == null) {
onlineUserList = new ArrayList();
application.setAttribute("onlineUserList", onlineUserList);
}
onlineUserList.add(this.username);
}

username已經(jīng)通過構(gòu)造方法傳遞給listener，在數(shù)據(jù)綁定時，可以直接把它放入用戶列表。

與之對應(yīng)的valueUnbound()方法，代碼如下：

Java代碼

public void valueUnbound(HttpSessionBindingEvent event) {
HttpSession session = event.getSession();
ServletContext application = session.getServletContext();
// 從在線列表中刪除用戶名
List onlineUserList = (List) application.getAttribute("onlineUserList");
onlineUserList.remove(this.username);
System.out.println(this.username + "退出。");
}

這里可以直接使用listener的username操作在線列表，不必再去擔(dān)心session中是否存在username。

valueUnbound的觸發(fā)條件是以下三種情況：

Java代碼

1.執(zhí)行session.invalidate()時。
2.session超時，自動銷毀時。
3.執(zhí)行session.setAttribute("onlineUserListener", "其他對象");或session.removeAttribute("onlineUserListener");將listener從session中刪除時。