spring-session(一)揭秘续篇
上一篇文章中介绍了Spring-Session的核心原理,Filter,Session,Repository等等,传送门:spring-session(一)揭秘。
这篇继上一篇的原理逐渐深入Spring-Session中的事件机制原理的探索。众所周知,Servlet规范中有对HttpSession的事件的处理,如:HttpSessionEvent/HttpSessionIdListener/HttpSessionListener,可以查看Package javax.servlet
在Spring-Session中也有相应的Session事件机制实现,包括Session创建/过期/删除事件。
本文主要从以下方面探索Spring-Session中事件机制
- Session事件的抽象
- 事件的触发机制
Note:
这里的事件触发机制只介绍基于RedissSession的实现。基于内存Map实现的MapSession不支持Session事件机制。其他的Session实现这里也不做关注。
一.Session事件的抽象
先来看下Session事件抽象UML类图,整体掌握事件之间的依赖关系。
Session Event最顶层是ApplicationEvent,即Spring上下文事件对象。由此可以看出Spring-Session的事件机制是基于Spring上下文事件实现。
抽象的AbstractSessionEvent事件对象提供了获取Session(这里的是指Spring Session的对象)和SessionId。
基于事件的类型,分类为:
- Session创建事件
- Session删除事件
- Session过期事件
Tips:
Session销毁事件只是删除和过期事件的统一,并无实际含义。
事件对象只是对事件本身的抽象,描述事件的属性,如:
- 获取事件产生的源:getSource获取事件产生源
- 获取相应事件特性:getSession/getSessoinId获取时间关联的Session
下面再深入探索以上的Session事件是如何触发,从事件源到事件监听器的链路分析事件流转过程。
二.事件的触发机制
阅读本节前,读者应该了解Redis的Pub/Sub和KeySpace Notification,如果还不是很了解,传送门Redis Keyspace Notifications和Pub/Sub。
上节中也介绍Session Event事件基于Spring的ApplicationEvent实现。先简单认识spring上下文事件机制:
- ApplicationEventPublisher实现用于发布Spring上下文事件ApplicationEvent
- ApplicationListener实现用于监听Spring上下文事件ApplicationEvent
- ApplicationEvent抽象上下文事件
那么在Spring-Session中必然包含事件发布者ApplicationEventPublisher发布Session事件和ApplicationListener监听Session事件。
可以看出ApplicationEventPublisher发布一个事件:
@FunctionalInterface
public interface ApplicationEventPublisher {/*** Notify all <strong>matching</strong> listeners registered with this* application of an application event. Events may be framework events* (such as RequestHandledEvent) or application-specific events.* @param event the event to publish* @see org.springframework.web.context.support.RequestHandledEvent*/default void publishEvent(ApplicationEvent event) {publishEvent((Object) event);}/*** Notify all <strong>matching</strong> listeners registered with this* application of an event.* <p>If the specified {@code event} is not an {@link ApplicationEvent},* it is wrapped in a {@link PayloadApplicationEvent}.* @param event the event to publish* @since 4.2* @see PayloadApplicationEvent*/void publishEvent(Object event);}
ApplicationListener用于监听相应的事件:
@FunctionalInterface
public interface ApplicationListener<E extends ApplicationEvent> extends EventListener {/*** Handle an application event.* @param event the event to respond to*/void onApplicationEvent(E event);}
Tips:
这里使用到了发布/订阅模式,事件监听器可以监听感兴趣的事件,发布者可以发布各种事件。不过这是内部的发布订阅,即观察者模式。
Session事件的流程实现如下:
上图展示了Spring-Session事件流程图,事件源来自于Redis键空间通知,在spring-data-redis项目中抽象MessageListener监听Redis事件源,然后将其传播至spring应用上下文发布者,由发布者发布事件。在spring上下文中的监听器Listener即可监听到Session事件。
因为两者是Spring框架提供的对Spring的ApplicationEvent的支持。Session Event基于ApplicationEvent实现,必然也有其相应发布者和监听器的的实现。
Spring-Session中的RedisSession的SessionRepository是RedisOperationSessionRepository。所有关于RedisSession的管理操作都是由其实现,所以Session的产生源是RedisOperationSessionRepository。
在RedisOperationSessionRepository中持有ApplicationEventPublisher对象用于发布Session事件。
private ApplicationEventPublisher eventPublisher = new ApplicationEventPublisher() {@Overridepublic void publishEvent(ApplicationEvent event) {}@Overridepublic void publishEvent(Object event) {}
};
但是该ApplicationEventPublisher是空实现,实际实现是在应用启动时由Spring-Session自动配置。在spring-session-data-redis模块中RedisHttpSessionConfiguration中有关于创建RedisOperationSessionRepository Bean时将调用set方法将ApplicationEventPublisher配置。
@Configuration
@EnableScheduling
public class RedisHttpSessionConfiguration extends SpringHttpSessionConfigurationimplements BeanClassLoaderAware, EmbeddedValueResolverAware, ImportAware,SchedulingConfigurer {private ApplicationEventPublisher applicationEventPublisher;@Beanpublic RedisOperationsSessionRepository sessionRepository() {RedisTemplate<Object, Object> redisTemplate = createRedisTemplate();RedisOperationsSessionRepository sessionRepository = new RedisOperationsSessionRepository(redisTemplate);// 注入依赖sessionRepository.setApplicationEventPublisher(this.applicationEventPublisher);if (this.defaultRedisSerializer != null) {sessionRepository.setDefaultSerializer(this.defaultRedisSerializer);}sessionRepository.setDefaultMaxInactiveInterval(this.maxInactiveIntervalInSeconds);if (StringUtils.hasText(this.redisNamespace)) {sessionRepository.setRedisKeyNamespace(this.redisNamespace);}sessionRepository.setRedisFlushMode(this.redisFlushMode);return sessionRepository;}// 注入上下文中的ApplicationEventPublisher Bean@Autowiredpublic void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {this.applicationEventPublisher = applicationEventPublisher;}}
在进行自动配置时,将上下文中的ApplicationEventPublisher的注入,实际上即ApplicationContext对象。
Note:
考虑篇幅原因,以上的RedisHttpSessionConfiguration至展示片段。
对于ApplicationListener是由应用开发者自行实现,注册成Bean即可。当有Session Event发布时,即可监听。
/*** session事件监听器** @author huaijin*/
@Component
public class SessionEventListener implements ApplicationListener<SessionDeletedEvent> {private static final String CURRENT_USER = "currentUser";@Overridepublic void onApplicationEvent(SessionDeletedEvent event) {Session session = event.getSession();UserVo userVo = session.getAttribute(CURRENT_USER);System.out.println("Current session's user:" + userVo.toString());}
}
以上部分探索了Session事件的发布者和监听者,但是核心事件的触发发布则是由Redis的键空间通知机制触发,当有Session创建/删除/过期时,Redis键空间会通知Spring-Session应用。
RedisOperationsSessionRepository实现spring-data-redis中的MessageListener接口。
/*** Listener of messages published in Redis.** @author Costin Leau* @author Christoph Strobl*/
public interface MessageListener {/*** Callback for processing received objects through Redis.** @param message message must not be {@literal null}.* @param pattern pattern matching the channel (if specified) - can be {@literal null}.*/void onMessage(Message message, @Nullable byte[] pattern);
}
该监听器即用来监听redis发布的消息。RedisOperationsSessionRepositorys实现了该Redis键空间消息通知监听器接口,实现如下:
public class RedisOperationsSessionRepository implementsFindByIndexNameSessionRepository<RedisOperationsSessionRepository.RedisSession>,MessageListener {@Override@SuppressWarnings("unchecked")public void onMessage(Message message, byte[] pattern) {// 获取该消息发布的redis通道channelbyte[] messageChannel = message.getChannel();// 获取消息体内容byte[] messageBody = message.getBody();String channel = new String(messageChannel);// 如果是由Session创建通道发布的消息,则是Session创建事件if (channel.startsWith(getSessionCreatedChannelPrefix())) {// 从消息体中载入SessionMap<Object, Object> loaded = (Map<Object, Object>) this.defaultSerializer.deserialize(message.getBody());// 发布创建事件handleCreated(loaded, channel);return;}// 如果消息体不是以过期键前缀,直接返回。因为spring-session在redis中的key命名规则:// "${namespace}:sessions:expires:${sessionId}",如:// session.example:sessions:expires:a5236a19-7325-4783-b1f0-db9d4442db9a// 所以判断过期或者删除的键是否为spring-session的过期键。如果不是,可能是应用中其他的键的操作,所以直接returnString body = new String(messageBody);if (!body.startsWith(getExpiredKeyPrefix())) {return;}// 根据channel判断键空间的事件类型del或者expire时间boolean isDeleted = channel.endsWith(":del");if (isDeleted || channel.endsWith(":expired")) {int beginIndex = body.lastIndexOf(":") + 1;int endIndex = body.length();// Redis键空间消息通知内容即操作的键,spring-session键中命名规则:// "${namespace}:sessions:expires:${sessionId}",以下是根据规则解析sessionIdString sessionId = body.substring(beginIndex, endIndex);// 根据sessionId加载sessionRedisSession session = getSession(sessionId, true);if (session == null) {logger.warn("Unable to publish SessionDestroyedEvent for session "+ sessionId);return;}if (logger.isDebugEnabled()) {logger.debug("Publishing SessionDestroyedEvent for session " + sessionId);}cleanupPrincipalIndex(session);// 发布Session delete事件if (isDeleted) {handleDeleted(session);}else {// 否则发布Session expire事件handleExpired(session);}}}
}
下续再深入每种事件产生的前世今生。
1.Session创建事件的触发
- 由RedisOperationSessionRepository向Redis指定通道${namespace}:event:created:${sessionId}发布一个message
- MessageListener的实现RedisOperationSessionRepository监听到Redis指定通道${namespace}:event:created:${sessionId}的消息
- 将其传播至ApplicationEventPublisher
- ApplicationEventPublisher发布SessionCreateEvent
- ApplicationListener监听SessionCreateEvent,执行相应逻辑
RedisOperationSessionRepository中保存一个Session时,判断Session是否新创建。
如果新创建,则向
@Override
public void save(RedisSession session) {session.saveDelta();// 判断是否为新创建的sessionif (session.isNew()) {// 获取redis指定的channel:${namespace}:event:created:${sessionId},// 如:session.example:event:created:82sdd-4123-o244-ps123String sessionCreatedKey = getSessionCreatedChannel(session.getId());// 向该通道发布session数据this.sessionRedisOperations.convertAndSend(sessionCreatedKey, session.delta);// 设置session为非新创建session.setNew(false);}
}
该save方法的调用是由HttpServletResponse提交时——即返回客户端响应调用,上篇文章已经详解,这里不再赘述。关于RedisOperationSessionRepository实现MessageListener上述已经介绍,这里同样不再赘述。
Note:
这里有点绕。个人认为RedisOperationSessionRepository发布创建然后再本身监听,主要是考虑分布式或者集群环境中SessionCreateEvent事件的处理。
2.Session删除事件的触发
Tips:
删除事件中使用到了Redis KeySpace Notification,建议先了解该技术。
- 由RedisOperationSessionRepository删除Redis键空间中的指定Session的过期键,Redis键空间会向**__keyevent@*:del**的channel发布删除事件消息
- MessageListener的实现RedisOperationSessionRepository监听到Redis指定通道**__keyevent@*:del**的消息
- 将其传播至ApplicationEventPublisher
- ApplicationEventPublisher发布SessionDeleteEvent
- ApplicationListener监听SessionDeleteEvent,执行相应逻辑
当调用HttpSession的invalidate方法让Session失效时,即会调用RedisOperationSessionRepository的deleteById方法删除Session的过期键。
/*** Allows creating an HttpSession from a Session instance.** @author Rob Winch* @since 1.0*/
private final class HttpSessionWrapper extends HttpSessionAdapter<S> {HttpSessionWrapper(S session, ServletContext servletContext) {super(session, servletContext);}@Overridepublic void invalidate() {super.invalidate();SessionRepositoryRequestWrapper.this.requestedSessionInvalidated = true;setCurrentSession(null);clearRequestedSessionCache();// 调用删除方法SessionRepositoryFilter.this.sessionRepository.deleteById(getId());}
}
上篇中介绍了包装Spring Session为HttpSession,这里不再赘述。这里重点分析deleteById内容:
@Override
public void deleteById(String sessionId) {// 如果session为空则返回RedisSession session = getSession(sessionId, true);if (session == null) {return;}cleanupPrincipalIndex(session);this.expirationPolicy.onDelete(session);// 获取session的过期键String expireKey = getExpiredKey(session.getId());// 删除过期键,redis键空间产生del事件消息,被MessageListener即// RedisOperationSessionRepository监听this.sessionRedisOperations.delete(expireKey);session.setMaxInactiveInterval(Duration.ZERO);save(session);
}
后续流程同SessionCreateEvent流程。
3.Session失效事件的触发
Session的过期事件流程比较特殊,因为Redis的键空间通知的特殊性,Redis键空间通知不能保证过期键的通知的及时性。
- RedisOperationsSessionRepository中有个定时任务方法每整分运行访问整分Session过期键集合中的过期sessionId,如:spring:session:expirations:1439245080000。触发Redis键空间会向**__keyevent@*:expired**的channel发布过期事件消息
- MessageListener的实现RedisOperationSessionRepository监听到Redis指定通道**__keyevent@*:expired**的消息
- 将其传播至ApplicationEventPublisher
- ApplicationEventPublisher发布SessionDeleteEvent
- ApplicationListener监听SessionDeleteEvent,执行相应逻辑
@Scheduled(cron = "0 * * * * *")
public void cleanupExpiredSessions() {this.expirationPolicy.cleanExpiredSessions();
}
定时任务每整分运行,执行cleanExpiredSessions方法。expirationPolicy是RedisSessionExpirationPolicy实例,是RedisSession过期策略。
public void cleanExpiredSessions() {// 获取当前时间戳long now = System.currentTimeMillis();// 时间滚动至整分,去掉秒和毫秒部分long prevMin = roundDownMinute(now);if (logger.isDebugEnabled()) {logger.debug("Cleaning up sessions expiring at " + new Date(prevMin));}// 根据整分时间获取过期键集合,如:spring:session:expirations:1439245080000String expirationKey = getExpirationKey(prevMin);// 获取所有的所有的过期sessionSet<Object> sessionsToExpire = this.redis.boundSetOps(expirationKey).members();// 删除过期Session键集合this.redis.delete(expirationKey);// touch访问所有已经过期的session,触发Redis键空间通知消息for (Object session : sessionsToExpire) {String sessionKey = getSessionKey((String) session);touch(sessionKey);}
}
将时间戳滚动至整分
static long roundDownMinute(long timeInMs) {Calendar date = Calendar.getInstance();date.setTimeInMillis(timeInMs);// 清理时间错的秒位和毫秒位date.clear(Calendar.SECOND);date.clear(Calendar.MILLISECOND);return date.getTimeInMillis();
}
获取过期Session的集合
String getExpirationKey(long expires) {return this.redisSession.getExpirationsKey(expires);
}// 如:spring:session:expirations:1439245080000
String getExpirationsKey(long expiration) {return this.keyPrefix + "expirations:" + expiration;
}
调用Redis的Exists命令,访问过期Session键,触发Redis键空间消息
/*** By trying to access the session we only trigger a deletion if it the TTL is* expired. This is done to handle* https://github.com/spring-projects/spring-session/issues/93** @param key the key*/
private void touch(String key) {this.redis.hasKey(key);
}
总结
至此Spring-Session的Session事件通知模块就已经很清晰:
- Redis键空间Session事件源:Session创建通道/Session删除通道/Session过期通道
- Spring-Session中的RedisOperationsSessionRepository消息监听器监听Redis的事件类型
- RedisOperationsSessionRepository负责将其传播至ApplicationEventPublisher
- ApplicationEventPublisher将其包装成ApplicationEvent类型的Session Event发布
- ApplicationListener监听Session Event,处理相应逻辑
转载于:https://www.cnblogs.com/lxyit/p/9719542.html
spring-session(一)揭秘续篇相关推荐
- 170222、使用Spring Session和Redis解决分布式Session跨域共享问题
使用Spring Session和Redis解决分布式Session跨域共享问题 原创 2017-02-27 徐刘根 Java后端技术 前言 对于分布式使用Nginx+Tomcat实现负载均衡,最常用 ...
- 在SpringBoot中使用Spring Session解决分布式会话共享问题
在SpringBoot中使用Spring Session解决分布式会话共享问题 问题描述: 每次当重启服务器时,都会导致会员平台中已登录的用户掉线.这是因为每个用户的会话信息及状态都是由session ...
- session传递参数_分布式 Session 之 Spring Session 架构与设计
作者 | 李增光 杏仁后端工程师.「只有变秃,才能变强!」 前言 开始进行 Web 开发时,我们可能会遇到这样的情况,当服务器重启之后,之前的登录状态会失效需要重新登录.又或者你的应用程序部署了不止 ...
- 在spring MVC项目中集成Spring session redis (使用spring session框架,redis作为存储缓存)...
2019独角兽企业重金招聘Python工程师标准>>> 1.为项目增加以来 pom.xml中使用 <!-- spring session 单点登录 --> //本项目使 ...
- spring session 退出登录 清理session
2019独角兽企业重金招聘Python工程师标准>>> spring session 退出登录 清理session 博客分类: spring /*** Allows creating ...
- Spring MVC集成Spring Data Reids和Spring Session实现Session共享
说明:Spring MVC中集成Spring Data Redis和Spring Session时版本是一个坑点,比如最新版本的Spring Data Redis已经不包含Jedis了,需要自行引入. ...
- [译]Spring Session 与 Spring Security
原文:http://docs.spring.io/spring-session/docs/current-SNAPSHOT/reference/html5/guides/security.html 本 ...
- 利用spring session解决共享Session问题
https://blog.csdn.net/patrickyoung6625/article/details/45694157 1.共享Session问题 HttpSession是通过Servlet容 ...
- Spring Session - 源码解读
文章目录 Spring Session 流程图 源码分析 Spring Session 流程图 Spring Session 主要是利用过滤器,偷梁换柱,实现session储存无感知的切换. 源码分析 ...
- Spring Session - 使用Spring Session从零到一构建分布式session
文章目录 快速入门 Spring Session + Redis 官网指导 Demo pom 依赖 配置文件 配置类RedisHttpSessionConfiguration Redis中的sessi ...
最新文章
- Powerdesigner 需求分析(RQM)
- Living in the Matrix with Bytecode Manipulation--转
- [ZT]国家颁布防沉迷系统 网游三小时后经验减半
- AI 人工智能与半导体论坛:
- python3设置编码背景颜色_在pythongtk3中设置条目背景颜色并设置回defau的最佳方法...
- 星巴克“猫爪杯”遭国人疯抢 而 “大白兔冰淇淋”在美国大火
- paip.FTP服务架设选型
- Android反编译工具总结
- WPS Excel 模板设置与生成
- PMP-强化练习题一(180题答案及解析)
- 今日头条小程序是什么
- 手机流量怎么修改dns服务器,手机上网速度慢怎么办?手动修改DNS为上网提速
- 中国显示器粘合胶市场趋势报告、技术动态创新及市场预测
- J2EE开发全程实录
- KOOCAN非正常电影排行榜之这个丧尸不太冷
- 2021 国内外 IoT 物联网平台汇总
- 前端性能优化:1.什么是前端性能优化
- 5.2 网络数据Excel存储
- git版本回退简单记录
- 2<<3是什么意思?
热门文章
- Java基础---Java---IO流-----File 类、递归、删除一个带内容的目录、列出指定目录下文件夹、FilenameFilte
- 前大灯是近光灯还是远光灯_夜间上高速使用近光灯?不会开车就别开,否则12分都不够扣!...
- 冒泡排序面向对象java_冒泡排序
- dd命令打包多个文件_Android shell 下dd命令浅析
- python render_python:玫瑰图展示2020年1-3月轿车销量前十及占比(pyecharts)
- pid调节软件_三面大疆惨败,因为不懂PID的积分抗饱和
- cmd怎么导入mysql文件,使用cmd工具如何导入大容量sql文件到mysql数据库
- java基本操作-2
- scrapy Pipline保存到数据库
- 帆软填报Execl表格不定行导入