对于最新的稳定版本,请使用 Spring Session 3.5.2spring-doc.cadn.net.cn

WebSession 集成

Spring Session 提供与 Spring WebFlux 的透明集成WebSession. 这意味着您可以切换WebSession使用 Spring Session 支持的实现。spring-doc.cadn.net.cn

为什么选择 Spring Session 和 WebSession?

我们已经提到 Spring Session 提供了与 Spring WebFlux 的WebSession,但我们从中得到了什么好处呢? 与HttpSession,Spring Session 使支持集群会话变得微不足道,而无需绑定到特定于应用程序容器的解决方案。spring-doc.cadn.net.cn

使用 Redis 的 WebSession

将 Spring Session 与WebSession通过注册WebSessionManager由 Spring Session 的ReactiveSessionRepository. Spring 配置负责创建一个WebSessionManagerWebSession实现,由 Spring Session 支持的实现。 为此,请添加以下 Spring 配置:spring-doc.cadn.net.cn

@EnableRedisWebSession (1)
public class SessionConfiguration {

	@Bean
	public LettuceConnectionFactory redisConnectionFactory() {
		return new LettuceConnectionFactory(); (2)
	}

}
1 @EnableRedisWebSession注释创建一个名称为webSessionManager.该 bean 实现了WebSessionManager. 这是负责替换WebSession由 Spring Session 支持的实现。 在这种情况下,Spring Session 由 Redis 支持。
2 我们创建一个RedisConnectionFactory将 Spring Session 连接到 Redis 服务器。 我们将连接配置为连接到默认端口 (6379) 上的本地主机 有关配置 Spring Data Redis 的更多信息,请参阅参考文档

WebSession 集成的工作原理

Spring Session 与 Spring WebFlux 及其WebSession,与 Servlet API 及其HttpSession. Spring WebFlux 提供了WebSessionStoreAPI,它提供了一种持久化策略WebSession.spring-doc.cadn.net.cn

本节介绍 Spring Session 如何提供透明的集成WebSession.我们提供此内容是为了让您了解幕后发生的事情。此功能已集成,您无需自己实现此逻辑。

首先,我们创建一个自定义SpringSessionWebSession代表Spring Session的Session. 它看起来像下面:spring-doc.cadn.net.cn

public class SpringSessionWebSession implements WebSession {

	enum State {
		NEW, STARTED
	}

	private final S session;

	private AtomicReference<State> state = new AtomicReference<>();

	SpringSessionWebSession(S session, State state) {
		this.session = session;
		this.state.set(state);
	}

	@Override
	public void start() {
		this.state.compareAndSet(State.NEW, State.STARTED);
	}

	@Override
	public boolean isStarted() {
		State value = this.state.get();
		return (State.STARTED.equals(value)
				|| (State.NEW.equals(value) && !this.session.getAttributes().isEmpty()));
	}

	@Override
	public Mono<Void> changeSessionId() {
		return Mono.defer(() -> {
			this.session.changeSessionId();
			return save();
		});
	}

	// ... other methods delegate to the original Session
}

接下来,我们创建一个自定义WebSessionStore将委托给ReactiveSessionRepository和包裹Session进入定制WebSession实现,如以下列表所示:spring-doc.cadn.net.cn

public class SpringSessionWebSessionStore<S extends Session> implements WebSessionStore {

	private final ReactiveSessionRepository<S> sessions;

	public SpringSessionWebSessionStore(ReactiveSessionRepository<S> reactiveSessionRepository) {
		this.sessions = reactiveSessionRepository;
	}

	// ...
}

要由 Spring WebFlux 检测,此自定义WebSessionStore需要注册ApplicationContext作为名为webSessionManager. 有关 Spring WebFlux 的更多信息,请参阅 Spring Framework 参考文档spring-doc.cadn.net.cn