淺談Spring Session工作原理
1、引入背景
HTTP協(xié)議本身是無狀態(tài)的,為了保存會話信息,瀏覽器Cookie通過SessionID標識會話請求,服務器以SessionID為key來存儲會話信息。在單實例應用中,可以考慮應用進程自身存儲,隨著應用體量的增長,需要橫向擴容,多實例session共享問題隨之而來。
應用部署在Tomcat時,session是由Tomcat內(nèi)存維護,如果應用部署多個實例,session就不能共享。Spring Session就是解決為了解決分布式場景中的session共享問題。
2、使用方法
Spring Session支持存儲在Hazelcast 、Redis、MongoDB、關(guān)系型數(shù)據(jù)庫,本文主要討論session存儲在Redis。
web.xml配置:
<!-- spring session -->
<filter>
<filter-name>springSessionRepositoryFilter</filter-name>
<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
</filter>
<filter-mapping>
<filter-name>springSessionRepositoryFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
Spring 主要配置:
<!--創(chuàng)建了一個RedisConnectionFactory,它將Spring會話連接到Redis服務器-->
<bean id="jedisConnectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory">
<!--配置Redis連接池 ,可以不配置,使用默認就行!-->
p:poolConfig-ref="jedisPoolConfig"
</bean>
<!--創(chuàng)建一個Spring Bean的名稱springSessionRepositoryFilter實現(xiàn)過濾器-->
<bean class="org.springframework.session.data.redis.config.annotation.web.http.RedisHttpSessionConfiguration">
<!--默認session時效30分鐘-->
<property name="maxInactiveIntervalInSeconds" value="60" />
</bean>
3、工作流程
Tomcat web.xml解析步驟:
contextInitialized(ServletContextEvent arg0); // Listener init(FilterConfig filterConfig); // Filter init(ServletConfig config); // Servlet
初始化順序:Listener > Filter > Servlet。
1) 通過 Tomcat 的 listener 把SessionRepositoryFilter加載到Spring容器中。
上一小節(jié)Spring配置文件里面聲明了RedisHttpSessionConfiguration,正是在其父類SpringHttpSessionConfiguration中生成了SessionRepositoryFilter:
@Bean
public <S extends ExpiringSession> SessionRepositoryFilter<? extends ExpiringSession> springSessionRepositoryFilter(
SessionRepository<S> sessionRepository) {
......
return sessionRepositoryFilter;
}
RedisHttpSessionConfiguration類繼承關(guān)系
2) filter初始化
web.xml里面配置的filter是DelegatingFilterProxy。

DelegatingFilterProxy類繼承關(guān)系
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實際緩存的數(shù)據(jù)如下:
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結(jié)構(gòu),存儲Spring Session的主要內(nèi)容:
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 結(jié)構(gòu),存儲一個空值。
spring:session:expirations為set結(jié)構(gòu),存儲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<Object, Object> expireOperations = this.redis
.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時間友好,對內(nèi)存不友好。
- 定期刪除:每隔一定時間執(zhí)行一次刪除過期鍵的操作,并限制每次刪除操作的執(zhí)行時長和頻率,是一種折中。
Redis采用了惰性刪除和定期刪除的策略。由此可見依賴 Redis 的過期策略實時刪除過期key是不可靠的。
另外一方面,業(yè)務可能會在Spring Session過期后做業(yè)務邏輯處理,同時需要session里面的信息,如果只有一個 spring:session:sessions鍵值,那么Redis刪除就刪除了,業(yè)務沒法獲取session信息。
spring:session:expirations鍵中存儲了spring:session:sessions:expires鍵,而spring:session:sessions:expires鍵過期五分鐘早于spring:session:expirations鍵和spring:session:sessions鍵(實際Spring Session對于過期事件處理訂閱的spring:session:sessions:expires鍵,下一節(jié)會具體講),這樣在訂閱到過期事件時還能獲取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<Object> sessionsToExpire = this.redis.boundSetOps(expirationKey).members();
// 注意:這里刪除的是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鍵實時刪除,
// 同時也保證多線程并發(fā)續(xù)簽的場景下,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,注冊監(jiān)聽事件:
@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<SessionExpiredEvent> {
@Override
public void onApplicationEvent(SessionExpiredEvent event) {
......
}
}
6、總結(jié)
Spring Session給我們提供了很好的分布式環(huán)境下資源共享問題解決思路,其基于Servlet 規(guī)范實現(xiàn),業(yè)務使用時只需要簡單配置就可以實現(xiàn)session共享,做到與業(yè)務低耦合,這都是以后我們項目開發(fā)中可以借簽的設(shè)計理念。
以上就是淺談Spring Session工作原理的詳細內(nèi)容,更多關(guān)于Spring Session的資料請關(guān)注腳本之家其它相關(guān)文章!
- SpringBoot+SpringSession+Redis實現(xiàn)session共享及唯一登錄示例
- SpringCloud Feign轉(zhuǎn)發(fā)請求頭(防止session失效)的解決方案
- springboot中的springSession的存儲和獲取實現(xiàn)
- 多個SpringBoot項目采用redis實現(xiàn)Session共享功能
- SpringBoot 如何實現(xiàn)Session共享
- Springboot中登錄后關(guān)于cookie和session攔截問題的案例分析
- Springboot Session共享實現(xiàn)原理及代碼實例
- SpringBoot中實現(xiàn)分布式的Session共享的詳細教程
- spring-redis-session 自定義 key 和過期時間
- SpringBoot2.x 整合Spring-Session實現(xiàn)Session共享功能
- Spring Session的使用示例
相關(guān)文章
Java中NoClassDefFoundError?和?ClassNotFoundException的區(qū)別
Java中NoClassDefFoundError和ClassNotFoundException的區(qū)別,從類繼承層次上來看,ClassNotFoundException是從Exception繼承的,所以ClassNotFoundException是一個檢查異常。具體詳情需要的朋友可以參考下面文章內(nèi)容2022-06-06
Quartz實現(xiàn)JAVA定時任務的動態(tài)配置的方法
這篇文章主要介紹了Quartz實現(xiàn)JAVA定時任務的動態(tài)配置的方法,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2018-07-07
tk.mybatis通用插件updateByPrimaryKeySelective無法自動更新列的解決辦法
tk.mybatis是一個很好用的通用插件,本文主要介紹了tk.mybatis通用插件updateByPrimaryKeySelective無法自動更新列的解決辦法,具有一定的參考價值,感興趣的小伙伴們可以參考一下2021-12-12

