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

Spring Session - HttpSession(快速入门)

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

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

更新依赖项

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

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

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-jdbc</artifactId>
		<version>3.3.3</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 Filter,该 Servlet Filter 将实现替换为 Spring Session 支持的实现。 为此,请添加以下 Spring Configuration:HttpSessionspring-doc.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 该注解将创建一个名为 的 Spring Bean。 该 bean 实现 . 过滤器负责替换 Spring Session 支持的实现。 在这种情况下, Spring Session 由关系数据库提供支持。@EnableJdbcHttpSessionspringSessionRepositoryFilterFilterHttpSession
2 我们创建一个将 Spring Session 连接到 H2 数据库的嵌入式实例。 我们将 H2 数据库配置为使用 Spring Session 中包含的 SQL 脚本创建数据库表。dataSource
3 我们创建一个管理以前配置的事务的 .transactionManagerdataSource

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

Java Servlet 容器初始化

我们的 Spring 配置创建了一个名为 的 Spring Bean,它实现了 . 该 bean 负责将 替换为由 Spring Session 支持的自定义实现。springSessionRepositoryFilterFilterspringSessionRepositoryFilterHttpSessionspring-doc.cn

为了让我们发挥它的魔力, Spring 需要加载我们的 class。 最后,我们需要确保我们的 Servlet 容器(即 Tomcat)对每个请求都使用我们的容器。 幸运的是,Spring Session 提供了一个名为 的实用程序类,使这两个步骤都变得容易。 以下示例显示了如何执行此操作:FilterConfigspringSessionRepositoryFilterAbstractHttpSessionApplicationInitializerspring-doc.cn

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

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

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

多个数据源

Spring Session 提供了限定符,允许您显式声明应该注入哪个 bean。 这在应用程序上下文中存在多个 bean 的情况下特别有用。@SpringSessionDataSourceDataSourceJdbcIndexedSessionRepositoryDataSourcespring-doc.cn

以下示例显示了如何执行此操作:spring-doc.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-jdbcspring-doc.cn

运行示例应用程序httpsession-jdbc

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

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

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

探索示例应用程序httpsession-jdbc

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

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

它是如何工作的?

我们与以下清单中所示的标准进行交互:HttpSessionSessionServletspring-doc.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 的 ,而是将值保存在 H2 数据库中。 Spring Session 会创建一个在浏览器中命名的 cookie。 该 Cookie 包含会话的 ID。 您可以查看 Cookie(使用 ChromeFirefox)。HttpSessionSESSIONspring-doc.cn

如果您愿意,可以使用 H2 Web 控制台删除会话,网址为:localhost:8080/h2-console/(用于 JDBC URL)。jdbc:h2:mem:testdbspring-doc.cn

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