对于最新的稳定版本，请使用 Spring Session 3.4.0！spring-doc.cn

Redis 配置

现在您已经配置了应用程序，您可能希望开始自定义内容：spring-doc.cn

使用 JSON 序列化 Session

默认情况下，Spring Session 使用 Java 序列化来序列化会话属性。 有时可能会出现问题，尤其是当您有多个应用程序使用同一个 Redis 实例但具有同一类的不同版本时。 您可以提供一个 Bean 来自定义如何将会话序列化为 Redis。 Spring Data Redis 提供了使用 Jackson 的 序列化和反序列化对象的 。RedisSerializerGenericJackson2JsonRedisSerializerObjectMapperspring-doc.cn

配置 RedisSerializer
@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 并按如下方式使用它：ObjectMapperObjectMapperspring-doc.cn

@Bean
public RedisSerializer<Object> springSessionDefaultRedisSerializer(ObjectMapper objectMapper) {
    return new GenericJackson2JsonRedisSerializer(objectMapper);
}

指定不同的命名空间

多个应用程序使用同一个 Redis 实例的情况并不少见。 出于这个原因， Spring Session 如果需要，使用 （默认为 ）来保持 session 数据分离。namespacespring:sessionspring-doc.cn

使用 Spring Boot 属性

您可以通过设置属性来指定它。spring.session.redis.namespacespring-doc.cn

application.properties
spring.session.redis.namespace=spring:session:myapplication
application.yml
spring:
  session:
    redis:
      namespace: "spring:session:myapplication"

使用 Annotation 的属性

您可以通过在 、 或 annotations 中设置属性来指定：namespaceredisNamespace@EnableRedisHttpSession@EnableRedisIndexedHttpSession@EnableRedisWebSessionspring-doc.cn

@EnableRedisHttpSession
@Configuration
@EnableRedisHttpSession(redisNamespace = "spring:session:myapplication")
public class SessionConfig {
    // ...
}
@EnableRedisIndexedHttpSession
@Configuration
@EnableRedisIndexedHttpSession(redisNamespace = "spring:session:myapplication")
public class SessionConfig {
    // ...
}
@EnableRedisWebSession
@Configuration
@EnableRedisWebSession(redisNamespace = "spring:session:myapplication")
public class SessionConfig {
    // ...
}

在 和 之间进行选择RedisSessionRepositoryRedisIndexedSessionRepository

使用 Spring Session Redis 时，您可能必须在 和 之间进行选择。 两者都是在 Redis 中存储会话数据的接口的实现。 但是，它们在处理会话索引和查询的方式上有所不同。RedisSessionRepositoryRedisIndexedSessionRepositorySessionRepositoryspring-doc.cn

  • RedisSessionRepository：是一种基本实现，可将会话数据存储在 Redis 中，而无需任何其他索引。 它使用简单的键值结构来存储会话属性。 每个会话都分配有一个唯一的会话 ID，会话数据存储在与该 ID 关联的 Redis 密钥下。 当需要检索会话时，存储库使用会话 ID 查询 Redis 以获取关联的会话数据。 由于没有索引，因此根据会话 ID 以外的属性或条件查询会话可能效率低下。RedisSessionRepositoryspring-doc.cn

  • RedisIndexedSessionRepository：是一种扩展实现，可为 Redis 中存储的会话提供索引功能。 它在 Redis 中引入了额外的数据结构，以根据属性或条件高效地查询会话。 除了 使用的键值结构之外，它还维护其他索引以实现快速查找。 例如，它可能会根据会话属性（如用户 ID 或上次访问时间）创建索引。 这些索引允许根据特定条件高效查询会话，从而提高性能并启用高级会话管理功能。 除此之外，还支持会话过期和删除。RedisIndexedSessionRepositoryRedisSessionRepositoryRedisIndexedSessionRepositoryspring-doc.cn

配置RedisSessionRepository

使用 Spring Boot 属性

如果您使用的是 Spring Boot，则这是默认实现。 但是，如果您想明确说明这一点，则可以在应用程序中设置以下属性：RedisSessionRepositoryspring-doc.cn

application.properties
spring.session.redis.repository-type=default
application.yml
spring:
  session:
    redis:
      repository-type: default

使用注释

您可以使用注释配置 ：RedisSessionRepository@EnableRedisHttpSessionspring-doc.cn

@Configuration
@EnableRedisHttpSession
public class SessionConfig {
    // ...
}

配置RedisIndexedSessionRepository

使用 Spring Boot 属性

您可以通过在应用程序中设置以下属性来配置 ：RedisIndexedSessionRepositoryspring-doc.cn

application.properties
spring.session.redis.repository-type=indexed
application.yml
spring:
  session:
    redis:
      repository-type: indexed

使用注释

您可以使用注释配置 ：RedisIndexedSessionRepository@EnableRedisIndexedHttpSessionspring-doc.cn

@Configuration
@EnableRedisIndexedHttpSession
public class SessionConfig {
    // ...
}

侦听会话事件

通常，对会话事件做出反应是有价值的，例如，您可能希望根据会话生命周期进行某种处理。 为了能够做到这一点，您必须使用索引存储库。 如果您不知道已编入索引的存储库和默认存储库之间的区别，可以转到此部分。spring-doc.cn

配置索引存储库后，您现在可以开始侦听 、 和 事件。 在 Spring 中有几种方法可以监听应用程序事件，我们将使用 Annotation。SessionCreatedEventSessionDeletedEventSessionDestroyedEventSessionExpiredEvent@EventListenerspring-doc.cn

@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
    }

}

查找特定用户的所有会话

通过检索特定用户的所有会话，您可以跨设备或浏览器跟踪用户的活动会话。 例如，您可以使用此信息进行会话管理，例如允许用户使特定会话无效或注销，或者根据用户的会话活动执行操作。spring-doc.cn

为此，首先您必须使用索引存储库，然后您可以注入接口，如下所示：FindByIndexNameSessionRepositoryspring-doc.cn

@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);
    }
}

在上面的示例中，你可以使用 method 来查找特定用户的所有会话，以及 method 来删除用户的特定会话。getSessionsremoveSessionspring-doc.cn