HttpSessionBindingListener接口讲解

  categories:资料  author:

实时在线人数统计方面的实现,上网找了下这方面的知识,最初我的想法是,管理session,如果session销毁了就减少,如果登陆用户了就新增一个,但是如果是用户非法退出,如:未注销,关闭浏览器等,这个用户的session是管理不到的,最后决定用HttpSessionListener接口或HttpSessionBindingListener接口来实现,通过监听session的新建和销毁来控制,详细如下。(讲解:HttpSessionListener和HttpSessionBindingListener接口的作用都是用来对session做监听的,一旦session有变就立马执行接口里面的方法

先添加登陆的页面index.jsp

<%@ page contentType="text/html;charset=utf-8"%>
<html>
<head>
<title>test</title>              
</head>
<body>
<form action="login.jsp" method="post">
    用户名:<input type="text" name="username" />
    <br />
    <input type="submit" value="登录" />
</form>
</body>
</html>

点击登陆后跳转的login.jsp(为了方便,用jsp做servlet,同学们用的时候记得改过来)

<%@ page contentType="text/html;charset=utf-8"%>
<%@ page import="java.util.*"%>
<%
    request.setCharacterEncoding("UTF-8");
    // 取得登录的用户名
    String username = request.getParameter("username");
    // 把用户名保存进session
    session.setAttribute("username", username);
    // 把用户名放入在线列表
    List onlineUserList = (List) application.getAttribute("onlineUserList");
    // 第一次使用前,需要初始化
    if (onlineUserList == null) {
        onlineUserList = new ArrayList();
        application.setAttribute("onlineUserList", onlineUserList);
    }
    onlineUserList.add(username);
    // 成功
    response.sendRedirect("result.jsp");
%>

登陆成功跳转到显示页面result.jsp

<%@ page contentType="text/html;charset=utf-8"%>
<%@ page isELIgnored="false"%>
<%@page import="java.util.List"%>
<h3>您好:${username} [<a href="logout.jsp">注销</a>]</h3>
当前在线用户:
<table>
<%
    List onlineUserList = (List) application.getAttribute("onlineUserList");
    for (int i = 0; i < onlineUserList.size(); i++) {
    String onlineUsername = (String) onlineUserList.get(i);
%>
    <tr>
        <td><%=onlineUsername%></td>
    </tr>
<%
}
%>
</table>

点击注销页面logout.jsp页面

<%@ page contentType="text/html;charset=utf-8"%>
<%@ page import="java.util.*"%>
<%
    // 取得登录的用户名
    String username = (String) session.getAttribute("username");
    // 销毁session
    session.invalidate();
    // 从在线列表中删除用户名
    List onlineUserList = (List) application.getAttribute("onlineUserList");
    onlineUserList.remove(username);
    // 成功
    response.sendRedirect("index.jsp");
%> 

OK,登陆、查看、注销页面都有了,下面开始新建监听器

1、HttpSessionListener

自定义一个类OnlineUserListener,继承HttpSessionListener,HttpSessionListener中有两个方法sessionCreated(HttpSessionEvent event)与sessionDestroyed(HttpSessionEvent event),前者是监听session的新建,后者是监听session的销毁。(讲解:从服务器后端做全局监听,只要有session创建,那就执行sessionCreated(HttpSessionEvent event)这个方法,只要有session销毁,那就执行sessionDestroyed(HttpSessionEvent event)方法

OnlineUserListener代码如下:

package com.test;
 
import java.util.List;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;
/**
 * @author 版本
 */
public class OnlineUserListener implements HttpSessionListener {
 
	public void sessionCreated(HttpSessionEvent event) {
		System.out.println("新建session:"+event.getSession().getId());
	}
	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+"已经退出!");
	}
}

web.xml配置:

<listener>
  <listener-class>com.test.OnlineUserListener</listener-class>
</listener>

一旦监听器发现某个session被关闭了,就会立马调用了sessionDestoryed方法(解释:在上面的代码里面我们在sessionDestroyed方法里面写的业务是把其用户从在线人数中delete),在下面两种情况下会发生sessionDestoryed事件

  1. 执行session.invalidate()方法时
    logout.jsp中调用了 session.invalidate()方法
  2. session会话超时
    session的默认超时事件是30分钟,30分钟后自动销毁session

2、HttpSessionBindingListener

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

我们先自定义一个OnlineUserBindingListener类,实现HttpSessionBindingListener接口,构造方法传入username参数,HttpSessionBindingListener内有两个方法valueBound(HttpSessionBindingEvent event)和valueUnbound(HttpSessionBindingEvent event),
前者为数据绑定(解释:所谓对session进行数据绑定,就是调用session.setAttribute()把HttpSessionBindingListener保存进session中。),

后者为取消绑定(解释
valueUnbound的触发条件是以下三种情况:
1. 执行session.invalidate()时。
2. session超时,自动销毁时。
3. 执行session.setAttribute(“onlineUserListener”, “其他对象”);或session.removeAttribute(“onlineUserListener”);将listener从session中删除时。
因此,只要不将listener从session中删除,就可以监听到session的销毁。)。

在login.jsp中做这一步:

<%@page import="com.test.OnlineUserBindingListener"%>
<%@ page contentType="text/html;charset=utf-8"%>
<%@ page import="java.util.*"%>
<%
    request.setCharacterEncoding("UTF-8");
    // 取得登录的用户名
    String username = request.getParameter("username");
       // 把用户名放入在线列表     把我们自定义的OnlineUserBindingListener类实例化以后存到session里面去,只要这行代码一旦执行,那么就会触发OnlineUserBindingListener类里的valueBound(HttpSessionBindingEvent event)方法
    session.setAttribute("onlineUserBindingListener", new OnlineUserBindingListener(username));
    // 成功
    response.sendRedirect("result.jsp");
%>

这就是HttpSessionBindingListener和HttpSessionListener之间的最大区别:HttpSessionListener只需要设置到web.xml中就可以监听整个应用中的所有session。HttpSessionBindingListener必须实例化后放入某一个session中解释:例如 session.setAttribute("onlineUserBindingListener", new OnlineUserBindingListener(username));把我们自定义的监听类存储到session中,这个监听器就像“寄生虫”一样赋于该session上),才可以进行监听。

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

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

HttpSessionBindingListener代码如下:
(提示:在代码后面会有详细的代码讲解)

package com.test;
 
import java.util.ArrayList;
import java.util.List;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpSessionBindingEvent;
import javax.servlet.http.HttpSessionBindingListener;
 
public class OnlineUserBindingListener implements HttpSessionBindingListener {
	String username;
	
	public OnlineUserBindingListener(String username){
		this.username=username;
	}
	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);
	}
 
	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的销毁。

来源:https://blog.csdn.net/qq_40241957/article/details/97906977

————-

HttpSessionListener与HttpSessionBindingListener之间区别

1. 使用HttpSessionListener 编写一个OnlineUserListener。

Java代码
  1. package test;
  2. import java.util.List;
  3. import javax.servlet.ServletContext;
  4. import javax.servlet.http.HttpSession;
  5. import javax.servlet.http.HttpSessionListener;
  6. import javax.servlet.http.HttpSessionEvent;
  7. public class OnlineUserListener implements HttpSessionListener{
  8.     public void sessionCreated(HttpSessionEvent event) {}
  9.     public void sessionDestroyed(HttpSessionEvent event) {
  10.         HttpSession session = event.getSession();
  11.         ServletContext application = session.getServletContext();// 取得登录的用户名
  12.         String username = (String) session.getAttribute(“username”);// 从在线列表中删除用户名
  13.         List onlineUserList = (List) application.getAttribut(“onlineUserList”);
  14.         onlineUserList.remove(username);
  15.         System.out.println(username + “超时退出。”);
  16.     }
  17. }

 

 

OnlineUserListener实现了HttpSessionListener定义的两个方法:sessionCreated()和 sessionDestroyed()。

这两个方法可以监听到当前应用中session的创建和销毁情况。我们这里只用到 sessionDestroyed()在session销毁

时进行操作就可以。

 

从HttpSessionEvent中获得即将销毁的session,得到session中的用户名,并从在线列表中删除。最后一句向

console打印一条信息,提示操作成功,这只是为了调试用,正常运行时删除即可。

 

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

 

<listener>

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

</listener>

 

 

以下两种情况下就会发生sessionDestoryed(会话销毁)事件:

 

执行session.invalidate()方法时。

 

既然LogoutServlet.java中执行session.invalidate()时,会触发sessionDestory()从在线用户列表中清除当前用户,我

们就不必在LogoutServlet.java中对在线列表进行操作了,所以LogoutServlet.java的内容现在是这样。

Java代码  收藏代码
  1. public void doGet(HttpServletRequest request,HttpServletResponse response) throws ServletException, IOException {    // 销毁session    
  2.     request.getSession().invalidate();    // 成功
  3.     response.sendRedirect(“index.jsp”);
  4. }

 

如果用户长时间没有访问服务器,超过了会话最大超时时间,服务器就会自动销毁超时的session。

会话超时时间可以在web.xml中进行设置,为了容易看到超时效果,我们将超时时间设置为最小值。

 

<session-config>

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

</session-config>

 

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

 

为了验证OnlineUserListener是否能正常执行,我们可以登录两个用户,其中一个点击注销,另一个等待一分钟,然后可

以在console中看到输出的信息。

 

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()方法的代码如下:

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

 

username已经通过构造方法传递给listener,在数据绑定时,可以直接把它放入用户列表。

 

与之对应的valueUnbound()方法,代码如下:

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

 

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

 

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

 

执行session.invalidate()时。

 

session超时,自动销毁时。

 

执行session.setAttribute(“onlineUserListener”, “其他对象”);

或session.removeAttribute(“onlineUserListener”);将listener从session 中删除时。

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

来源: https://www.iteye.com/blog/hy2012-2207902



快乐成长 每天进步一点点      京ICP备18032580号-1