此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Session 3.3.1

此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Session 3.3.1

本指南介绍了如何使用 Spring Session 透明地利用关系数据库来支持具有 Java 配置的 Web 应用程序。HttpSession

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

更新依赖项

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

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

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-jdbc</artifactId>
		<version>3.1.7-SNAPSHOT</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>6.0.20</version>
	</dependency>
</dependencies>

Spring Java 配置

添加所需的依赖项后,我们可以创建 Spring 配置。 Spring 配置负责创建一个 Servlet 过滤器,该过滤器将实现替换为 Spring Session 支持的实现。 为此,请添加以下 Spring 配置:HttpSession

@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 参考文档

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

Java Servlet 容器初始化

我们的 Spring Configuration 创建了一个名为 的 Spring Bean,用于实现 . Bean 负责用 Spring Session 支持的自定义实现替换 bean。springSessionRepositoryFilterFilterspringSessionRepositoryFilterHttpSession

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

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

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

}
我们类的名称(初始值设定项)无关紧要。 重要的是我们扩展.AbstractHttpSessionApplicationInitializer
1 第一步是扩展 . 这样做可以确保每个请求都向 Servlet 容器注册名为 Spring bean。AbstractHttpSessionApplicationInitializerspringSessionRepositoryFilter
2 AbstractHttpSessionApplicationInitializer还提供了一种机制来确保 Spring 加载我们的 .Config
我们类的名称(初始值设定项)无关紧要。 重要的是我们扩展.AbstractHttpSessionApplicationInitializer
1 第一步是扩展 . 这样做可以确保每个请求都向 Servlet 容器注册名为 Spring bean。AbstractHttpSessionApplicationInitializerspringSessionRepositoryFilter
2 AbstractHttpSessionApplicationInitializer还提供了一种机制来确保 Spring 加载我们的 .Config

多个数据源

Spring Session 提供了限定符,允许您显式声明应该在 中注入哪个 Bean。 这在应用程序上下文中存在多个 Bean 的场景中特别有用。@SpringSessionDataSourceDataSourceJdbcIndexedSessionRepositoryDataSource

以下示例演示如何执行此操作:

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 此限定符声明 springSession 将使用 firstDataSource。
1 此限定符声明 springSession 将使用 firstDataSource。

httpsession-jdbc示例应用程序

本节介绍如何使用示例应用程序。httpsession-jdbc

运行示例应用程序httpsession-jdbc

可以通过获取源代码并调用以下命令来运行示例:

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

您现在应该能够在 localhost:8080/ 访问该应用程序

探索示例应用程序httpsession-jdbc

现在您可以尝试使用该应用程序。为此,请在表格中填写以下信息:

  • 属性名称:用户名

  • 属性值:rob

现在单击“设置属性”按钮。现在,您应该会看到表中显示的值。

它是如何工作的?

我们与以下列表中所示的标准进行交互:HttpSessionSessionServlet

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 的 ,而是将这些值保留在 H2 数据库中。 Spring Session 会在您的浏览器中创建一个名为 cookie。 该 Cookie 包含您的会话的 ID。 您可以查看 cookie(使用 ChromeFirefox)。HttpSessionSESSION

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

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