Spring Boot中使用监听器

一、前言什么是 Web 监听器Web 监听器是一种 Servlet 特殊类它们能帮助开发者监听 Web 中特定的事件比如 ServletContext、HttpSession 、ServletRequest 的创建和销毁变量的创建、销毁和修改等。可以在某些动作前后增加处理实现监控。Web 监听器的使用场景很多比如监听 Servlet 上下文用来初始化一些数据、监听 HTTP Session 用来获取当前在线的人数、监听客户端请求的 ServletRequest 对象来获取用户的访问信息等等。这一节中我们主要通过这三个实际的使用场景来学习一下 Spring Boot 中监听器的使用。二、监听 Servlet 上下文对象2.1 介绍监听 Servlet 上下文对象可以用来初始化数据用于缓存。什么意思呢我举一个很常见的场景比如用户在点击某个站点的首页时一般都会展现出首页的一些信息而这些信息基本上或者大部分时间都保持不变但这些信息都是来自数据库。如果用户的每次点击都要从数据库中去获取数据的话用户量少还可以接受如果用户量非常大的话这对数据库也是一笔很大的开销。针对这种首页数据如果大部分都不常更新的话我们完全可以把它们缓存起来每次用户点击的时候我们都直接从缓存中拿这样既可以提高首页的访问速度又可以降低服务器的压力。如果做得更加灵活一点可以再加个定时器定期的来更新这个首页缓存。就类似与 CSDN 个人博客首页中排名的变化一样。2.2 编码下面我们针对这个功能来写一个 Demo。在实际中读者可以完全套用该代码来实现自己项目中的相关逻辑。首先写一个 Service模拟一下从数据库查询数据publicinterfaceUserService{publicUsergetUser();}具体实现类ServicepublicclassUserServiceImplimplementsUserService{ResourceprivateApplicationContextapplicationContext;OverridepublicUsergetUser(){returnnewUser(1L,wno704,方法测试);}}然后写一个监听器实现 ApplicationListener 接口重写 onApplicationEvent 方法将 ContextRefreshedEvent 对象传进去。如果我们想在加载或刷新应用上下文时也重新刷新下我们预加载的资源就可以通过监听 ContextRefreshedEvent 来做这样的事情。代码如下ComponentpublicclassMyServletContextListenerimplementsApplicationListenerContextRefreshedEvent{OverridepublicvoidonApplicationEvent(ContextRefreshedEventevent){// 先获取到 application 上下文ApplicationContextapplicationContextevent.getApplicationContext();// 获取对应的 serviceUserServiceuserServiceapplicationContext.getBean(UserService.class);UseruseruserService.getUser();// 获取 application 域对象将查到的信息放到 application 域中ServletContextapplicationapplicationContext.getBean(ServletContext.class);application.setAttribute(user,user);}}正如注释中描述的那样首先通过 contextRefreshedEvent 来获取 Application 上下文再通过 Application 上下文获取 UserService 这个 Bean项目中可以根据实际业务场景也可以获取其他的 Bean然后再调用自己的业务代码获取相应的数据最后存储到 Application 域中这样前端在请求相应数据的时候我们就可以直接从 Application 域中获取信息减少数据库的压力。2.3 测试下面写一个 Controller 直接从 Application 域中获取 user 信息来测试一下。RestControllerRequestMapping(/listener)publicclassTestController{GetMapping(/user)publicUsergetUser(HttpServletRequestrequest){ServletContextapplicationrequest.getServletContext();return(User)application.getAttribute(user);}}启动项目在浏览器中输入http://localhost:8080/listener/user测试一下即可如果正常返回 user 信息那么说明数据已经缓存成功。不过 Application 是缓存在内存中对内存会有消耗实际中会把这部分信息存放在Redis缓存中。三、监听 HTTP 会话 Session 对象3.1 介绍监听器还有一个比较常用的地方就是用来监听 Session 对象以获取在线用户数量。现在很多开发者都有自己的网站监听 Session 来获取当前眼下用户数量是个很常见的使用场景。下面介绍下如何使用。3.2 编码ComponentSlf4jpublicclassMyHttpSessionListenerimplementsHttpSessionListener{/** * 记录在线的用户数量 */publicIntegercount0;OverridepublicsynchronizedvoidsessionCreated(HttpSessionEventhttpSessionEvent){log.info(新用户上线了);count;httpSessionEvent.getSession().getServletContext().setAttribute(count,count);}OverridepublicsynchronizedvoidsessionDestroyed(HttpSessionEventhttpSessionEvent){log.info(用户下线了);count--;httpSessionEvent.getSession().getServletContext().setAttribute(count,count);}}可以看出首先该监听器需要实现 HttpSessionListener 接口然后重写 sessionCreated 和 sessionDestroyed 方法在 sessionCreated 方法中传递一个 HttpSessionEvent 对象之后将当前 Session 中的用户数量加 1sessionDestroyed 方法刚好相反不再赘述。3.3 测试接下来我们写一个 Controller 测试一下。RestControllerRequestMapping(/listener)publicclassTestController{/** * 获取当前在线人数该方法有bug * param request * return */GetMapping(/total)publicStringgetTotalUser(HttpServletRequestrequest){Integercount(Integer)request.getSession().getServletContext().getAttribute(count);return当前在线人数count;}}该 Controller 直接获取当前 Session 中的用户数量启动服务器在浏览器中输入http://localhost:8080/listener/total 可以看到返回的结果是 1。再打开一个浏览器请求相同的地址可以看到 count 是 2这没有问题。但是如果关闭一个浏览器再打开理论上应该还是 2但是实际测试却是 3。原因是 Session 销毁的方法没有执行可以在后台控制台观察日志打印情况当重新打开时服务器找不到用户原来的 Session于是又重新创建了一个 Session那怎么解决该问题呢我们可以将上面的 Controller 方法改造一下GetMapping(/total2)publicStringgetTotalUser(HttpServletRequestrequest,HttpServletResponseresponse){Cookiecookie;try{// 把 sessionId 记录在浏览器中cookienewCookie(JSESSIONID,URLEncoder.encode(request.getSession().getId(),utf-8));cookie.setPath(/);//设置 cookie 有效期为 2 天设置长一点cookie.setMaxAge(48*60*60);response.addCookie(cookie);}catch(UnsupportedEncodingExceptione){e.printStackTrace();}Integercount(Integer)request.getSession().getServletContext().getAttribute(count);return当前在线人数count;}可以看出该处理逻辑是让服务器记得原来那个 Session即把原来的 sessionId 记录在浏览器中下次再打开时把这个 sessionId 传过去这样服务器就不会重新再创建了。重启一下服务器在浏览器中再次测试一下即可避免上面的问题。四、监听客户端请求 Servlet Request 对象4.1 介绍使用监听器获取用户的访问信息比较简单实现 ServletRequestListener 接口即可然后通过 Request 对象获取一些信息。4.2 编码ComponentSlf4jpublicclassMyServletRequestListenerimplementsServletRequestListener{OverridepublicvoidrequestInitialized(ServletRequestEventservletRequestEvent){HttpServletRequestrequest(HttpServletRequest)servletRequestEvent.getServletRequest();log.info(session id为{},request.getRequestedSessionId());log.info(request url为{},request.getRequestURL());request.setAttribute(name,wno704);}OverridepublicvoidrequestDestroyed(ServletRequestEventservletRequestEvent){log.info(request end);HttpServletRequestrequest(HttpServletRequest)servletRequestEvent.getServletRequest();log.info(request域中保存的name值为{},request.getAttribute(name));}}4.3 测试编写一个controller测试GetMapping(/request)publicStringgetRequestInfo(HttpServletRequestrequest){System.out.println(requestListener中的初始化的name数据request.getAttribute(name));returnsuccess;}然后访问http://localhost:8080/listener/request五、自定义监听器5.1 编写监听器publicclassListenerTestimplementsServletContextListener{OverridepublicvoidcontextInitialized(ServletContextEventsce){System.out.println(监听器初始化...);}OverridepublicvoidcontextDestroyed(ServletContextEventsce){System.out.println(监听器销毁...);}}5.2 注册监听器注册监听器为 Bean在 WebConfig 配置类中添加如下代码ConfigurationpublicclassWebConfig{BeanpublicServletListenerRegistrationBeanListenerTestservletListenerRegistrationBean(){returnnewServletListenerRegistrationBeanListenerTest(newListenerTest());}}5.3 测试当启动或者关闭容器时结果如下