浅谈Spring Session工作原理

浅谈Spring Session工作原理

目录1、引入背景2、使用方法3、工作流程4、缓存机制5、事件订阅6、总结

1、引入背景

HTTP协议本身是无状态的，为了保存会话信息，浏览器Cookie通过SessionID标识会话请求，服务器以SessionID为key来存储会话信息。在单实例应用中，可以考虑应用进程自身存储，随着应用体量的增长，需要横向扩容，多实例session共享问题随之而来。

应用部署在Tomcat时，session是由Tomcat内存维护，如果应用部署多个实例，session就不能共享。Spring Session就是解决为了解决分布式场景中的session共享问题。

2、使用方法

Spring Session支持存储在Hazelcast 、Redis、MongoDB、关系型数据库，本文主要讨论session存储在Redis。

web.xml配置：

springSessionRepositoryFilter

org.springframework.web.filter.DelegatingFilterProxy

springSessionRepositoryFilter

/*

Spring 主要配置：

p:poolConfig-ref="jedisPoolConfig"

3、工作流程

Tomcat web.xml解析步骤：

contextInitialized(ServletContextEvent arg0); // Listener

init(FilterConfig filterConfig); // Filter

init(ServletConfig config); // Servlet

初始化顺序：Listener > Filter > Servlet。

1) 通过 Tomcat 的 listener 把SessionRepositoryFilter加载到Spring容器中。

上一小节Spring配置文件里面声明了RedisHttpSessionConfiguration，正是在其父类SpringHttpSessionConfiguration中生成了SessionRepositoryFilter：

@Bean

public SessionRepositoryFilter extends ExpiringSession> springSessionRepositoryFilter(

SessionRepository sessionRepository) {

......

return sessionRepositoryFilter;

}

RedisHttpSessionConfiguration类继承关系

2) filter初始化

web.xml里面配置的filter是DelegatingFilterProxy。

DelegatingFilterProxy类继承关系

DelegatingFilterProxy初始化入口在其父类GenericFilterBean中：

public final void init(FilterConfig filterConfig) throws ServletException {

......

// Let subclasses do whatever initialization they like.

initFilterBean();

......

}

DelegatingFilterProxy去Spring容器取第1步初始化好的springSessionRepositoryFilter：

protected void initFilterBean() throws ServletException {

synchronized (this.delegateMonitor) {

if (this.delegate == null) {

// If no target bean name specified, use filter name.

if (this.targetBeanName == null) {

//targetBeanName 为springSessionRepositoryFilter

this.targetBeanName = getFilterName();

}

WebApplicationContext wac = findWebApplicationContext();

if (wac != null) {

this.delegate = initDelegate(wac);

}

}

}

}

至此 sessionRepositoryFilter 初始化完成，DelegatingFilterProxy 实际代理了SessionRepositoryFilter。

SessionRepositoryFilter 工作核心流程：

protected void doFilterInternal(HttpServletRequest request,

HttpServletResponse response, FilterChain filterChain)

throws ServletException, IOException {

request.setAttribute(SESSION_REPOSITORY_ATTR, this.sessionRepository);

//包装了HttpServletRequest，覆写了HttpServletRequest中 getSession(boolean create)方法

SessionRepositoryRequestWrapper wrappedRequest = new SessionRepositoryRequestWrapper(

request, response, this.servletContext);

......

try {

filterChain.doFilter(strategyRequest, strategyResponse);

}

finally {

//保证session持久化

wrappedRequest.commitSession();

}

}

4、缓存机制

每一个session，Redis实际缓存的数据如下：

spring:session:sessions:1b8b2340-da25-4ca6-864c-4af28f033327

spring:session:sessions:expires:1b8b2340-da25-4ca6-864c-4af28f033327

spring:session:expirations:1557389100000

spring:session:sessions为hash结构，存储Spring Session的主要内容：

hgetall spring:session:sessions:1b8b2340-da25-4ca6-864c-4af28f033327

 1) "creationTime"

 2) "\xac\xed\x00\x05sr\x00\x0ejava.lang.Long;\x8b\xe4\x90\xcc\x8f#\xdf\x02\x00\x01J\x00\x05valuexr\x00\x10java.lang.Number\x86\xac\x95\x1d\x0b\x94\xe0\x8b\x02\x00\x00xp\x00\x00\x01j\x9b\x83\x9d\xfd"

 3) "maxInactiveInterval"

 4) "\xac\xed\x00\x05sr\x00\x11java.lang.Integer\x12\xe2\xa0\xa4\xf7\x81\x878\x02\x00\x01I\x00\x05valuexr\x00\x10java.lang.Number\x86\xac\x95\x1d\x0b\x94\xe0\x8b\x02\x00\x00xp\x00\x00\a\b"

 5) "lastAccessedTime"

 6) "\xac\xed\x00\x05sr\x00\x0ejava.lang.Long;\x8b\xe4\x90\xcc\x8f#\xdf\x02\x00\x01J\x00\x05valuexr\x00\x10java.lang.Number\x86\xac\x95\x1d\x0b\x94\xe0\x8b\x02\x00\x00xp\x00\x00\x01j\x9b\x83\x9d\xfd"

spring:session:sessions:expires 为 string 结构，存储一个空值。

spring:session:expirations为set结构，存储1557389100000 时间点过期的spring:session:sessions:expires键值：

smembers spring:session:expirations:1557389100000

1) "\xac\xed\x00\x05t\x00,expires:1b8b2340-da25-4ca6-864c-4af28f033327"

RedisSessionExpirationPolicy，三个键值生成流程：

public void onExpirationUpdated(Long originalExpirationTimeInMilli,

ExpiringSession session) {

String keyToExpire = "expires:" + session.getId();

long toExpire = roundUpToNextMinute(expiresInMillis(session));

......

//把spring:session:sessions:expires加入到spring:session:expirations开头的key里面

String expireKey = getExpirationKey(toExpire);

BoundSetOperations

.boundSetOps(expireKey);

expireOperations.add(keyToExpire);

long fiveMinutesAfterExpires = sessionExpireInSeconds

+ TimeUnit.MINUTES.toSeconds(5);

//spring:session:expirations开头的key过期时间为xml配置的时间后五分钟

expireOperations.expire(fiveMinutesAfterExpires, TimeUnit.SECONDS);

if (sessionExpireInSeconds == 0) {

this.redis.delete(sessionKey);

}

else {

//spring:session:sessions:expires开头的key过期时间为xml配置的时间

this.redis.boundValueOps(sessionKey).append("");

this.redis.boundValueOps(sessionKey).expire(sessionExpireInSeconds,

TimeUnit.SECONDS);

}

//spring:session:sessions开头的key过期时间为xml配置的时间后五分钟

this.redis.boundHashOps(getSessionKey(session.getId()))

.expire(fiveMinutesAfterExpires, TimeUnit.SECONDS);

}

Redis过期键有三种删除策略，分别是定时删除，惰性删除，定期删除。

定时删除：通过维护一个定时器，过期马上删除，是最有效的，但是也是最浪费cpu时间的。

惰性删除：程序在取出键时才判断它是否过期，过期才删除，这个方法对cpu时间友好，对内存不友好。

定期删除：每隔一定时间执行一次删除过期键的操作，并限制每次删除操作的执行时长和频率，是一种折中。

Redis采用了惰性删除和定期删除的策略。由此可见依赖 Redis 的过期策略实时删除过期key是不可靠的。

另外一方面，业务可能会在Spring Session过期后做业务逻辑处理，同时需要session里面的信息，如果只有一个 spring:session:sessions键值，那么Redis删除就删除了，业务没法获取session信息。

spring:session:expirations键中存储了spring:session:sessions:expires键，而spring:session:sessions:expires键过期五分钟早于spring:session:expirations键和spring:session:sessions键（实际Spring Session对于过期事件处理订阅的spring:session:sessions:expires键，下一节会具体讲），这样在订阅到过期事件时还能获取spring:session:sessions键值。

如果通过Redis本身清理机制未及时清除spring:session:sessions:expires，可以通过Spring Session提供的定时任务兜底，保证spring:session:sessions:expires清除。

RedisSessionExpirationPolicy，session清理定时任务

public void cleanExpiredSessions() {

long now = System.currentTimeMillis();

long prevMin = roundDownMinute(now);

......

//获取到spring:session:expirations键

String expirationKey = getExpirationKey(prevMin);

// 取出当前这一分钟应当过期的 session

Set

// 注意：这里删除的是spring:session:expirations键，不是删除 session 本身！

this.redis.delete(expirationKey);

for (Object session : sessionsToExpire) {

String sessionKey = getSessionKey((String) session);

//遍历一下spring:session:sessions:expires键

touch(sessionKey);

}

}

/**

* 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) {

//并不是直接删除 key，而只是访问 key，通过惰性删除确保spring:session:sessions:expires键实时删除，

// 同时也保证多线程并发续签的场景下，key移动到不同spring:session:expirations键里面时，

//以spring:session:sessions:expires键实际ttl时间为准

this.redis.hasKey(key);

}

5、事件订阅

ConfigureNotifyKeyspaceEventsAction，开启键空间通知：

public void configure(RedisConnection connection) {

String notifyOptions = getNotifyOptions(connection);

String customizedNotifyOptions = notifyOptions;

if (!customizedNotifyOptions.contains("E")) {

customizedNotifyOptions += "E";

}

boolean A = customizedNotifyOptions.contains("A");

if (!(A || customizedNotifyOptions.contains("g"))) {

customizedNotifyOptions += "g";

}

if (!(A || customizedNotifyOptions.contains("x"))) {

customizedNotifyOptions += "x";

}

if (!notifyOptions.equals(customizedNotifyOptions)) {

connection.setConfig(CONFIG_NOTIFY_KEYSPACE_EVENTS, customizedNotifyOptions);

}

}

RedisHttpSessionConfiguration，注册监听事件：

@Bean

public RedisMessageListenerContainer redisMessageListenerContainer(

RedisConnectionFactory connectionFactory,

RedisOperationsSessionRepository messageListener) {

......

//psubscribe del和expired事件

container.addMessageListener(messageListener,

Arrays.asList(new PatternTopic("__keyevent@*:del"),

new PatternTopic("__keyevent@*:expired")));

//psubscribe created事件

container.addMessageListener(messageListener, Arrays.asList(new PatternTopic(

messageListener.getSessionCreatedChannelPrefix() + "*")));

return container;

}

RedisOperationsSessionRepository，事件处理：

public void onMessage(Message message, byte[] pattern) {

......

if (channel.startsWith(getSessionCreatedChannelPrefix())) {

...

//处理spring:session created事件

handleCreated(loaded, channel);

return;

}

//非spring:session:sessions:expires事件不做处理

String body = new String(messageBody);

if (!body.startsWith(getExpiredKeyPrefix())) {

return;

}

boolean isDeleted = channel.endsWith(":del");

if (isDeleted || channel.endsWith(":expired")) {

......

if (isDeleted) {

//处理spring:session:sessions:expires del事件

handleDeleted(sessionId, session);

}

else {

//处理spring:session:sessions:expires expired事件

handleExpired(sessionId, session);

}

......

return;

}

}

事件订阅样例：

@Component

public class SessionExpiredListener implements ApplicationListener {

@Override

public void onApplicationEvent(SessionExpiredEvent event) {

......

}

}

6、总结

Spring Session给我们提供了很好的分布式环境下资源共享问题解决思路，其基于Servlet 规范实现，业务使用时只需要简单配置就可以实现session共享，做到与业务低耦合，这都是以后我们项目开发中可以借签的设计理念。

以上就是浅谈Spring Session工作原理的详细内容，更多关于Spring Session的资料请关注我们其它相关文章！

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。