SpringSession系列-集成SpringBoot
springSession
是spring
旗下的一个项目,把servlet
容器实现的httpSession
替换为springSession
,专注于解决session
管理问题。可简单快速且无缝的集成到我们的应用中。本文通过一个案例,使用SpringBoot
来集成SpringSession
,并且使用Redis
作为存储来实践下SpringSession
的使用。
依赖集成
集成主要是依赖引入,这里需要redis
和session
的依赖
依赖引入
<dependencies>
<!--redis 依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!--sessions 依赖-->
<dependency>
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-data-redis</artifactId>
</dependency>
</dependencies>
复制代码
配置application.properties
#服务端口
server.port=8080
#redi主机地址
spring.redis.host=localhost
#redis服务端口
spring.redis.port=6379
# spring session使用存储类型,spirngboot默认就是使用redis方式,如果不想用可以填none。
spring.session.store-type=redis
在启动类中加入@EnableRedisHttpSession 注解
@SpringBootApplication
@EnableRedisHttpSession
public class SpringBootSessionApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootSessionApplication.class, args);
}
}
测试
先来编写一个Controller
@Controller
@RequestMapping(value = "/")
public class SessionController {
@ResponseBody
@RequestMapping(value = "/session")
public Map<String, Object> getSession(HttpServletRequest request) {
request.getSession().setAttribute("userName", "glmapper");
Map<String, Object> map = new HashMap<>();
map.put("sessionId", request.getSession().getId());
return map;
}
@ResponseBody
@RequestMapping(value = "/get")
public String get(HttpServletRequest request) {
String userName = (String) request.getSession().getAttribute("userName");
return userName;
}
}
测试结果
启动SpringBoot
工程;然后浏览器中输入地址 http://localhost:8080/session;
这里对应执行的是我们上面Controller
中的第一个方法getSession
,这个方法向session
中设置了一个值。
下面我们执行:http://localhost:8080/get 这里是从session
中取值:
到此,SpringBoot
整合 SpringSession
的过程就完成了。这里我们只是引入了依赖,然后做了简单的配置,那么我们的请求是如何被 SpringSession
处理的呢?从我们一贯的认知来看,对于基于Servlet
规范的容器(SpringBoot
使用的是嵌入式Tomcat
)的应用,请求最先被处理的是Filter
。我们在基于Spring+SpringMvc
这套技术栈开发时,如果我们需要做权限管理,通过会基于Filter
或者拦截器。但是这里貌似我们什么也没做,但是请求确实被SpringSession
处理了。OK,我们来扒一扒。
SpringSession 是如何处理请求的?
上面这张截图想必大家都不陌生,是SpringBoot
的启动日志;上图红色框内的是当前应用注册是Filter
信息,从这里可以看到有个和 session
有关的Filter:sessionRepositoryFilter
;这个bean
对应的类是:
org.springframework.boot.autoconfigure.session.SessionRepositoryFilterConfiguration.ConditionalOnBean=
org.springframework.session.web.http.SessionRepositoryFilter
复制代码
在这里找到了
这里涉及到SpringBoot
的自动配置,从spring-boot-autoconfig
包下加载spring-autoconfigure-metadata.properties
配置文件,然后获取所有支持自动配置的信息;SpringSession
也在其中。关于如何加载并且注册不在本文的范畴之内,我们继续来分析SpringSession
的处理过程。
SpringSession 的处理过程
从上面SpringBoot
的启动过程我们找到了处理session
的Filter
,然后知道了它是通过自动配置的方式被注册到当前的容器并且来处理请求。
@Order(SessionRepositoryFilter.DEFAULT_ORDER)
public class SessionRepositoryFilter<S extends Session>
extends OncePerRequestFilter {
复制代码
从SessionRepositoryFilter
的定义来看:
- 1、使用了
Order
,并且配置了一个很小的值(Integer.MIN_VALUE + 50
),以此来确保session
的Filter
在Filter
链中被优先执行。 - 2、集成了
OncePerRequestFilter
,确保在一次请求只通过一次filter
,而不需要重复执行
为什么 session
的 Filter
要被优先执行呢?因为我们的请求被包装了,如果SessionRepositoryFilter
不优先处理请求,可能会导致后续的请求行为不一致,这里涉及到 springSession
无缝替换应用服务器的request
的原理:
- 1.自定义个
Filter
,实现doFilter
方法 - 2.继承
HttpServletRequestWrapper
、HttpServletResponseWrapper
类,重写getSession
等相关方法(在这些方法里调用相关的session
存储容器操作类)。 - 3.自定义
request
和response
类;并把它们分别传递到过滤器链 - 4.把该
filter
配置到过滤器链的第一个位置上
OK,了解了这些背景,我们来跟踪下整个处理流程。
1、断点到 doFilterInternal
从这里可以看到request
和response
类被包装了。
2、断点到 getSession
这里是从Redis
中拿我们session
数据的地方
-
先从我们当前
servlet
容器中去拿,如果拿到则直接返回 -
去
Redis
中取这里会有一个缓存处理,并非是每次都到
Reids
中去查一次,避免一次与
Reids
的交互。
- 如果缓存当前应用容器缓存中有,则直接返回当前被缓存的
session
- 如果没有,则从请求中获取
sessionId
,并且根据当前sessionId
去Reids
中查找session
数据 - 更新缓存
session,sessionId,requestedSessionCached
等数据状态
- 如果缓存当前应用容器缓存中有,则直接返回当前被缓存的
-
如果
Redis
中有,则更新session
相关信息并返回 -
如果
Reids
中没有找到,则根据create
来判断是否创建新的session
。
断点到 readCookieValues
SpringSession
提供了两种保存和传递SessionId
的方式,一种是基于Cookie
的,一种是基于Header
的。SpringSession
中默认使用的是基于Cookie
的方式。readCookieValues
就是实现如何从Cookie
中获取sessionId
的。
这个过程其实很简单,先是从request
中获取当前请求携带的所以的Cookie
信息,然后将匹配到的 cookieName
为 “SESSION”
的Cookie
进行解析。
断点到 RedisOperationsSessionRepository -> getSession
这里是从Redis
中取session
数据的地方
- 根据
sessionId
从Redis
中取到entries
数据 - 构建
RedisSession
并返回
断点到 commitSession
commitSession
作用是通过HttpSessionIdResolver
将sessionId
写到response
,并且进行持久化。
80)]
- 根据
sessionId
从Redis
中取到entries
数据 - 构建
RedisSession
并返回
断点到 commitSession
commitSession
作用是通过HttpSessionIdResolver
将sessionId
写到response
,并且进行持久化。
[外链图片转存中…(img-Hq52Ayeh-1626597125580)]
这里的 session
其实是已经更新过状态的,比如重新设置了 session
的过期时间等。session
提交实际上就意味着当前请求已经处理完毕了。