对于最新的稳定版本,请使用 Spring Session 3.3.1! |
对于最新的稳定版本,请使用 Spring Session 3.3.1! |
现在,您已经配置了应用程序,您可能希望开始自定义内容:
-
我想使用 Spring Boot 属性自定义 Redis 配置
-
我需要帮助选择或 .
RedisSessionRepository
RedisIndexedSessionRepository
-
我想指定一个不同的命名空间。
-
我想知道会话何时创建、删除、销毁或过期。
使用 JSON 序列化会话
默认情况下,Spring Session 使用 Java 序列化来序列化会话属性。
有时可能会出现问题,尤其是当您有多个应用程序使用相同的 Redis 实例但具有同一类的不同版本时。
您可以提供一个 Bean 来自定义会话序列化到 Redis 的方式。
Spring Data Redis 提供了使用 Jackson 的 .RedisSerializer
GenericJackson2JsonRedisSerializer
ObjectMapper
@Configuration
public class SessionConfig implements BeanClassLoaderAware {
private ClassLoader loader;
@Bean
public RedisSerializer<Object> springSessionDefaultRedisSerializer() {
return new GenericJackson2JsonRedisSerializer(objectMapper());
}
/**
* Customized {@link ObjectMapper} to add mix-in for class that doesn't have default
* constructors
* @return the {@link ObjectMapper} to use
*/
private ObjectMapper objectMapper() {
ObjectMapper mapper = new ObjectMapper();
mapper.registerModules(SecurityJackson2Modules.getModules(this.loader));
return mapper;
}
/*
* @see
* org.springframework.beans.factory.BeanClassLoaderAware#setBeanClassLoader(java.lang
* .ClassLoader)
*/
@Override
public void setBeanClassLoader(ClassLoader classLoader) {
this.loader = classLoader;
}
}
上面的代码片段使用的是 Spring Security,因此我们正在创建一个使用 Spring Security 的 Jackson 模块的自定义。
如果你不需要 Spring Security Jackson 模块,你可以注入应用程序的 bean 并像这样使用它:ObjectMapper
ObjectMapper
@Bean
public RedisSerializer<Object> springSessionDefaultRedisSerializer(ObjectMapper objectMapper) {
return new GenericJackson2JsonRedisSerializer(objectMapper);
}
指定其他命名空间
使用同一 Redis 实例的多个应用程序并不少见。
出于这个原因,Spring Session 使用(默认为 )来保持会话数据的分离(如果需要)。namespace
spring:session
使用 Spring Boot 属性
您可以通过设置属性来指定它。spring.session.redis.namespace
spring.session.redis.namespace=spring:session:myapplication
spring:
session:
redis:
namespace: "spring:session:myapplication"
使用注释的属性
您可以通过在 、 或 注释中设置属性来指定:namespace
redisNamespace
@EnableRedisHttpSession
@EnableRedisIndexedHttpSession
@EnableRedisWebSession
@Configuration
@EnableRedisHttpSession(redisNamespace = "spring:session:myapplication")
public class SessionConfig {
// ...
}
@Configuration
@EnableRedisIndexedHttpSession(redisNamespace = "spring:session:myapplication")
public class SessionConfig {
// ...
}
@Configuration
@EnableRedisWebSession(redisNamespace = "spring:session:myapplication")
public class SessionConfig {
// ...
}
在 和 之间进行选择RedisSessionRepository
RedisIndexedSessionRepository
使用 Spring Session Redis 时,您可能必须在 和 之间进行选择。
两者都是在 Redis 中存储会话数据的接口的实现。
但是,它们在处理会话索引和查询的方式上有所不同。RedisSessionRepository
RedisIndexedSessionRepository
SessionRepository
-
RedisSessionRepository
:是一种基本实现,无需任何额外的索引即可将会话数据存储在 Redis 中。 它使用简单的键值结构来存储会话属性。 每个会话都分配有一个唯一的会话 ID,会话数据存储在与该 ID 关联的 Redis 密钥下。 当需要检索会话时,存储库会使用会话 ID 查询 Redis 以获取关联的会话数据。 由于没有索引,因此基于会话 ID 以外的属性或条件查询会话可能效率低下。RedisSessionRepository
-
RedisIndexedSessionRepository
:是一种扩展实现,可为存储在 Redis 中的会话提供索引功能。 它在 Redis 中引入了额外的数据结构,以根据属性或条件高效查询会话。 除了 使用的键值结构之外,它还维护其他索引以实现快速查找。 例如,它可以根据会话属性(如用户 ID 或上次访问时间)创建索引。 这些索引允许根据特定条件对会话进行高效查询,从而增强性能并启用高级会话管理功能。 除此之外,还支持会话过期和删除。RedisIndexedSessionRepository
RedisSessionRepository
RedisIndexedSessionRepository
配置RedisSessionRepository
收听会话事件
配置索引存储库后,您现在可以开始侦听 、 和 事件。
在 Spring 中,有几种方法可以监听应用程序事件,我们将使用注解。SessionCreatedEvent
SessionDeletedEvent
SessionDestroyedEvent
SessionExpiredEvent
@EventListener
@Component
public class SessionEventListener {
@EventListener
public void processSessionCreatedEvent(SessionCreatedEvent event) {
// do the necessary work
}
@EventListener
public void processSessionDeletedEvent(SessionDeletedEvent event) {
// do the necessary work
}
@EventListener
public void processSessionDestroyedEvent(SessionDestroyedEvent event) {
// do the necessary work
}
@EventListener
public void processSessionExpiredEvent(SessionExpiredEvent event) {
// do the necessary work
}
}
查找特定用户的所有会话
通过检索特定用户的所有会话,您可以跨设备或浏览器跟踪用户的活动会话。 例如,您可以使用此信息会话管理目的,例如允许用户从特定会话中失效或注销,或者根据用户的会话活动执行操作。
为此,首先必须使用索引存储库,然后可以注入接口,如下所示:FindByIndexNameSessionRepository
@Autowired
public FindByIndexNameSessionRepository<? extends Session> sessions;
public Collection<? extends Session> getSessions(Principal principal) {
Collection<? extends Session> usersSessions = this.sessions.findByPrincipalName(principal.getName()).values();
return usersSessions;
}
public void removeSession(Principal principal, String sessionIdToDelete) {
Set<String> usersSessionIds = this.sessions.findByPrincipalName(principal.getName()).keySet();
if (usersSessionIds.contains(sessionIdToDelete)) {
this.sessions.deleteById(sessionIdToDelete);
}
}
在上面的示例中,您可以使用该方法来查找特定用户的所有会话,以及删除用户的特定会话的方法。getSessions
removeSession