[Servlet] 配置listener监听器（HttpSessionListener和HttpSessionBindingListener）细说

1、了解如何使用HttpSessionListener监听session的销毁。
2、了解如何使用HttpSessionBindingListener监听session的销毁。

一、使用HttpSessionListener编写一个OnlineUserListener。

[java]  view plain  copy

1. package anni;  
2.   
3. import java.util.List;  
4. import javax.servlet.ServletContext;  
5. import javax.servlet.http.HttpSession;  
6. import javax.servlet.http.HttpSessionListener;  
7. import javax.servlet.http.HttpSessionEvent;  
8.   
9. public class OnlineUserListener implements HttpSessionListener {  
10.   
11.     public void sessionCreated(HttpSessionEvent event) {  
12.     }  
13.   
14.     public void sessionDestroyed(HttpSessionEvent event) {  
15.         HttpSession session = event.getSession();  
16.         ServletContext application = session.getServletContext();  
17.   
18.         // 取得登录的用户名  
19.         String username = (String) session.getAttribute("username");  
20.   
21.         // 从在线列表中删除用户名  
22.         List onlineUserList = (List) application.getAttribute("onlineUserList");  
23.         onlineUserList.remove(username);  
24.   
25.         System.out.println(username + "超时退出。");  
26.     }  
27.   
28. }  

OnlineUserListener实现了HttpSessionListener定义的两个方法：sessionCreated()和sessionDestroyed()。这两个方法可以监听到当前应用中session的创建和销毁情况。我们这里只用到sessionDestroyed()在session销毁时进行操作就可以。

从HttpSessionEvent中获得即将销毁的session，得到session中的用户名，并从在线列表中删除。最后一句向console打印一条信息，提示操作成功，这只是为了调试用，正常运行时删除即可。

为了让监听器发挥作用，我们将它添加到web.xml中：

[java]  view plain  copy

1. <listener>  
2.   <listener-class>anni.OnlineUserListener</listener-class>  
3. </listener>  

以下两种情况下就会发生sessionDestoryed（会话销毁）事件：
1、执行session.invalidate()方法时。
既然LogoutServlet.java中执行session.invalidate()时，会触发sessionDestory()从在线用户列表中清除当前用户，我们就不必在LogoutServlet.java中对在线列表进行操作了，所以LogoutServlet.java的内容现在是这样。

[java]  view plain  copy

1. public void doGet(HttpServletRequest request,HttpServletResponse response)  
2.     throws ServletException, IOException {  
3.     // 销毁session  
4.     request.getSession().invalidate();  
5.     // 成功  
6.     response.sendRedirect("index.jsp");  
7. }  

2、如果用户长时间没有访问服务器，超过了会话最大超时时间，服务器就会自动销毁超时的session。
会话超时时间可以在web.xml中进行设置，为了容易看到超时效果，我们将超时时间设置为最小值。

[java]  view plain  copy

1. <session-config>  
2.     <session-timeout>1</session-timeout>  
3. </session-config>  

 时间单位是一分钟，并且只能是整数，如果是零或负数，那么会话就永远不会超时。

对应例子在08-01，为了验证OnlineUserListener是否能正常执行，我们可以登录两个用户，其中一个点击注销，另一个等待一分钟，然后可以在console中看到输出的信息。
  下载 (13.11 KB)

2009-7-1 14:37

二、使用HttpSessionBindingListener
HttpSessionBindingListener虽然叫做监听器，但使用方法与HttpSessionListener完全不同。我们实际看一下它是如何使用的。

我们的OnlineUserBindingListener实现了HttpSessionBindingListener接口，接口中共定义了两个方法：valueBound()和valueUnbound()，分别对应数据绑定，和取消绑定两个事件。

所谓对session进行数据绑定，就是调用session.setAttribute()把HttpSessionBindingListener保存进session中。我们在LoginServlet.java中进行这一步。

[java]  view plain  copy

1. public void valueBound(HttpSessionBindingEvent event) {  
2.     HttpSession session = event.getSession();  
3.     ServletContext application = session.getServletContext();  
4.   
5.     // 把用户名放入在线列表  
6.     List onlineUserList = (List) application.getAttribute("onlineUserList");  
7.     // 第一次使用前，需要初始化  
8.     if (onlineUserList == null) {  
9.         onlineUserList = new ArrayList();  
10.         application.setAttribute("onlineUserList", onlineUserList);  
11.     }  
12.     onlineUserList.add(this.username);  
13. }  

 

 这就是HttpSessionBindingListener和HttpSessionListener之间的最大区别：HttpSessionListener只需要设置到web.xml中就可以监听整个应用中的所有session。HttpSessionBindingListener必须实例化后放入某一个session中，才可以进行监听。

从监听范围上比较，HttpSessionListener设置一次就可以监听所有session，HttpSessionBindingListener通常都是一对一的。

正是这种区别成就了HttpSessionBindingListener的优势，我们可以让每个listener对应一个username，这样就不需要每次再去session中读取username，进一步可以将所有操作在线列表的代码都移入listener，更容易维护。

valueBound()方法的代码如下：

[java]  view plain  copy

1. public void valueUnbound(HttpSessionBindingEvent event) {  
2.     HttpSession session = event.getSession();  
3.     ServletContext application = session.getServletContext();  
4.   
5.     // 从在线列表中删除用户名  
6.     List onlineUserList = (List) application.getAttribute("onlineUserList");  
7.     onlineUserList.remove(this.username);  
8.   
9.     System.out.println(this.username + "退出。");  
10. }  

 

这里可以直接使用listener的username操作在线列表，不必再去担心session中是否存在username。

valueUnbound的触发条件是以下三种情况：
执行session.invalidate()时。
session超时，自动销毁时。
执行session.setAttribute("onlineUserListener", "其他对象");或session.removeAttribute("onlineUserListener");将listener从session中删除时。

因此，只要不将listener从session中删除，就可以监听到session的销毁。