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

Spring Session - HttpSession(快速入门)

本指南描述了如何使用 Spring Session 透明地利用关系数据库来支持 Web 应用程序的HttpSession使用 Java 配置。spring-doc.cadn.net.cn

您可以在 httpsession-jdbc 示例应用程序中找到完整的指南。

更新依赖项

在使用 Spring Session 之前,您必须更新依赖项。 如果您使用 Maven,则必须添加以下依赖项:spring-doc.cadn.net.cn

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

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-jdbc</artifactId>
		<version>3.2.7</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>6.1.14</version>
	</dependency>
</dependencies>

Spring Java 配置

添加所需的依赖项后,我们可以创建 Spring 配置。 Spring 配置负责创建一个 Servlet 过滤器,该过滤器将HttpSessionimplementation 替换为 Spring Session 支持的 implementation。 为此,请添加以下 Spring Configuration:spring-doc.cadn.net.cn

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

	@Bean
	public EmbeddedDatabase dataSource() {
		return new EmbeddedDatabaseBuilder() (2)
			.setType(EmbeddedDatabaseType.H2)
			.addScript("org/springframework/session/jdbc/schema-h2.sql")
			.build();
	}

	@Bean
	public PlatformTransactionManager transactionManager(DataSource dataSource) {
		return new DataSourceTransactionManager(dataSource); (3)
	}

}
1 @EnableJdbcHttpSessionannotation 会创建一个名称为springSessionRepositoryFilter. 该 bean 实现Filter. 过滤器负责替换HttpSession实现,由 Spring Session 支持。 在这种情况下, Spring Session 由关系数据库提供支持。
2 我们创建一个dataSource将 Spring Session 连接到 H2 数据库的嵌入式实例。 我们将 H2 数据库配置为使用 Spring Session 中包含的 SQL 脚本创建数据库表。
3 我们创建一个transactionManager管理先前配置的事务dataSource.

有关如何配置数据访问相关关注点的更多信息,请参阅 Spring Framework 参考文档spring-doc.cadn.net.cn

Java Servlet 容器初始化

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

为了我们的Filter为了发挥它的魔力,Spring 需要加载我们的Config类。 最后,我们需要确保我们的 Servlet 容器(即 Tomcat)使用我们的springSessionRepositoryFilter对于每个请求。 幸运的是,Spring Session 提供了一个名为AbstractHttpSessionApplicationInitializer使这两个步骤都变得简单。 以下示例显示了如何执行此作:spring-doc.cadn.net.cn

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

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

}
我们的类 (Initializer) 的名称无关紧要。 重要的是,我们扩展AbstractHttpSessionApplicationInitializer.
1 第一步是扩展AbstractHttpSessionApplicationInitializer. 这样做可以确保名为springSessionRepositoryFilter对于每个请求,都在我们的 Servlet 容器中注册。
2 AbstractHttpSessionApplicationInitializer还提供了一种机制来确保 Spring 加载我们的Config.

多个数据源

Spring Session 提供了@SpringSessionDataSource限定符,允许您显式声明哪个DataSourcebean 应该注入JdbcIndexedSessionRepository. 这在具有多个DataSource存在于应用程序上下文中的 bean。spring-doc.cadn.net.cn

以下示例显示了如何执行此作:spring-doc.cadn.net.cn

Config.java
@EnableJdbcHttpSession
public class Config {

	@Bean
	@SpringSessionDataSource (1)
	public EmbeddedDatabase firstDataSource() {
		return new EmbeddedDatabaseBuilder()
				.setType(EmbeddedDatabaseType.H2).addScript("org/springframework/session/jdbc/schema-h2.sql").build();
	}

	@Bean
	public HikariDataSource secondDataSource() {
		// ...
	}
}
1 此限定符声明 firstDataSource 将由 Spring Session 使用。

httpsession-jdbc示例应用程序

本节介绍如何使用httpsession-jdbc示例应用程序。spring-doc.cadn.net.cn

运行httpsession-jdbc示例应用程序

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

$ ./gradlew :spring-session-sample-javaconfig-jdbc:tomcatRun

您现在应该能够访问 localhost:8080/ 中的应用程序spring-doc.cadn.net.cn

探索httpsession-jdbc示例应用程序

现在您可以尝试使用该应用程序。为此,请在表格中填写以下信息:spring-doc.cadn.net.cn

现在单击 Set Attribute 按钮。您现在应该会看到表中显示的值。spring-doc.cadn.net.cn

它是如何工作的?

我们与标准HttpSessionSessionServlet如下面的清单所示:spring-doc.cadn.net.cn

来源/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,我们将值保存在 H2 数据库中。 Spring Session 会创建一个名为SESSION在浏览器中。 该 Cookie 包含会话的 ID。 您可以查看 Cookie(使用 ChromeFirefox)。spring-doc.cadn.net.cn

如果您愿意,可以使用以下网址提供的 H2 Web 控制台删除会话:localhost:8080/h2-console/(使用jdbc:h2:mem:testdb(对于 JDBC URL)。spring-doc.cadn.net.cn

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