淺談Spring Session工作原理
1、引入背景
HTTP協(xié)議本身是無(wú)狀態(tài)的,為了保存會(huì)話信息,瀏覽器Cookie通過(guò)SessionID標(biāo)識(shí)會(huì)話請(qǐng)求,服務(wù)器以SessionID為key來(lái)存儲(chǔ)會(huì)話信息。在單實(shí)例應(yīng)用中,可以考慮應(yīng)用進(jìn)程自身存儲(chǔ),隨著應(yīng)用體量的增長(zhǎng),需要橫向擴(kuò)容,多實(shí)例session共享問(wèn)題隨之而來(lái)。
應(yīng)用部署在Tomcat時(shí),session是由Tomcat內(nèi)存維護(hù),如果應(yīng)用部署多個(gè)實(shí)例,session就不能共享。Spring Session就是解決為了解決分布式場(chǎng)景中的session共享問(wèn)題。
2、使用方法
Spring Session支持存儲(chǔ)在Hazelcast 、Redis、MongoDB、關(guān)系型數(shù)據(jù)庫(kù),本文主要討論session存儲(chǔ)在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)建了一個(gè)RedisConnectionFactory,它將Spring會(huì)話連接到Redis服務(wù)器-->
<bean id="jedisConnectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory">
<!--配置Redis連接池 ,可以不配置,使用默認(rèn)就行!-->
p:poolConfig-ref="jedisPoolConfig"
</bean>
<!--創(chuàng)建一個(gè)Spring Bean的名稱springSessionRepositoryFilter實(shí)現(xiàn)過(guò)濾器-->
<bean class="org.springframework.session.data.redis.config.annotation.web.http.RedisHttpSessionConfiguration">
<!--默認(rèn)session時(shí)效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) 通過(guò) 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 實(shí)際代理了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、緩存機(jī)制
每一個(gè)session,Redis實(shí)際緩存的數(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),存儲(chǔ)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),存儲(chǔ)一個(gè)空值。
spring:session:expirations為set結(jié)構(gòu),存儲(chǔ)1557389100000 時(shí)間點(diǎn)過(guò)期的spring:session:sessions:expires鍵值:
smembers spring:session:expirations:1557389100000
1) "\xac\xed\x00\x05t\x00,expires:1b8b2340-da25-4ca6-864c-4af28f033327"
RedisSessionExpirationPolicy,三個(gè)鍵值生成流程:
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過(guò)期時(shí)間為xml配置的時(shí)間后五分鐘
expireOperations.expire(fiveMinutesAfterExpires, TimeUnit.SECONDS);
if (sessionExpireInSeconds == 0) {
this.redis.delete(sessionKey);
}
else {
//spring:session:sessions:expires開頭的key過(guò)期時(shí)間為xml配置的時(shí)間
this.redis.boundValueOps(sessionKey).append("");
this.redis.boundValueOps(sessionKey).expire(sessionExpireInSeconds,
TimeUnit.SECONDS);
}
//spring:session:sessions開頭的key過(guò)期時(shí)間為xml配置的時(shí)間后五分鐘
this.redis.boundHashOps(getSessionKey(session.getId()))
.expire(fiveMinutesAfterExpires, TimeUnit.SECONDS);
}
Redis過(guò)期鍵有三種刪除策略,分別是定時(shí)刪除,惰性刪除,定期刪除。
- 定時(shí)刪除:通過(guò)維護(hù)一個(gè)定時(shí)器,過(guò)期馬上刪除,是最有效的,但是也是最浪費(fèi)cpu時(shí)間的。
- 惰性刪除:程序在取出鍵時(shí)才判斷它是否過(guò)期,過(guò)期才刪除,這個(gè)方法對(duì)cpu時(shí)間友好,對(duì)內(nèi)存不友好。
- 定期刪除:每隔一定時(shí)間執(zhí)行一次刪除過(guò)期鍵的操作,并限制每次刪除操作的執(zhí)行時(shí)長(zhǎng)和頻率,是一種折中。
Redis采用了惰性刪除和定期刪除的策略。由此可見依賴 Redis 的過(guò)期策略實(shí)時(shí)刪除過(guò)期key是不可靠的。
另外一方面,業(yè)務(wù)可能會(huì)在Spring Session過(guò)期后做業(yè)務(wù)邏輯處理,同時(shí)需要session里面的信息,如果只有一個(gè) spring:session:sessions鍵值,那么Redis刪除就刪除了,業(yè)務(wù)沒法獲取session信息。
spring:session:expirations鍵中存儲(chǔ)了spring:session:sessions:expires鍵,而spring:session:sessions:expires鍵過(guò)期五分鐘早于spring:session:expirations鍵和spring:session:sessions鍵(實(shí)際Spring Session對(duì)于過(guò)期事件處理訂閱的spring:session:sessions:expires鍵,下一節(jié)會(huì)具體講),這樣在訂閱到過(guò)期事件時(shí)還能獲取spring:session:sessions鍵值。
如果通過(guò)Redis本身清理機(jī)制未及時(shí)清除spring:session:sessions:expires,可以通過(guò)Spring Session提供的定時(shí)任務(wù)兜底,保證spring:session:sessions:expires清除。
RedisSessionExpirationPolicy,session清理定時(shí)任務(wù)
public void cleanExpiredSessions() {
long now = System.currentTimeMillis();
long prevMin = roundDownMinute(now);
......
//獲取到spring:session:expirations鍵
String expirationKey = getExpirationKey(prevMin);
// 取出當(dāng)前這一分鐘應(yīng)當(dāng)過(guò)期的 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,而只是訪問(wèn) key,通過(guò)惰性刪除確保spring:session:sessions:expires鍵實(shí)時(shí)刪除,
// 同時(shí)也保證多線程并發(fā)續(xù)簽的場(chǎng)景下,key移動(dòng)到不同spring:session:expirations鍵里面時(shí),
//以spring:session:sessions:expires鍵實(shí)際ttl時(shí)間為準(zhǔn)
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,注冊(cè)監(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)境下資源共享問(wèn)題解決思路,其基于Servlet 規(guī)范實(shí)現(xiàn),業(yè)務(wù)使用時(shí)只需要簡(jiǎn)單配置就可以實(shí)現(xiàn)session共享,做到與業(yè)務(wù)低耦合,這都是以后我們項(xiàng)目開發(fā)中可以借簽的設(shè)計(jì)理念。
以上就是淺談Spring Session工作原理的詳細(xì)內(nèi)容,更多關(guān)于Spring Session的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
- SpringBoot+SpringSession+Redis實(shí)現(xiàn)session共享及唯一登錄示例
- SpringCloud Feign轉(zhuǎn)發(fā)請(qǐng)求頭(防止session失效)的解決方案
- springboot中的springSession的存儲(chǔ)和獲取實(shí)現(xiàn)
- 多個(gè)SpringBoot項(xiàng)目采用redis實(shí)現(xiàn)Session共享功能
- SpringBoot 如何實(shí)現(xiàn)Session共享
- Springboot中登錄后關(guān)于cookie和session攔截問(wèn)題的案例分析
- Springboot Session共享實(shí)現(xiàn)原理及代碼實(shí)例
- SpringBoot中實(shí)現(xiàn)分布式的Session共享的詳細(xì)教程
- spring-redis-session 自定義 key 和過(guò)期時(shí)間
- SpringBoot2.x 整合Spring-Session實(shí)現(xiàn)Session共享功能
- Spring Session的使用示例
相關(guān)文章
JAVA實(shí)現(xiàn)Excel和PDF上下標(biāo)的操作代碼
這篇文章主要介紹了JAVA實(shí)現(xiàn)Excel和PDF上下標(biāo),本文通過(guò)示例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2023-09-09
創(chuàng)建并運(yùn)行一個(gè)java線程方法介紹
這篇文章主要介紹了創(chuàng)建并運(yùn)行一個(gè)java線程,涉及線程代碼示例,具有一定參考價(jià)值,需要的朋友可以了解下。2017-11-11
Java中NoClassDefFoundError?和?ClassNotFoundException的區(qū)別
Java中NoClassDefFoundError和ClassNotFoundException的區(qū)別,從類繼承層次上來(lái)看,ClassNotFoundException是從Exception繼承的,所以ClassNotFoundException是一個(gè)檢查異常。具體詳情需要的朋友可以參考下面文章內(nèi)容2022-06-06
詳解Java函數(shù)式編程和lambda表達(dá)式
這篇文章主要介紹了Java函數(shù)式編程和lambda表達(dá)式,對(duì)lambda感興趣的同學(xué),一定要看一下2021-04-04
Quartz實(shí)現(xiàn)JAVA定時(shí)任務(wù)的動(dòng)態(tài)配置的方法
這篇文章主要介紹了Quartz實(shí)現(xiàn)JAVA定時(shí)任務(wù)的動(dòng)態(tài)配置的方法,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-07-07
tk.mybatis通用插件updateByPrimaryKeySelective無(wú)法自動(dòng)更新列的解決辦法
tk.mybatis是一個(gè)很好用的通用插件,本文主要介紹了tk.mybatis通用插件updateByPrimaryKeySelective無(wú)法自動(dòng)更新列的解決辦法,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-12-12

