Spring Boot中使用监听器

时间:2022-10-11 09:07:51 类型:JAVA
字号:    
  1.  什么是 web 监听器?web 监听器是一种 Servlet 中特殊的类,它们能帮助开发者监听 web 中特定的事件,比如 ServletContext, HttpSession, ServletRequest 的创建和销毁;变量的创建、销毁和修改等。可以在某些动作前后增加处理,实现监控。

  2. Spring Boot中监听器的使用

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


    2.1 监听Servlet上下文对象

        监听 servlet 上下文对象可以用来初始化数据,用于缓存。什么意思呢?

        比如用户在点击某个站点的首页时,一般都会展现出首页的一些信息,而这些信息基本上或者大部分时间都保持不变的,但是这些信息都是来自数据库。如果用户的每次点击,都要从数据库中去获取数据的话,用户量少还可以接受,如果用户量非常大的话,这对数据库也是一笔很大的开销。针对这种首页数据,大部分都不常更新的话,我们完全可以把它们缓存起来,每次用户点击的时候,我们都直接从缓存中拿,这样既可以提高首页的访问速度,又可以降低服务器的压力。如果做的更加灵活一点,可以再加个定时器,定期的来更新这个首页缓存。就类似与 CSDN 个人博客首页中排名的变化一样。

  针对这个功能,接下来我们写一个 demo,在实际中,大家可以完全套用该代码,来实现自己项目中的相关逻辑。首先写一个 Mapper,模拟一下从数据库查询数据:

@Repository
public interface UserMapper {
    public User getUserById(Integer id);
}

然后写一个监听器,实现 ApplicationListener接口,重写onApplicationEvent 方法,将 ContextRefreshedEvent 对象传进去。

如果我们想在加载或刷新应用上下文时,也重新刷新下我们预加载的资源,就可以通过监听 ContextRefreshedEvent 来做这样的事情。

如下:

/*使用ApplicationListener来初始化一些数据到application域中的监听器*/
@Component
public class MyServletContextListener implements
        ApplicationListener<ContextRefreshedEvent> {
    @Resource
    private UserMapper userMapper;
    @Override
    public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent)
    {
        // 先获取到application上下文
        ApplicationContext applicationContext = contextRefreshedEvent.getApplicationContext();
        // 获取对应的service
        UserService userService = applicationContext.getBean(UserService.class);
        User user = userMapper.getUserById(1);
        // 获取application域对象,将查到的信息放到application域中
        ServletContext application = applicationContext.getBean(ServletContext.class);
        application.setAttribute("user", user);
    }

}

  正如注释中描述的一样,首先通过 contextRefreshedEvent 来获取 application 上下文,再通过 application 上下文来获取 UserService 这个 bean,项目中可以根据实际业务场景,也可以获取其他的bean,然后再调用自己的业务代码获取相应的数据,最后存储到 application 域中,这样前端在请求相应数据的时候,我们就可以直接从 application 域中获取信息,减少数据库的压力。下面写一个Controller 直接从 application 域中获取 user 信息来测试一下。

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

}

通过PostMan访问如下:

1.jpg

  说明数据已经缓存成功

然后,直接在数据库修改用户名,密码, 再次访问,得到的依然是之前的结果, 证明没有再次访问数据库,用的是之前 缓存内存中的数据

  监听HTTP会话 Session对象

  监听器还有一个比较常用的地方就是用来监听 session 对象,来获取在线用户数量,现在有很多开发者都有自己的网站,监听 session 来获取当前在下用户数量是个很常见的使用场景,下面来介绍一下如何来使用。

  问题:

  访问HTML是否创建Session?:不会。

  访问JSP是否创建Session? :会

  访问Servlet是否创建Session?:不会(默认没有调用getSession方法)

        只有调用了getSession方法,才会创建Session, 触发sessionCreated方法

@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) {
                                //Notification that a session was created.
        logger.info("新用户上线了");
        count++;
        httpSessionEvent.getSession().getServletContext().setAttribute("count", count);
    }
    @Override
    public synchronized void sessionDestroyed(HttpSessionEvent httpSessionEvent)
    {                            //Notification that a session is about to be invalidated.
        logger.info("用户下线了");
        count--;
        httpSessionEvent.getSession().getServletContext().setAttribute("count",
                count);
    }

}

  可以看出,首先该监听器需要实现 HttpSessionListener 接口,然后重写 sessionCreated 和 sessionDestroyed 方法,在 sessionCreated 方法中传递一个 HttpSessionEvent 对象,然后将当  前 session 中的用户数量加1, sessionDestroyed 方法刚好相反,不再赘述。然后我们写一个 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;
    }

  监听客户端请求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", "庄子");
        }
        @Override
        public void requestDestroyed(ServletRequestEvent servletRequestEvent) {
            logger.info("request end");
            HttpServletRequest request = (HttpServletRequest)
                    servletRequestEvent.getServletRequest();
            logger.info("request域中保存的name值为:{}", request.getAttribute("name"));
        }
}

接下来写一个 Controller 测试一下即可。

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

其实访问任意的控制器都会触发ServletRequestListener监听事件

<