Spring Boot中使用监听器
什么是 web 监听器?web 监听器是一种 Servlet 中特殊的类,它们能帮助开发者监听 web 中特定的事 件,比如ServletContext, HttpSession, ServletRequest 的创建和销毁;变量的创建、销毁和修改等。 可以在某些动作前后增加处理,实现监控。
1.Spring Boot中监听器的使用
2.1 监听Servlet上下文对象
监听 servlet 上下文对象可以用来初始化数据,用于缓存。什么意思呢?我举一个很常见的场景,比如 用户在点击某个站点的首页时,一般都会展现出首页的一些信息,而这些信息基本上或者大部分时间都 保持不变的,但是这些信息都是来自数据库。如果用户的每次点击,都要从数据库中去获取数据的话, 用户量少还可以接受,如果用户量非常大的话,这对数据库也是一笔很大的开销。
针对这种首页数据,大部分都不常更新的话,我们完全可以把它们缓存起来,每次用户点击的时候,我 们都直接从缓存中拿,这样既可以提高首页的访问速度,又可以降低服务器的压力。如果做的更加灵活 一点,可以再加个定时器,定期的来更新这个首页缓存。就类似与 优快云 个人博客首页中排名的变化一 样。
演示demo:
先写一个service,模拟数据库的查询
@Service public class UserService {
/**
* 获取用户信息
*
* * @return
* */
public User getUser() {
// 实际中会根据具体的业务场景,从数据库中查询对应的信息
return new User(1L, "coders", "123456");
}
}
然后写一个监听器,实现 ApplicationListener 接口,重写 onApplicationEvent 方法,将 ContextRefreshedEvent 对象传进去。如果我们想在加载或刷新应用 上下文时,也重新刷新下我们预加载的资源,就可以通过监听 ContextRefreshedEvent 来做这样的事 情。如下:
@Component
public class MyServletContextListener implements ApplicationListener<ContextRefreshedEvent> {
@Override
public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) {
// 先获取到application上下文
ApplicationContext applicationContext = contextRefreshedEvent.getApplicationContext();
// 获取对应的service
UserService userService = applicationContext.getBean(UserService.class);
User user = userService.getUser();
// 获取application域对象,将查到的信息放到application域中
ServletContext application = applicationContext.getBean(ServletContext.class);
application.setAttribute("user", user);
}
}
首先通过 contextRefreshedEvent 来获取 application 上下文,再通过 application 上下文来获取 UserService 这个 bean,项目中可以根据实际业务场景,也可以获取其他的 bean,然后再调用自己的业务代码获取相应的数据,后存储到 application 域中,这样前端在请求相 应数据的时候,我们就可以直接从 application 域中获取信息,减少数据库的压力。
测试验证:
@RestController @RequestMapping("/listener")
public class TestController {
@GetMapping("/user")
public User getUser(HttpServletRequest request) {
ServletContext application = request.getServletContext();
return (User) application.getAttribute("user");
}
}
启动项目,在浏览器中输入 http://localhost:8080/listener/user 测试一下即可,正常返回 user 信息,说明数据已经缓存成功。
2.2 监听HTTP会话 Session对象
监听器还有一个比较常用的地方就是用来监听 session 对象,来获取在线用户数量,现在有很多开发者 都有自己的网站,监听 session 来获取当前在下用户数量是个很常见的使用场景。
举例:
@Component public class MyHttpSessionListener implements HttpSessionListener {
private static final Logger logger = LoggerFactory.getLogger(MyHttpSessionListener.class);
public Integer count = 0;
@Override
public synchronized void sessionCreated(HttpSessionEvent httpSessionEvent) {
logger.info("新用户上线了");
count++;
httpSessionEvent.getSession().getServletContext().setAttribute("count", count);
}
@Override
public synchronized void sessionDestroyed(HttpSessionEvent httpSessionEvent) {
logger.info("用户下线了");
count--;
httpSessionEvent.getSession().getServletContext().setAttribute("count", count);
}
}
首先该监听器需要实现 HttpSessionListener 接口,然后重写 sessionCreated 和 sessionDestroyed 方法,在sessionCreated 方法中传递一个 HttpSessionEvent 对象,然后将当 前 session 中的用户数量加1, sessionDestroyed 方法刚好相反。
测试:
@RestController
@RequestMapping("/listener")
public class TestController {
/**
* 获取当前在线人数,该方法有bug
*
* @param request
* @return
* */
@GetMapping("/total")
public String getTotalUser(HttpServletRequest request) {
Integer count = (Integer) request.getSession().getServletContext().getAttribute("count");
return "当前在线人数:" + count;
}
}
该 Controller 中是直接获取当前 session 中的用户数量,启动服务器,在浏览器中输入 localhost:8080/listener/total 可以看到返回的结果是1,再打开一个浏览器,请求相同的地址可 以看到 count 是 2 ,这没有问题。但是如果关闭一个浏览器再打开,理论上应该还是2,但是实际测试 却是 3。原因是 session 销毁的方法没有执行(可以在后台控制台观察日志打印情况),当重新打开 时,服务器找不到用户原来的 session,于是又重新创建了一个 session,那怎么解决该问题呢?我们 可以将上面的 Controller 方法改造一下:
@GetMapping("/total2")
public String getTotalUser(HttpServletRequest request, HttpServletResponse response) {
Cookie cookie;
try {
// 把sessionId记录在浏览器中
cookie = new Cookie("JSESSIONID", URLEncoder.encode(request.getSession().getId(), "utf-8"));
cookie.setPath("/");
//设置cookie有效期为2天,设置长一点
cookie.setMaxAge( 48*60 * 60);
response.addCookie(cookie);
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
Integer count = (Integer) request.getSession().getServletContext().getAttribute("count");
return "当前在线人数:" + count;
}
该处理逻辑是让服务器记得原来那个 session,即把原来的 sessionId 记录在浏览器中,下 次再打开时,把这个 sessionId 传过去,这样服务器就不会重新再创建了。重启一下服务器,在浏览器 中再次测试一下,即可避免上面的问题。
2.3监听客户端请求Servlet Request对象
使用监听器获取用户的访问信息比较简单,实现ServletRequestListener 接口即可,然后通过 request 对象获取一些信息。如下:
@Component
public class MyServletRequestListener implements ServletRequestListener {
private static final Logger logger = LoggerFactory.getLogger(MyServletRequestListener.class);
@Override
public void requestInitialized(ServletRequestEvent servletRequestEvent) {
HttpServletRequest request = (HttpServletRequest) servletRequestEvent.getServletRequest();
logger.info("session id为:{}",
request.getRequestedSessionId());
logger.info("request url为:{}",
request.getRequestURL());
request.setAttribute("name", "coders"); }
@Override
public void requestDestroyed(ServletRequestEvent servletRequestEvent) {
logger.info("request end");
HttpServletRequest request = (HttpServletRequest) servletRequestEvent.getServletRequest();
logger.info("request域中保存的name值为:{}",
request.getAttribute("name"));
}
}
测试:
@GetMapping("/request")
public String getRequestInfo(HttpServletRequest request) {
System.out.println("requestListener中的初始化的name数据:" + request.getAttribute("name"));
return "success";
}
参考:武哥聊编程