问题背景
- 最近在做一个session共享的业务,接手的项目中是通过tomcat-redis-session-manager-master这个jar包实现的session共享,该jar包依赖于tomcat容器。而现在的项目需求是不依赖于特定容器,对该项目的session共享进行相关修改。通过查找相关资料,发现spring session符合要求。对于spring session的相关介绍,这里就不做阐述了,看官可自行查找。
问题描述
- 接手的项目中通过多个web应用的war包进行项目协作,然而在使用spring session进行session共享的时候,发现各web都是单独的sessionId,并且存储在Redis中。也就是说,各web应用之间并没有实现session共享,从而也就无法实现单点登录功能。
问题解决
- 通过查看spring session相关源码发现,在包路径
org.springframework.session.web.http
下有一个DefaultCookieSerializer
类,该类有一个方法getCookiePath(HttpServletRequest request)
,下面为源码相关内容,其中的syso为我调试的时候自己打印的log。
private String getCookiePath(HttpServletRequest request) {
if (this.cookiePath == null) {
System.out.println("cookiePath-->" + request.getContextPath());
return request.getContextPath() + "/";
}
return this.cookiePath;
}
- 通过上面的打印log,我发现该方法返回的cookiePath是web项目的子域路径,也就是说,如果一个项目为localhost:8080/abc,另一个项目为localhost:8080/def(该端口也可以不为8080),那么spring session就会认为两个项目的cookiePath分别为/abc和/def,从而也就认定这两个项目不为同一个cookiePath,最终也就导致问题的出现,无法实现session共享。
- 解决该问题,我们可以通过修改源码返回的cookiePath,使得其认为的cookiePath路径一致,修改后的源码为:
private String getCookiePath(HttpServletRequest request) {
// if (this.cookiePath == null) {
// System.out.println("cookiePath-->" + request.getContextPath());
// return request.getContextPath() + "/";
// }
// return this.cookiePath;
return "/";
}
此方式为所有返回的cookiePath都为“/”,也就使得各web应用的cookiePath一致了。当然,具体的修改还要根据实际项目进行,但是最终解决的思路是一样的,各web应用返回的cookiePath一致
- 对于如何修改源码
1.第一种比较直接暴力的就是修改spring seesion源码,并重新打成jar包
2.第二种就是让程序复用DefaultCookieSerializer
类,在每个web项目中分别新建一个类DefaultCookieSerializer
类,先假如该类所在的包为com.test
,复制源码中DefaultCookieSerializer
类的内容放入你自己新建的DefaultCookieSerializer
类中,由于篇幅问题,我就不把DefaultCookieSerializer
类的内容放出来了,只要按上面所说的将getCookiePath(HttpServletRequest request)
返回值修改就可以了。新建类中在这个地方会出现报错:
private boolean isServlet3()
{
// ServletRequest.getMethod("startAsync", new Class[0]);
return true;
// NoSuchMethodException nosuchmethodexception;
// nosuchmethodexception;
// return false;
}
为了方便演示,我就直接将相关报错注释掉了,看官可自行斟酌。
3.第三种就是修改各个web应用的域名,还是那句话,最终解决的思路是一样的,让spring session对各web应用返回的cookiePath一致
4.新建好DefaultCookieSerializer
类之后,需要修改applicationContext.xml
(我的项目是直接在该xml中进行spring session相关配置,看官可根据自己项目在相应的xml中对spring session进行配置),在xml中添加以下内容:
<bean id="defaultCookieSerializer" class="com.test.DefaultCookieSerializer" />
<bean class="org.springframework.session.web.http.CookieHttpSessionStrategy">
<property name="cookieSerializer" ref="defaultCookieSerializer" />
</bean>
<bean class="org.springframework.session.config.annotation.web.http.SpringHttpSessionConfiguration">
<property name="cookieSerializer" ref="defaultCookieSerializer" />
</bean>
5.至此,对于spring session多web应用无法实现session共享的问题解决了。
总结
- 看官如果遇到这种问题,可以尝试使用本文所阐述的方法进行相关配置。如果不行的话,请继续填坑,加油!
- 本文使用的spring session包版本为spring-session-1.2.1-RELEASE.jar,可能不同的版本包内容上会有些不同,还是那句话,最终解决的思路是一样的,让spring session对各web应用返回的cookiePath一致,重要的事终于说了3遍了
- 小生退下了,看官您受累!