该版本仍在开发中,尚未被视为稳定。最新稳定版请使用Spring Session 3.5.3spring-doc.cadn.net.cn

春季课程 - HttpSession(快速入门)

本指南介绍了如何利用 Spring Session 透明地利用 Redis 来支持网页应用HttpSession使用Java Configuration。spring-doc.cadn.net.cn

你可以在 httpsession 示例应用中找到完成的指南。

更新依赖关系

在使用春季会话之前,您必须更新依赖。 如果你使用Maven,必须添加以下依赖关系:spring-doc.cadn.net.cn

pom.xml
<dependencies>
	<!-- ... -->

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-data-redis</artifactId>
		<version>3.5.4-SNAPSHOT</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>io.lettuce</groupId>
		<artifactId>lettuce-core</artifactId>
		<version>6.5.5.RELEASE</version>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>6.2.12</version>
	</dependency>
</dependencies>

由于我们使用的是 SNAPSHOT 版本,我们需要确保添加 Spring Snapshot Maven 仓库。 你的pom.xml必须具备以下内容:spring-doc.cadn.net.cn

pom.xml
<repositories>

	<!-- ... -->

	<repository>
		<id>spring-snapshot</id>
		<url>https://repo.spring.io/libs-snapshot</url>
	</repository>
</repositories>

Spring Java 配置

添加所需的依赖后,我们可以创建 Spring 配置。 Spring配置负责创建一个servletFilter,以替换HttpSession实现时,Spring Session支持的实现。 为此,添加以下Spring配置:spring-doc.cadn.net.cn

@Configuration(proxyBeanMethods = false)
@EnableRedisHttpSession (1)
public class Config {

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

}
1 @EnableRedisHttpSession注释生成一个名为springSessionRepositoryFilter实现Filter. 过滤器负责更换HttpSession实施将由Spring Session支持。 这次,Spring Session 得到了 Redis 的支持。
2 我们创建一个RedisConnection工厂它将 Spring Session 连接到 Redis 服务器。 我们配置连接连接到默认端口(6379)的本地主机。 有关配置 Spring Data Redis 的更多信息,请参阅参考文档

Java Servlet 容器初始化

我们的Spring配置创建了一个名为springSessionRepositoryFilter实现Filter. 这springSessionRepositoryFilterBean负责替换HttpSession并采用由 Spring Session 支持的自定义实现。spring-doc.cadn.net.cn

为了我们的Filter要施展它的魔力,Spring需要加载我们的配置类。 最后,我们需要确保我们的Servlet容器(即Tomcat)使用我们的springSessionRepositoryFilter每一个请求。 幸运的是,Spring Session 提供了一个名为AbstractHttpSessionApplicationInitializer让这两个步骤都变得简单。 以下是一个例子:spring-doc.cadn.net.cn

src/main/java/sample/Initializer.java
public class Initializer extends AbstractHttpSessionApplicationInitializer { (1)

	public Initializer() {
		super(Config.class); (2)
	}

}
我们班的名称(初始 化)并不重要。重要的是我们要延展AbstractHttpSessionApplicationInitializer.
1 第一步是延长AbstractHttpSessionApplicationInitializer. 这样做确保了名为springSessionRepositoryFilter在我们的Servlet容器中注册了所有请求。
2 AbstractHttpSessionApplicationInitializer还提供了确保Spring载荷的机制配置.

httpsession 示例应用

运行httpsession示例应用

您可以通过获取源代码并调用以下命令来运行示例:spring-doc.cadn.net.cn

$ ./gradlew :spring-session-sample-javaconfig-redis:tomcatRun
为了让样本正常工作,你必须在localhost上安装Redis 2.8+,并用默认端口(6379)运行。 或者,你也可以更新RedisConnection工厂指向一个Redis服务器。 另一个选择是用 Docker 在 localhost 上运行 Redis。 详见 Docker Redis 仓库中的详细说明。

你现在应该可以在localhost:8080/访问该应用了spring-doc.cadn.net.cn

探索httpsession示例应用

现在你可以尝试使用这个应用。填写表格时需填写以下信息:spring-doc.cadn.net.cn

现在点击设置属性按钮。你现在应该能在表格中看到显示的数值。spring-doc.cadn.net.cn

它是如何运作的?

我们与标准互动HttpSessionSessionServlet如下列表所示:spring-doc.cadn.net.cn

src/main/java/sample/SessionServlet.java
@WebServlet("/session")
public class SessionServlet extends HttpServlet {

	@Override
	protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {
		String attributeName = req.getParameter("attributeName");
		String attributeValue = req.getParameter("attributeValue");
		req.getSession().setAttribute(attributeName, attributeValue);
		resp.sendRedirect(req.getContextPath() + "/");
	}

	private static final long serialVersionUID = 2878267318695777395L;

}

而不是用Tomcat的HttpSession,我们在Redis中保持这些值。 Spring Session 创建了一个名为会期在你的浏览器里。 这个Cookie里包含了你会话的ID。 你可以查看这些Cookie(使用ChromeFirefox)。spring-doc.cadn.net.cn

你可以用redis-cli删除该会话。 例如,在基于Linux的系统上,你可以输入以下内容:spring-doc.cadn.net.cn

	$ redis-cli keys '*' | xargs redis-cli del
Redis 文档中有安装 redis-cli 的说明。

或者,你也可以删除显式密钥。在终端输入以下内容,确保替换7E8383A4-082C-4fFE-A4BC-C40FD3363C5E以您的SESSION cookie值表示:spring-doc.cadn.net.cn

	$ redis-cli del spring:session:sessions:7e8383a4-082c-4ffe-a4bc-c40fd3363c5e

现在你可以访问 localhost:8080/ 的应用程序,看到我们添加的属性已不再显示。spring-doc.cadn.net.cn