springboot 用监听器统计在线人数【测试通过】

迈不过友情╰ 2022-11-02 00:54 267阅读 0赞

本文在springboot 的项目，用HttpSessionListener 监听器（监听器的其中一种） 统计在线人数，实质是统计session 的数量。

思路很简单，但是有个细节没处理好，让我调试了大半天，才把bug搞好。

先写个HttpSessionListener 监听器。count  是session的数量（人数），session 创建的时候，会触发监听器的sessionCreated 方法，session销毁的时候，会触发监听器的sessionDestroyed 方法。 在监听器中计算完人数count，把他放进servletContext（可以理解为一个仓库，任意请求可以存储和获取里面的属性）。

注意监听器加上@WebListener，这样就不用配置。

但启动类要加上注解@ServletComponentScan，这样才能扫描到监听器

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </td> 
 <td> <code>@WebListener</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>OnLineCount&nbsp;</code><code>implements</code>&nbsp;<code>HttpSessionListener { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>int</code>&nbsp;<code>count=</code><code>0</code><code>;</code><code>//记录session的数量</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//监听session的创建,synchronized 防并发bug</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>synchronized</code>&nbsp;<code>void</code>&nbsp;<code>sessionCreated(HttpSessionEvent arg0) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"【HttpSessionListener监听器】count++&nbsp; 增加"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>count++;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>arg0.getSession().getServletContext().setAttribute(</code><code>"count"</code><code>, count);</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>synchronized</code>&nbsp;<code>void</code>&nbsp;<code>sessionDestroyed(HttpSessionEvent arg0) { </code><code>//监听session的撤销</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"【HttpSessionListener监听器】count--&nbsp; 减少"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>count--;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>arg0.getSession().getServletContext().setAttribute(</code><code>"count"</code><code>, count);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

接着写一个查询session 数量的controller，我开始的时候是像下面这样写的，是错误的！

从servletContext 中取出count ，把count返回前端。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>@RequestMapping</code><code>(</code><code>"/count"</code><code>)</code> <code>@ResponseBody</code> <code>public</code>&nbsp;<code>String count(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Object count=httpServletRequest.getServletContext().getAttribute(</code><code>"count"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>"count : "</code><code>+count;</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

这样是错误的，测试你会发现，页面看到count  是null ，因为没有创建session，没有触发监听器的统计方法。于是改一下：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>@Controller</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>IndexController { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@RequestMapping</code><code>(</code><code>"/count"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@ResponseBody</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>String count(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>HttpSession session = httpServletRequest.getSession();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Object count=session.getServletContext().getAttribute(</code><code>"count"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>"count : "</code><code>+count;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

HttpSession session = httpServletRequest.getSession();  作用：该用户如果没有sesision则创建session ，有则取得session不创建。

改成这样测试，看起来是对的，但是有个问题。一个浏览器对应一个session，你打开2个浏览器，看到count是2 ，是对的。但是你关了一个浏览器，再打开，应该是2不变才对，但是变成3 了，原因是session销毁的方法没有执行，重新打开时，服务器找不到用户原来的session ，重新创建了一个session，于是有3个session了，但是浏览器只有2个，也就是模拟应该是只有2个人在线上。

有2个方法可以解决这个问题，一个是在关闭网页的时候，前端去调用一个方法把session销毁。另一个更好的方法是，让服务器记得原来那个session，即把原来的sessionId 记录在浏览器，下次打开时，把这个sessionId发送过去，这样服务器就不会重新创建。

代码修改如下：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 </td> 
 <td> <code>@Controller</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>IndexController { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@RequestMapping</code><code>(</code><code>"/count"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@ResponseBody</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>String number(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>try</code><code>{&nbsp;&nbsp;</code><code>//把sessionId记录在浏览器</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Cookie c =&nbsp;</code><code>new</code>&nbsp;<code>Cookie(</code><code>"JSESSIONID"</code><code>, URLEncoder.encode(httpServletRequest.getSession().getId(),&nbsp;</code><code>"utf-8"</code><code>));</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>c.setPath(</code><code>"/"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//先设置cookie有效期为2天，不用担心，session不会保存2天</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>c.setMaxAge(&nbsp;</code><code>48</code><code>*</code><code>60</code>&nbsp;<code>*&nbsp;</code><code>60</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>httpServletResponse.addCookie(c);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code><code>catch</code>&nbsp;<code>(Exception e){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>e.printStackTrace();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>HttpSession session = httpServletRequest.getSession();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Object count=session.getServletContext().getAttribute(</code><code>"count"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>"count : "</code><code>+count;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

测试达到效果。

然后关闭浏览器，发现没有触发sessionDestroyed，然后怀疑是不是这个监听器的机制有问题，等了好几分钟都没有反应。  
后来想起session是有一个超时时间的，浏览器关闭其实对于web服务器来说是不知道的，所以他需要等待超时时间到了之后自动销毁，上面关闭浏览器之后只所以没有促发sessionDesroyed，就是因为默认的超时时间没到。  
默认超时时间太长了，所以在sessionCreated中添加如下代码，改小超时时间：  
        arg0.getSession().setMaxInactiveInterval(15);  
这样只要用浏览器访问该站点，然后15s不刷新之后，sessionDestroyed就会被自动调用了。一般不用设置这个超时时间，到了一定时间会自动销毁。

\--- end ---