SpringSession系列-集成SpringBoot

springSession是 spring 旗下的一个项目，把 servlet 容器实现的 httpSession替换为springSession，专注于解决session管理问题。可简单快速且无缝的集成到我们的应用中。本文通过一个案例，使用SpringBoot来集成 SpringSession，并且使用Redis作为存储来实践下SpringSession 的使用。

环境准备

因为需要使用Redis作为底层Session的存储介质，实现分布式session，因此需要安装Redis。

Redis 安装

1、从官网下载最新版的Redis

2、解压

tar zxvf redis-5.0.0.tar.gz

3、编译测试

sudo make test

4、编译安装

sudo make install

5、安装问题

如果您之前安装过，重复安装且没有卸载干净的话，会报下面的错

make[1]: *** [test] Error 1 
make: *** [test] Error 2

解决这个错误，执行下面的语句即可：

make distclean 
make 
make test

正确安装姿势如下：

6、启动Redis
在您的Redis安装目录下，有 redis-server ，执行该脚本命令：

OK，到这里，Redis的安装工作完毕。

SpringBoot 工程准备

这里我们直接通过Idea来构建我们的SpringBoot工程。

File->New->Project : Spring Initializr

OK，SpringBoot 工程准备完毕，这里选择创建的是一个Web工程。

集成

集成主要是依赖引入，这里需要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

/**
 * SessionController
 * 
 * @author: glmapper@leishu
 * @since: 18/11/3 下午3:16
 * @version 1.0
 **/
@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，并且进行持久化。

这里的 session 其实是已经更新过状态的，比如重新设置了 session 的过期时间等。session 提交实际上就意味着当前请求已经处理完毕了。

小结

本文先介绍了如何使用 SpringBoot 集成 SpringSession，并且以 Redis 作为存储。然后简单分析了 SpringSession 的处理过程，本文对 SpringSession 的原理部分没有进行深入分析，下一篇分析下SpringSession的原理。