第 8 章 配置listener监听器

第 8 章 配置listener监听器

注意

还记得我们之前讲过的在线列表吗？ 第 4.2 节 “例子：在线列表”。我们曾经说过那个在线列表无法判断用户非法退出，很可能造成在线列表无限增大，现在我们可以用listener来弥补这一问题了。

如果你不满足以下任一条件，请继续阅读，否则请跳过此后的部分，进入下一章： 第 9 章 封装taglib组件。

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

8.1. 使用HttpSessionListener

编写一个OnlineUserListener。

package anni;
import java.util.List;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpSessionListener;
import javax.servlet.http.HttpSessionEvent;
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 + "超时退出。");
    }
}
        

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

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

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

<listener>
  <listener-class>anni.OnlineUserListener</listener-class>
</listener>
        

以下两种情况下就会发生sessionDestoryed（会话销毁）事件：

1. 执行session.invalidate()方法时。
   既然LogoutServlet.java中执行session.invalidate()时，会触发sessionDestory()从在线用户列表中清除当前用户，我们就不必在LogoutServlet.java中对在线列表进行操作了，所以LogoutServlet.java的内容现在是这样。

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

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

   <session-config>
       <session-timeout>1</session-timeout>
   </session-config>
                   

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

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

8.2. 使用HttpSessionBindingListener

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

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

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

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

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

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

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

valueBound()方法的代码如下：

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已经通过构造方法传递给listener，在数据绑定时，可以直接把它放入用户列表。

与之对应的valueUnbound()方法，代码如下：

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操作在线列表，不必再去担心session中是否存在username。

valueUnbound的触发条件是以下三种情况：

1. 执行session.invalidate()时。
2. session超时，自动销毁时。
3. 执行session.setAttribute("onlineUserListener", "其他对象");或session.removeAttribute("onlineUserListener");将listener从session中删除时。

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

例子在08-02目录下，可以与08-01对比一下异同，两者的最终效果是相同的。