【Java Web小功能】使用HttpSessionBindingListener来实现在线人数统计

现实在线人数统计

1. 背景： 如果使用spring MVC框架来实现统计在线人数功能，主要是使用HttpSessionBindingListener来实现该功能。

tips: 实现以上功能，必须要先搭建spring MVC框架层中的controller层和service层。

2. 代码实现

一、创建在线用户监听器。

// 创建一个在线用户监听器实现HttpSessionBindingListener，该类和HttpSessionListener不同，后者监听全部session，而前者只在session当中手动绑定，具体绑定方法见后文代码。
package com.duoduo.ddschool.listner;

import jakarta.servlet.ServletContext;
import jakarta.servlet.http.HttpSession;
import jakarta.servlet.http.HttpSessionBindingEvent;
import jakarta.servlet.http.HttpSessionBindingListener;

import java.util.ArrayList;
import java.util.List;

public class OnlineUserListener implements HttpSessionBindingListener {
    private String userName;

    public OnlineUserListener(String userName){
        this.userName = userName;
    }

    // session是每个会话一个域，servletContent是全局的域,request是请求的域。
    @Override
    public void valueBound(HttpSessionBindingEvent event) {
        HttpSession session = event.getSession();
        ServletContext servletContext = session.getServletContext();
        // 在全局域当中查询在线用户的列表。
        List<String> onlineUserList = (List<String>) servletContext.getAttribute("onlineUserList");
        if (onlineUserList == null) {
            onlineUserList = new ArrayList<>();
            servletContext.setAttribute("onlineUserList", onlineUserList);
        }
        onlineUserList.add(this.userName);
    }

    @Override
    public void valueUnbound(HttpSessionBindingEvent event) {
        HttpSession session = event.getSession();

        ServletContext servletContext = session.getServletContext();
        List<String> onlineUserList = (List<String>) servletContext.getAttribute("onlineUserList");
        if(onlineUserList.contains(this.userName)){
            onlineUserList.remove(this.userName);
        };
    }
}

二、在登记的servlet的页面域当中添加上统计页面的逻辑

// 这里是在request的session域当中添加上online域当中的online的域名当中
        this.request.getSession().setAttribute("online", new OnlineUserListener(name));

三、创建查询在线人数的controller层

    @GetMapping("/online")
    public String queryOnlineUser(){
        List onlineUserList =(List) request.getServletContext().getAttribute("onlineUserList");
        return String.valueOf(onlineUserList.size());
    }

tips:在这里如果要在本地添加上多个用户的话，需要打开不同的浏览器窗口（注意这里是多个窗口，不是多个页签。）

3. 知识点总结
   当一个HttpSessionBindingListener的类和其子类被放到session当中，比如session.setAttribute(“xxx”, HttpSessionBindingListener)类当中是，就会触发valueBound()方法，如果被移除后，就会触发valueUnbound()方法。