Spring Boot 中使用监听器

Spring Boot中使用监听器

监听器（Listener）

Web监听器是一种 Servlet 中特殊的类，它们能帮助开发者监听 web 中特定的事件，比如 ServletContext, HttpSession, ServletRequest 的创建和销毁；变量的创建、销毁和修改等。可以在某些动作前后增加处理，实现监控。

监听器分类

1. 监听域对象自身的创建和销毁的事件监听器
2. 监听域对象中的属性的增加和删除的事件监听器
3. 监听绑定到 HttpSession 域中的某个对象的状态的事件监听器

常用监听器

1. ServletContextListener
2. HttpSessionListener
3. ServletRequestListener

Spring Boot中监听器的使用

使用场景:

​ Web监听器的使用场景很多，比如监听 servlet 上下文用来初始化一些数据、监听httpSession用来获
取当前在线的人数、监听客户端请求的servletRequest 对象来获取用户的访问信息等等。

1. 监听Servlet上下文对象

   监听 servlet 上下文对象常见场景可以用来初始化数据，用于缓存大多时候不会发生变化的数据。

   核心实现：

   • 监听器中将经常不会发生更改的数据，初始化数据到 Application 对象域中。

   /**
   * 使用ApplicationListener初始化一些数据到application对象域中的监听器
   * 实现 ApplicationListener<ContextRefreshedEvent> 接口，重写 onApplicationEvent 方法
   */
   @Component
   public class MyServletContextListener implements ApplicationListener<ContextRefreshedEvent> {
       
   	@Override
   	public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent){
       // 1、先获取到application上下文
       ApplicationContext applicationContext =
       contextRefreshedEvent.getApplicationContext();
       // 2、获取对应的service
       UserService userService = applicationContext.getBean(UserService.class);
       User user = userService.getUser();
       // 3、获取application域对象，将查到的信息放到application域中
       ServletContext application =
       applicationContext.getBean(ServletContext.class);
       application.setAttribute("user", user);
       }
   }
   

   • 首先通过 contextRefreshedEvent 来获取application 上下文，再通过 application 上下文来获取 UserService 这个 bean。代码如下：

   @RestController
   @RequestMapping("/listener")
   public class TestController {
       @GetMapping("/user")
       public User getUser(HttpServletRequest request) {
           ServletContext application = request.getServletContext();
           return (User) application.getAttribute("user");
       }
   }
   

   *Point：application对象存在于内存中，如此操作对内存是一种消耗，可以选择将用户信息等存放于Redis缓存中。

2. 监听HTTP会话 Session对象（常用使用场景：监听在线人数。）

   ​ 需要实现 HttpSessionListener 接口，然后重写 sessionCreated 和 sessionDestroyed 方法，在 sessionCreated 方法中传递一个 HttpSessionEvent 对象，然后将当前 session 中的用户数量加1， sessionDestroyed 方法刚好相反。

   /**
   * 使用HttpSessionListener统计在线用户数的监听器
   */
   @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);
       }
   }
   

   ​ 获取：

   @GetMapping("/total")
   public String getTotalUser(HttpServletRequest request) {
       Integer count = (Integer)
       request.getSession().getServletContext().getAttribute("count");
       return "当前在线人数：" + count;
   }
   

3. 监听客户端请求Servlet Request对象

   ​ 主要通过实现ServletRequestListener接口，重写requestInitialized和requestDestroyed方法即可。获取直接通过调用HttpServletRequest 的getAttribute("xxx")。

自定义事件监听器

• 自定义事件（需要继承ApplicationEvent）。

/**
* 自定义事件
*/
public class MyEvent extends ApplicationEvent {
    private User user;
    public MyEvent(Object source, User user) {
    super(source);
    this.user = user;
    }
	// 省去get、set方法	
}

• 自定义监听器（需要实现ApplicationListener接口)

/**
* 自定义监听器，监听MyEvent事件
*/
@Component
public class MyEventListener implements ApplicationListener<MyEvent> {
    @Override
    public void onApplicationEvent(MyEvent myEvent) {
        // 把事件中的信息获取到
        User user = myEvent.getUser();
        // 处理事件，实际项目中可以通知别的微服务或者处理其他逻辑等等
        System.out.println("用户名：" + user.getUsername());
        System.out.println("密码：" + user.getPassword());
    }
}

• 触发

/**
* UserService
*/
@Service
public class UserService {
    @Resource
    private ApplicationContext applicationContext;
    /**
    * 发布事件
    */
	public User getUser() {
    User user = new User(1L, "白白", "123456");
    // 发布事件
    MyEvent event = new MyEvent(this, user);
    applicationContext.publishEvent(event);
    return user;
    }
}

• 测试

@GetMapping("/request")
public String getRequestInfo(HttpServletRequest request) {
    System.out.println("requestListener中初始化的name数据：" +
    request.getAttribute("name"));
    return "success";
}

关于生命周期

request

​ 是一个请求，当一个响应返回时，即被销毁，当发送一个请求时被创建。

session

​ 当第一次访问 web 应用的一个 JSP 或 Servlet 时，且该 JSP 或 Servlet 中还需要创建 session 对象，此时服务器会创建一个 session 对象

session 销毁的几种情况：

1、session 过期

2、直接调用 session 的 invalidate 方法

3、当前 web 应用被卸载（session 可以被持久化）

注意，关闭浏览器并不意味着 session 被销毁，还可以通过 sessionid 找到服务器中的 session 对象，当访问地址带上之前做创建的 sessionid，依然不会创建新的 session 对象。

JSESSIONID=XXXXXXXX

http://localhost:8080/test.jsp;jsessionid=XXXXXXXX

application

​ 贯穿于当前的 WEB 应用的生命周期，当前 WEB 应用被加载时创建 application 对象，当前 WEB 应用被卸载时销毁 application 对象。