spring-redis-session 自定义 key 和过期时间

 更新时间:2019年12月30日 08:32:47   作者:sanri1993  
这篇文章主要介绍了spring-redis-session 自定义 key 和过期时间,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

对于分布式应用来说,最开始遇到的问题就是 session 的存储了,解决方案大致有如下几种

  • 使用 spring-session 它可以把 session 存储到你想存储的位置,如 redis,mysql 等
  • 使用 JWTs ,它使用算法来验证 token 的合法性,是否过期,并且 token 无法被伪造,信息也是无法被篡改的

本文内容主要说 spring-session 使用 redis 来存储 session ,实现原理,修改过期时间,自定义 key 等

spring-session 对于内部系统来说还是可以的,使用方便,但如果用户量上来了的话,会使 redis 有很大的 session 存储开销,不太划算。

使用

使用起来比较简单,简单说一下,引包,配置,加注解 。如下面三步,就配置好了使用 redis-session

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

<dependency>
  <groupId>org.springframework.session</groupId>
  <artifactId>spring-session-data-redis</artifactId>
</dependency>

spring.redis.host=localhost 
# 其它 超时,端口,库,连接池,集群,就自己去找了
@EnableRedisHttpSession(maxInactiveIntervalInSeconds= 1800)

测试:因为是在 getSession 的时候才会创建 Session ,所以我们必须在接口中调用一次才能看到效果

@GetMapping("/sessionId")
public String sessionId(){
  HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
  HttpSession session = request.getSession();
  session.setAttribute("user","sanri");
  return session.getId();
}

它的存储结果如下

hash spring:session:sessions:e3d4d84f-cc9f-44d5-9199-463cd9de8272
string spring:session:sessions:expires:e3d4d84f-cc9f-44d5-9199-463cd9de8272
set spring:session:expirations:1577615340000
第一个 hash 结构存储了 session 的一些基本信息和用户设置的一些属性信息

creationTime 创建时间

lastAccessedTime 最后访问时间

maxInactiveInterval 过期时长,默认是 30 分钟,这里保存的秒值

sessionAttr:user 这是我通过 session.setAttribute 设置进去的属性

第二个 string 结构,它没有值,只有一个 ttl 信息,标识这组 key 还能活多久,可以用 ttl 查看

第三个 set 结构,保存了所以需要过期的 key

实现原理

说明:这个实现没多少难度,我就照着源码念一遍了,就是一个过滤器的应用而已。

首先从网上了解到,它是使用过滤器来实现把 session 存储到 redis 的,然后每次请求都是从 redis 拿到 session 的,所以目标就是看它的过滤器是哪个,是怎么存储的,又是怎么获取的。

我们可以从它唯一的入口 @EnableRedisHttpSession 进入查看,它引入了一个 RedisHttpSessionConfiguration 开启了一个定时器,继承自 SpringHttpSessionConfiguration ,可以留意到 RedisHttpSessionConfiguration 创建一个 Bean RedisOperationsSessionRepository repository 是仓库的意思,所以它就是核心类了,用于存储 session ;那过滤器在哪呢,查看SpringHttpSessionConfiguration 它属于 spring-session-core 包,这是一个 spring 用来管理 session 的包,是一个抽象的概念,具体的实现由 spring-session-data-redis 来完成 ,那过滤器肯定在这里创建的,果然可以看到它创建一个 SessionRepositoryFilter 的过滤器,下面分别看过滤器和存储。

SessionRepositoryFilter

过滤器一定是有 doFilter 方法,查看 doFilter 方法,spring 使用 OncePerRequestFilter 把 doFilter 包装了一层,最终是调用 doFilterInternal 来实现的,查看 doFilterInternal 方法

实现方式为使用了包装者设计把 request 和 response 响应进行了包装,我们一般拿 session 一般是从 request.getSession() ,所以包装的 request 肯定要重写 getSession ,所以可以看 getSession 方法来看是如何从 redis 获取 session ;

前面都是已经存在 session 的判断相关,关键信息在这里

S session = SessionRepositoryFilter.this.sessionRepository.createSession();

这里的 sessionRepository 就是我们用来存取 session 的 RedisOperationsSessionRepository 查看 createSession 方法

RedisOperationsSessionRepository

// 这里保存了在 redis 中 hash 结构能看到的数据
RedisSession redisSession = new RedisSession();

this(new MapSession());
this.delta.put(CREATION_TIME_ATTR, getCreationTime().toEpochMilli());
this.delta.put(MAX_INACTIVE_ATTR, (int) getMaxInactiveInterval().getSeconds());
this.delta.put(LAST_ACCESSED_ATTR, getLastAccessedTime().toEpochMilli());
this.isNew = true;
this.flushImmediateIfNecessary();

在 flushImmediateIfNecessary 方法中,如果 redisFlushMode 是 IMMEDIATE 模式,则会立即保存 session 进 redis ,但默认配置的是 ON_SAVE ,那是在哪里保存进 redis 的呢,我们回到最开始的过滤器 doFilterInternal 方法中,在 finally 中有一句

wrappedRequest.commitSession();

就是在这里将 session 存储进 redis 的 ,我们跟进去看看,核心语句为这句

SessionRepositoryFilter.this.sessionRepository.save(session);
session.saveDelta();
if (session.isNew()) {
  String sessionCreatedKey = getSessionCreatedChannel(session.getId());
  this.sessionRedisOperations.convertAndSend(sessionCreatedKey, session.delta);
  session.setNew(false);
}

进入 saveDelta ,在这里进行了 hash 结构的设置

getSessionBoundHashOperations(sessionId).putAll(this.delta);

最后一行进行了过期时间的设置和把当前 key 加入 set ,读者自行查看

RedisOperationsSessionRepository.this.expirationPolicy
          .onExpirationUpdated(originalExpiration, this);

修改一些参数

实际业务中,可能需要修改一些参数才能达到我们业务的需求,最常见的需求就是修改 session 的过期时间了,在 EnableRedisHttpSession 注解中,已经提供了一些基本的配置如

maxInactiveIntervalInSeconds 最大过期时间,默认 30 分钟
redisNamespace 插入到 redis 的 session 命名空间,默认是 spring:session
cleanupCron 过期 session 清理任务,默认是 1 分钟清理一次
redisFlushMode 刷新方式 ,其实在上面原理的 flushImmediateIfNecessary 方法中有用到,默认是 ON_SAVE
redisNamespace 是一定要修改的,这个不修改会影响别的项目,一般使用我们项目的名称加关键字 session 做 key ,表明这是这个项目的 session 信息。

不过这样的配置明显不够,对于最大过期时间来说,有可能需要加到配置文件中去,而不是写在代码中,但是这里没有提供占位符的功能,回到 RedisOperationsSessionRepository 的创建,最终配置的 maxInactiveIntervalInSeconds 还是要设置到这个 bean 中去的,我们可以把这个 bean 的创建过程覆盖,重写 maxInactiveIntervalInSeconds 的获取过程,就解决了,代码如下

@Autowired
RedisTemplate sessionRedisTemplate;

@Autowired
ApplicationEventPublisher applicationEventPublisher;

@Value("${server.session.timeout}")
private int sessionTimeout = 1800;

@Primary    // 使用 Primary 来覆盖默认的 Bean 
@Bean
public RedisOperationsSessionRepository sessionRepository() {
  RedisOperationsSessionRepository sessionRepository = new RedisOperationsSessionRepository(sessionRedisTemplate);
  // 这里要把原来的属性引用过来,避免出错 ,可以引用原来的类并复制属性 ;像 redisNamespace,redisFlushMode 都要复制过来
  return sessionRepository;
}

还有一个就是 redis 的序列化问题,默认是使用的 jdk 的对象序列化,很容易出现加一个字段或减少一个字段出现不能反序列化,所以序列化方式是需要换的,如果项目中的缓存就已经使用了对象序列化的话,那就面要为其单独写一个 redisTemplate 并设置进去,在构建 RedisOperationsSessionRepository 的时候设置 redisTemplate

还有一个就是生成在 redis 中的 key 值都是 uuid 的形式,根本没办法知道当前这个 key 是哪个用户在哪里登录的,我们其实可以修改它的 key 为 userId_ip_time 的形式,用来表明这个用户什么时间在哪个 ip 有登录过,我是这么玩的(没有在实际中使用过,虽然能改,但可能有坑):

经过前面的源码分析,创建 session 并保存到 redis 的是 RedisOperationsSessionRepository 的 createSession 方法,但是这里写死了 RedisSession 使用空的构造,而且 RedisSession 是 final 的内部类,访问权限为默认,构造的时候 new MapSession 也是默认的,最终那个 id 为使用 UUID ,看起来一点办法都没有,其实在这里创建完 session ,用户不一定是登录成功的状态,我们应该在登录成功才能修改 session 的 key ,好在 RedisOperationsSessionRepository 提供了一个方法 findById ,我们可以在这个上面做文章,先把 RedisSession 查出来,然后用反射得到 MapSession ,然后留意到 MapSession 是可以修改 id 的,它自己也提供了方法 changeSessionId ,我们完全可以在登录成功调用 setId 修改 sessionId ,然后再写回去,这个代码一定要和 RedisSession 在同包 代码如下:

package org.springframework.session.data.redis;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.session.MapSession;
import org.springframework.stereotype.Component;
import org.springframework.util.ReflectionUtils;

import java.lang.reflect.Field;

@Component
public class SessionOperation {
  @Autowired
  private RedisOperationsSessionRepository redisOperationsSessionRepository;

  public void loginSuccess(String userId){
    String sessionId = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest().getSession().getId();
    RedisOperationsSessionRepository.RedisSession redisSession = redisOperationsSessionRepository.findById(sessionId);
    Field cached = ReflectionUtils.findField(RedisOperationsSessionRepository.RedisSession.class, "cached");
    ReflectionUtils.makeAccessible(cached);
    MapSession mapSession = (MapSession) ReflectionUtils.getField(cached, redisSession);
    mapSession.setId("userId:1");
    redisOperationsSessionRepository.save(redisSession);
  }
}

源码地址: https://gitee.com/sanri/example/tree/master/test-redis-session

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • java工程师进阶之MyBatis延迟加载的使用

    java工程师进阶之MyBatis延迟加载的使用

    本文是java工程师进阶篇,主要介绍了java应用开发中MyBatis延迟加载及如何使用,有需要的朋友 可以借鉴参考下,希望能够有所帮助
    2021-09-09
  • java针对电话号码正则匹配实例

    java针对电话号码正则匹配实例

    这篇文章主要介绍了java针对电话号码正则匹配的方法,涉及java正则匹配与字符串操作的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07
  • Java元组类型javatuples使用实例

    Java元组类型javatuples使用实例

    这篇文章主要介绍了Java元组类型javatuples使用实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • springboot宝塔简单部署的实现示例

    springboot宝塔简单部署的实现示例

    通过使用Spring Boot,可以快速构建出高效、可扩展的应用程序,而宝塔面板则提供了简单易用的网站管理和维护工具,本文将详细介绍如何将Spring Boot应用程序与宝塔面板进行集成,实现自动化部署、配置管理等操作
    2023-11-11
  • Mybatis中的延迟加载详细解析

    Mybatis中的延迟加载详细解析

    这篇文章主要介绍了Mybatis中的延迟加载详细解析,延迟加载就是在真正需要使用数据时才发起查询,不用的时候不进行查询,按需加载(懒加载),需要的朋友可以参考下
    2023-12-12
  • Spring Cloud Gateway组件的三种使用方式实例详解

    Spring Cloud Gateway组件的三种使用方式实例详解

    Spring Cloud Gateway是 Spring 官方基于 Spring5.0 、 SpringBoot2.0 和 Project Reactor 等技术开发的网关旨在为微服务框架提供一种简单而有效的统一的API 路由管理方式,统一访问接口,这篇文章主要介绍了Spring Cloud Gateway组件的三种使用方式,需要的朋友可以参考下
    2024-01-01
  • Mybatis-Plus之ID自动增长的设置实现

    Mybatis-Plus之ID自动增长的设置实现

    本文主要介绍了Mybatis-Plus之ID自动增长的设置实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07
  • java中日期格式化的大坑

    java中日期格式化的大坑

    这篇文章主要介绍了java中日期格式化的大坑,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • Java中toString()、String.valueOf、(String)强转区别

    Java中toString()、String.valueOf、(String)强转区别

    相信大家在日常开发中这三种方法用到的应该很多,本文主要介绍了Java中toString()、String.valueOf、(String)强转区别,感兴趣的可以了解一下
    2021-09-09
  • Java for循环常见优化方法案例详解

    Java for循环常见优化方法案例详解

    这篇文章主要介绍了Java for循环常见优化方法案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08

最新评论