Spring Session - HttpSession（快速入门）
本指南描述了如何使用 Spring Session，通过 Java 配置，透明地利用关系型数据库来支持 Web 应用程序的 HttpSession。
| 您可以在 httpsession-jdbc 示例应用程序中找到完整的指南。 |
更新依赖项
在使用 Spring Session 之前，必须更新你的依赖项。如果你使用 Maven，则必须添加以下依赖项
<dependencies>
<!-- ... -->
<dependency>
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-jdbc</artifactId>
<version>3.5.3</version>
<type>pom</type>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>6.2.12</version>
</dependency>
</dependencies>Spring Java 配置
添加必要的依赖后，我们可以创建 Spring 配置。Spring 配置负责创建一个 Servlet 过滤器，该过滤器将 HttpSession 实现替换为由 Spring Session 支持的实现。为此，请添加以下 Spring 配置
@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 | @EnableJdbcHttpSession 注解会创建一个名为 springSessionRepositoryFilter 的 Spring Bean。该 Bean 实现了 Filter 接口。此过滤器负责将 HttpSession 实现替换为由 Spring Session 支持的实现。在此示例中，Spring Session 由关系型数据库支持。 |
| 2 | 我们创建了一个 dataSource，它将 Spring Session 连接到 H2 数据库的嵌入式实例。我们配置 H2 数据库，使其使用 Spring Session 中包含的 SQL 脚本来创建数据库表。 |
| 3 | 我们创建一个 transactionManager，它管理之前配置的 dataSource 的事务。 |
有关如何配置数据访问相关内容的更多信息，请参阅 Spring Framework 参考文档。
Java Servlet 容器初始化
我们的 Spring 配置创建了一个名为 springSessionRepositoryFilter 的 Spring bean，它实现了 Filter 接口。springSessionRepositoryFilter bean 负责将 HttpSession 替换为由 Spring Session 支持的自定义实现。
为了让我们的 Filter 发挥作用，Spring 需要加载我们的 Config 类。最后，我们需要确保我们的 Servlet 容器（即 Tomcat）为每个请求使用我们的 springSessionRepositoryFilter。幸运的是，Spring Session 提供了一个名为 AbstractHttpSessionApplicationInitializer 的实用程序类，可以轻松完成这两个步骤。以下示例展示了如何实现：
public class Initializer extends AbstractHttpSessionApplicationInitializer { (1)
public Initializer() {
super(Config.class); (2)
}
}我们类的名称（Initializer）无关紧要。重要的是我们扩展了 AbstractHttpSessionApplicationInitializer。 |
| 1 | 第一步是扩展 AbstractHttpSessionApplicationInitializer。这样做可以确保名为 springSessionRepositoryFilter 的 Spring bean 为每个请求注册到我们的 Servlet 容器中。 |
| 2 | AbstractHttpSessionApplicationInitializer 还提供了一种机制来确保 Spring 加载我们的 Config。 |
多个数据源
Spring Session 提供 @SpringSessionDataSource 限定符，允许您明确声明应注入 JdbcIndexedSessionRepository 的 DataSource bean。这在应用程序上下文中存在多个 DataSource bean 的情况下特别有用。
以下示例展示了如何实现：
@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 示例应用程序。
运行 httpsession-jdbc 示例应用程序
您可以通过获取源代码并调用以下命令来运行示例：
$ ./gradlew :spring-session-sample-javaconfig-jdbc:tomcatRun
您现在应该能够通过 localhost:8080/ 访问该应用程序
探索 httpsession-jdbc 示例应用程序
现在您可以尝试使用该应用程序。为此，请填写以下信息：
-
属性名称： username
-
属性值： rob
现在点击 设置属性 按钮。您现在应该会在表格中看到显示的值。
它是如何工作的？
我们在 SessionServlet 中与标准 HttpSession 进行交互，如下所示：
@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。该 Cookie 包含您会话的 ID。您可以查看 Cookie（使用 Chrome 或 Firefox）。
如果您愿意，可以使用 H2 Web 控制台删除会话，该控制台位于：localhost:8080/h2-console/（JDBC URL 使用 jdbc:h2:mem:testdb）。
现在你可以访问应用程序 localhost:8080/，你会发现我们添加的属性不再显示。
