HttpSession 集成 (HttpSession Integration) | Spring Session3.3.6中文文档|Spring官方文档|SpringBoot 教程|Spring中文网

为什么选择 Spring Session 和`HttpSession`?

我们已经提到 Spring Session 提供了与HttpSession，但我们从中得到了什么好处呢？spring-doc.cadn.net.cn

集群会话：Spring Session 使支持集群会话变得轻而易举，而无需绑定到特定于应用程序容器的解决方案。spring-doc.cadn.net.cn
RESTful API：Spring Session 允许在标头中提供会话 ID 与 RESTful API 一起使用spring-doc.cadn.net.cn

`HttpSession`使用 Redis

将 Spring Session 与结合使用HttpSession通过在使用HttpSession. 您可以使用以下任一方式选择启用此功能：spring-doc.cadn.net.cn

Redis 基于 Java 的配置

本节介绍如何使用 Redis 进行备份HttpSession通过使用基于 Java 的配置。spring-doc.cadn.net.cn

HttpSession 示例提供了如何集成 Spring Session 和HttpSession通过使用 Java 配置。您可以在接下来的几节中阅读集成的基本步骤，但我们鼓励您在与自己的应用程序集成时遵循详细的 HttpSession 指南。

Spring Java 配置

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

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

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

}

1	这`@EnableRedisHttpSession`annotation 会创建一个名称为`springSessionRepositoryFilter`实现`Filter`. 过滤器负责替换`HttpSession`实现，由 Spring Session 支持。在这种情况下， Spring Session 由 Redis 提供支持。
2	我们创建一个`RedisConnectionFactory`将 Spring Session 连接到 Redis 服务器。我们将连接配置为连接到默认端口（6379）上的 localhost。有关配置 Spring Data Redis 的更多信息，请参阅参考文档。

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`.

Redis 基于 XML 的配置

本节介绍如何使用 Redis 进行备份HttpSession通过使用基于 XML 的配置。spring-doc.cadn.net.cn

HttpSession XML 示例提供了如何将 Spring Session 和HttpSession使用 XML 配置。您可以在接下来的几节中阅读集成的基本步骤，但我们鼓励您在与自己的应用程序集成时遵循详细的 HttpSession XML 指南。

Spring XML 配置

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

来源/main/webapp/WEB-INF/spring/session.xml

(1)
<context:annotation-config/>
<bean class="org.springframework.session.data.redis.config.annotation.web.http.RedisHttpSessionConfiguration"/>

(2)
<bean class="org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory"/>

1	我们使用`<context:annotation-config/>`和`RedisHttpSessionConfiguration`因为 Spring Session 尚不提供 XML 名称空间支持（参见 gh-104）。这将创建一个名称为`springSessionRepositoryFilter`实现`Filter`. 过滤器负责替换`HttpSession`实现，由 Spring Session 支持。在这种情况下， Spring Session 由 Redis 提供支持。
2	我们创建一个`RedisConnectionFactory`将 Spring Session 连接到 Redis 服务器。我们将连接配置为连接到默认端口上的 localhost （6379）有关配置 Spring Data Redis 的更多信息，请参阅参考文档。

XML Servlet 容器初始化

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

为了我们的Filter为了发挥它的魔力，我们需要指示 Spring 加载我们的session.xml配置。我们可以使用以下配置来做到这一点：spring-doc.cadn.net.cn

来源/main/webapp/WEB-INF/web.xml

<context-param>
	<param-name>contextConfigLocation</param-name>
	<param-value>
		/WEB-INF/spring/session.xml
	</param-value>
</context-param>
<listener>
	<listener-class>
		org.springframework.web.context.ContextLoaderListener
	</listener-class>
</listener>

这ContextLoaderListener读取 contextConfigLocation 并选取我们的 session.xml 配置。spring-doc.cadn.net.cn

最后，我们需要确保我们的 Servlet 容器（即 Tomcat）使用我们的springSessionRepositoryFilter对于每个请求。以下代码片段为我们执行了最后一步：spring-doc.cadn.net.cn

来源/main/webapp/WEB-INF/web.xml

<filter>
	<filter-name>springSessionRepositoryFilter</filter-name>
	<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
</filter>
<filter-mapping>
	<filter-name>springSessionRepositoryFilter</filter-name>
	<url-pattern>/*</url-pattern>
	<dispatcher>REQUEST</dispatcher>
	<dispatcher>ERROR</dispatcher>
</filter-mapping>

这DelegatingFilterProxy查找名称为springSessionRepositoryFilter并将其转换为Filter. 对于每个请求DelegatingFilterProxy时，将springSessionRepositoryFilter被调用。spring-doc.cadn.net.cn

使用 Mongo 的 HttpSession

将 Spring Session 与结合使用HttpSession通过在使用HttpSession.spring-doc.cadn.net.cn

本节介绍如何使用 Mongo 进行 back作HttpSession使用基于 Java 的配置。spring-doc.cadn.net.cn

HttpSession Mongo 示例提供了有关如何集成 Spring Session 和HttpSession使用 Java 配置。您可以阅读下面的集成基本步骤，但建议您在与自己的应用程序集成时遵循详细的 HttpSession 指南。

您所要做的就是添加以下 Spring Configuration：spring-doc.cadn.net.cn

@Configuration(proxyBeanMethods = false)
@EnableMongoHttpSession (1)
public class HttpSessionConfig {

	@Bean
	public JdkMongoSessionConverter jdkMongoSessionConverter() {
		return new JdkMongoSessionConverter(Duration.ofMinutes(30)); (2)
	}

}

1	这`@EnableMongoHttpSession`annotation 会创建一个名称为`springSessionRepositoryFilter`实现 Filter 的 Filter。此过滤器将替换默认的`HttpSession`替换为 MongoDB 支持的 bean。
2	将会话超时配置为 30 分钟。

会话序列化机制

为了能够在 MongoDB 中持久化会话对象，我们需要提供序列化/反序列化机制。spring-doc.cadn.net.cn

默认情况下，Spring Session MongoDB 将使用JdkMongoSessionConverter.spring-doc.cadn.net.cn

但是，您可以切换到JacksonMongoSessionConverter只需将以下代码添加到您的 Boot 应用程序即可：spring-doc.cadn.net.cn

@Bean
JacksonMongoSessionConverter mongoSessionConverter() {
    return new JacksonMongoSessionConverter();
}

JacksonMongoSession转换器

此机制使用 Jackson 将会话对象序列化为 JSON 或从 JSON 序列化会话对象。spring-doc.cadn.net.cn

通过创建以下 Bean：spring-doc.cadn.net.cn

@Bean
JacksonMongoSessionConverter mongoSessionConverter() {
    return new JacksonMongoSessionConverter();
}

…您可以从默认（基于 JDK 的序列化）切换到使用 Jackson。spring-doc.cadn.net.cn

如果要与 Spring Security 集成（通过将会话存储在 MongoDB 中），则此配置将注册适当的白名单组件，以便 Spring Security 正常工作。

如果您想提供自定义 Jackson 模块，您可以通过显式注册模块来实现，如下所示：spring-doc.cadn.net.cn

Unresolved include directive in modules/ROOT/pages/http-session.adoc - include::example$spring-session-data-mongodb-dir/src/integration-test/java/org/springframework/session/data/mongo/integration/MongoRepositoryJacksonITest.java[]

JdkMongoSession转换器

JdkMongoSessionConverter使用标准 Java 序列化以二进制形式保留到 MongoDB 的会话属性映射。但是，id 、 access time 等标准 session 元素仍然作为普通的 Mongo 对象写入，无需额外工作即可读取和查询。JdkMongoSessionConverter如果没有显式的AbstractMongoSessionConverterBean 已定义。spring-doc.cadn.net.cn

还有一个构造函数采用Serializer和Deserializer对象，允许您传递自定义实现，这在您想要使用非默认 ClassLoader 时尤其重要。spring-doc.cadn.net.cn

`HttpSession`使用 JDBC

您可以将 Spring Session 与HttpSession通过在使用HttpSession. 您可以选择通过以下任一方式执行：spring-doc.cadn.net.cn

基于 Java 的 JDBC 配置

本节介绍如何使用关系数据库进行备份HttpSession当您使用基于 Java 的配置时。spring-doc.cadn.net.cn

HttpSession JDBC 示例提供了如何将 Spring Session 和HttpSession通过使用 Java 配置。您可以在接下来的几节中阅读集成的基本步骤，但我们鼓励您在与自己的应用程序集成时遵循详细的 HttpSession JDBC 指南。

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	这`@EnableJdbcHttpSession`annotation 会创建一个名称为`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 使用。

基于 JDBC XML 的配置

本节介绍如何使用关系数据库进行备份HttpSession当您使用基于 XML 的配置时。spring-doc.cadn.net.cn

HttpSession JDBC XML 示例提供了如何将 Spring Session 和HttpSession通过使用 XML 配置。您可以在接下来的几节中阅读集成的基本步骤，但我们鼓励您在与自己的应用程序集成时遵循详细的 HttpSession JDBC XML 指南。

Spring XML 配置

添加所需的依赖项后，我们可以创建 Spring 配置。 Spring 配置负责创建一个 servlet 过滤器，该过滤器将HttpSessionimplementation 替换为 Spring Session 支持的 implementation。下面的清单显示了如何添加以下 Spring Configuration：spring-doc.cadn.net.cn

来源/main/webapp/WEB-INF/spring/session.xml

(1)
<context:annotation-config/>
<bean class="org.springframework.session.jdbc.config.annotation.web.http.JdbcHttpSessionConfiguration"/>

(2)
<jdbc:embedded-database id="dataSource" database-name="testdb" type="H2">
	<jdbc:script location="classpath:org/springframework/session/jdbc/schema-h2.sql"/>
</jdbc:embedded-database>

(3)
<bean class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
	<constructor-arg ref="dataSource"/>
</bean>

1	我们使用`<context:annotation-config/>`和`JdbcHttpSessionConfiguration`因为 Spring Session 尚不提供 XML 名称空间支持（参见 gh-104）。这将创建一个名称为`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

XML Servlet 容器初始化

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

为了我们的Filter为了发挥它的魔力，我们需要指示 Spring 加载我们的session.xml配置。我们使用以下配置执行此作：spring-doc.cadn.net.cn

来源/main/webapp/WEB-INF/web.xml

<context-param>
	<param-name>contextConfigLocation</param-name>
	<param-value>
		/WEB-INF/spring/session.xml
	</param-value>
</context-param>
<listener>
	<listener-class>
		org.springframework.web.context.ContextLoaderListener
	</listener-class>
</listener>

这ContextLoaderListener读取contextConfigLocation并选取我们的 session.xml 配置。spring-doc.cadn.net.cn

最后，我们需要确保我们的 Servlet 容器（即 Tomcat）使用我们的springSessionRepositoryFilter对于每个请求。以下代码片段为我们执行了最后一步：spring-doc.cadn.net.cn

来源/main/webapp/WEB-INF/web.xml

<filter>
	<filter-name>springSessionRepositoryFilter</filter-name>
	<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
</filter>
<filter-mapping>
	<filter-name>springSessionRepositoryFilter</filter-name>
	<url-pattern>/*</url-pattern>
	<dispatcher>REQUEST</dispatcher>
	<dispatcher>ERROR</dispatcher>
</filter-mapping>

这DelegatingFilterProxy查找名为springSessionRepositoryFilter并将其转换为Filter. 对于每个DelegatingFilterProxy时，将springSessionRepositoryFilter被调用。spring-doc.cadn.net.cn

基于 JDBC Spring Boot 的配置

本节介绍如何使用关系数据库进行备份HttpSession当您使用 Spring Boot 时。spring-doc.cadn.net.cn

HttpSession JDBC Spring Boot 示例提供了如何将 Spring Session 和HttpSession通过使用 Spring Boot。您可以在接下来的几节中阅读集成的基本步骤，但我们鼓励您在与自己的应用程序集成时遵循详细的 HttpSession JDBC Spring Boot Guide。

Spring Boot 配置

添加所需的依赖项后，我们可以创建 Spring Boot 配置。多亏了一流的自动配置支持，只需添加依赖项 Spring Boot 就可以为我们设置由关系数据库支持的 Spring Session。spring-doc.cadn.net.cn

如果 Classpath 上存在单个 Spring Session 模块，则 Spring Boot 会自动使用该 store 实现。如果您有多个实施，则必须选择要用于存储会话的 StoreType，如上所示。spring-doc.cadn.net.cn

在后台，Spring Boot 应用等效于手动添加@EnableJdbcHttpSession注解。这将创建一个名称为springSessionRepositoryFilter.该 bean 实现Filter. 过滤器负责替换HttpSession实现，由 Spring Session 支持。spring-doc.cadn.net.cn

您可以使用application.properties. 下面的清单显示了如何做到这一点：spring-doc.cadn.net.cn

src/main/resources/application.properties

server.servlet.session.timeout= # Session timeout. If a duration suffix is not specified, seconds are used.
spring.session.jdbc.initialize-schema=embedded # Database schema initialization mode.
spring.session.jdbc.schema=classpath:org/springframework/session/jdbc/schema-@@platform@@.sql # Path to the SQL file to use to initialize the database schema.
spring.session.jdbc.table-name=SPRING_SESSION # Name of the database table used to store sessions.

有关更多信息，请参阅 Spring Boot 文档的 Spring Session 部分。spring-doc.cadn.net.cn

配置`DataSource`

Spring Boot 会自动创建一个DataSource将 Spring Session 连接到 H2 数据库的嵌入式实例。在生产环境中，您需要更新配置以指向关系数据库。例如，您可以在 application.properties 中包含以下内容：spring-doc.cadn.net.cn

src/main/resources/application.properties

spring.datasource.url= # JDBC URL of the database.
spring.datasource.username= # Login username of the database.
spring.datasource.password= # Login password of the database.

有关更多信息，请参阅 Spring Boot 文档的 Configure a DataSource 部分。spring-doc.cadn.net.cn

Servlet 容器初始化

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

为了我们的Filter为了发挥它的魔力，Spring 需要加载我们的Config类。最后，我们需要确保我们的 Servlet 容器（即 Tomcat）使用我们的springSessionRepositoryFilter对于每个请求。幸运的是，Spring Boot 为我们处理了这两个步骤。spring-doc.cadn.net.cn

HttpSession 与 Hazelcast

将 Spring Session 与结合使用HttpSession通过在使用HttpSession.spring-doc.cadn.net.cn

本节介绍如何使用 Hazelcast 进行备份HttpSession使用基于 Java 的配置。spring-doc.cadn.net.cn

Hazelcast Spring Sample 提供了一个工作样例，说明如何将 Spring Session 和HttpSession通过使用 Java 配置。您可以在接下来的几节中阅读集成的基本步骤，但我们鼓励您在与自己的应用程序集成时遵循详细的 Hazelcast Spring Guide。

Spring 配置

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

@EnableHazelcastHttpSession (1)
@Configuration
public class HazelcastHttpSessionConfig {

	@Bean
	public HazelcastInstance hazelcastInstance() {
		Config config = new Config();
		AttributeConfig attributeConfig = new AttributeConfig()
			.setName(HazelcastIndexedSessionRepository.PRINCIPAL_NAME_ATTRIBUTE)
			.setExtractorClassName(PrincipalNameExtractor.class.getName());
		config.getMapConfig(HazelcastIndexedSessionRepository.DEFAULT_SESSION_MAP_NAME) (2)
			.addAttributeConfig(attributeConfig)
			.addIndexConfig(
					new IndexConfig(IndexType.HASH, HazelcastIndexedSessionRepository.PRINCIPAL_NAME_ATTRIBUTE));
		SerializerConfig serializerConfig = new SerializerConfig();
		serializerConfig.setImplementation(new HazelcastSessionSerializer()).setTypeClass(MapSession.class);
		config.getSerializationConfig().addSerializerConfig(serializerConfig); (3)
		return Hazelcast.newHazelcastInstance(config); (4)
	}

}

1	这`@EnableHazelcastHttpSession`annotation 会创建一个名为`springSessionRepositoryFilter`实现`Filter`. 过滤器负责替换`HttpSession`实现，由 Spring Session 支持。在这种情况下，Spring Session 由 Hazelcast 提供支持。
2	为了支持按主体名称索引检索会话，适当的`ValueExtractor`需要注册。 Spring Session 提供`PrincipalNameExtractor`为此目的。
3	为了序列化`MapSession`对象，`HazelcastSessionSerializer`需要注册。如果此未设置，则 Hazelcast 将使用本机 Java 序列化序列化会话。
4	我们创建一个`HazelcastInstance`将 Spring Session 连接到 Hazelcast。默认情况下，应用程序启动并连接到 Hazelcast 的嵌入式实例。有关配置 Hazelcast 的更多信息，请参阅参考文档。

如果HazelcastSessionSerializer是首选的，则需要在启动之前为所有 Hazelcast 集群成员配置它。在 Hazelcast 集群中，所有成员都应为会话使用相同的序列化方法。此外，如果 Hazelcast 客户端/服务器拓扑，则成员和客户端都必须使用相同的序列化方法。序列化程序可以通过ClientConfig替换为相同的SerializerConfiguration的成员。

Servlet 容器初始化

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

为了我们的Filter为了发挥它的魔力，Spring 需要加载我们的SessionConfig类。由于我们的应用程序已经使用我们的SecurityInitializer类中，我们可以添加SessionConfig类。下面的清单显示了如何做到这一点：spring-doc.cadn.net.cn

src/main/java/sample/SecurityInitializer.java

public class SecurityInitializer extends AbstractSecurityWebApplicationInitializer {

	public SecurityInitializer() {
		super(SecurityConfig.class, SessionConfig.class);
	}

}

最后，我们需要确保我们的 Servlet 容器（即 Tomcat）使用我们的springSessionRepositoryFilter对于每个请求。 Spring Session 的springSessionRepositoryFilter在 Spring Security 的springSecurityFilterChain. 这样做可以确保HttpSessionSpring Security 使用的 Spring Session 支持。幸运的是，Spring Session 提供了一个名为AbstractHttpSessionApplicationInitializer这使得这变得如此简单。以下示例显示了如何执行此作：spring-doc.cadn.net.cn

来源/main/java/sample/Initializer.java

public class Initializer extends AbstractHttpSessionApplicationInitializer {

}

我们类的名称（Initializer）无关紧要。重要的是，我们扩展AbstractHttpSessionApplicationInitializer.

通过扩展AbstractHttpSessionApplicationInitializer中，我们确保名为springSessionRepositoryFilter在我们的 servlet 容器中注册，用于 Spring Security 的springSecurityFilterChain.spring-doc.cadn.net.cn

如何`HttpSession`集成工作

幸运的是，两者都HttpSession和HttpServletRequest（用于获取HttpSession）都是接口。这意味着我们可以为每个 API 提供自己的实现。spring-doc.cadn.net.cn

本节描述了 Spring Session 如何提供与HttpSession.我们提供这些内容是为了让您了解幕后发生的事情。此功能已集成，您无需自己实现此 logic。

首先，我们创建一个自定义HttpServletRequest，它返回HttpSession. 它看起来像下面这样：spring-doc.cadn.net.cn

public class SessionRepositoryRequestWrapper extends HttpServletRequestWrapper {

	public SessionRepositoryRequestWrapper(HttpServletRequest original) {
		super(original);
	}

	public HttpSession getSession() {
		return getSession(true);
	}

	public HttpSession getSession(boolean createNew) {
		// create an HttpSession implementation from Spring Session
	}

	// ... other methods delegate to the original HttpServletRequest ...
}

任何返回HttpSession被覆盖。所有其他方法都是由HttpServletRequestWrapper并委托给原始HttpServletRequest实现。spring-doc.cadn.net.cn

我们将HttpServletRequest使用 Servlet 实现Filter叫SessionRepositoryFilter. 以下伪代码显示了它的工作原理：spring-doc.cadn.net.cn

public class SessionRepositoryFilter implements Filter {

	public doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {
		HttpServletRequest httpRequest = (HttpServletRequest) request;
		SessionRepositoryRequestWrapper customRequest =
			new SessionRepositoryRequestWrapper(httpRequest);

		chain.doFilter(customRequest, response, chain);
	}

	// ...
}

通过传递自定义HttpServletRequestimplementation 导入到FilterChain，我们确保在Filter使用自定义的HttpSession实现。这凸显了为什么 Spring Session 的SessionRepositoryFilter放置在与HttpSession.spring-doc.cadn.net.cn

`HttpSession`和 RESTful API

Spring Session 可以通过在 header 中提供会话来与 RESTful API 一起使用。spring-doc.cadn.net.cn

REST 示例提供了一个工作示例，说明如何在 REST 应用程序中使用 Spring Session 来支持使用标头进行身份验证。您可以按照以下几节中描述的基本集成步骤进行作，但我们鼓励您在与自己的应用程序集成时遵循详细的 REST 指南。

Spring 配置

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

@Configuration
@EnableRedisHttpSession (1)
public class HttpSessionConfig {

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

	@Bean
	public HttpSessionIdResolver httpSessionIdResolver() {
		return HeaderHttpSessionIdResolver.xAuthToken(); (3)
	}

}

1	这`@EnableRedisHttpSession`annotation 会创建一个名为`springSessionRepositoryFilter`实现`Filter`. 过滤器负责替换`HttpSession`实现，由 Spring Session 支持。在这种情况下， Spring Session 由 Redis 提供支持。
2	我们创建一个`RedisConnectionFactory`将 Spring Session 连接到 Redis 服务器。我们将连接配置为连接到默认端口（6379）上的 localhost。有关配置 Spring Data Redis 的更多信息，请参阅参考文档。
3	我们自定义 Spring Session 的 HttpSession 集成，以使用 HTTP 标头而不是 cookie 来传达当前会话信息。

Servlet 容器初始化

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

为了我们的Filter为了发挥它的魔力，Spring 需要加载我们的Config类。我们在 Spring 中提供配置MvcInitializer，如下例所示：spring-doc.cadn.net.cn

来源/main/java/sample/mvc/MvcInitializer.java

@Override
protected Class<?>[] getRootConfigClasses() {
	return new Class[] { SecurityConfig.class, HttpSessionConfig.class };
}

最后，我们需要确保我们的 Servlet 容器（即 Tomcat）使用我们的springSessionRepositoryFilter对于每个请求。幸运的是，Spring Session 提供了一个名为AbstractHttpSessionApplicationInitializer这使得这样做变得容易。为此，请使用 default 构造函数扩展类，如下例所示：spring-doc.cadn.net.cn

来源/main/java/sample/Initializer.java

public class Initializer extends AbstractHttpSessionApplicationInitializer {

}

我们类的名称（Initializer）无关紧要。重要的是，我们扩展AbstractHttpSessionApplicationInitializer.

用`HttpSessionListener`

Spring Session 支持HttpSessionListener通过翻译SessionDestroyedEvent和SessionCreatedEvent到HttpSessionEvent通过声明SessionEventHttpSessionListenerAdapter. 要使用此支持，您需要：spring-doc.cadn.net.cn

确保您的SessionRepositoryimplementation 支持并配置为触发SessionDestroyedEvent和SessionCreatedEvent.spring-doc.cadn.net.cn
配置SessionEventHttpSessionListenerAdapter作为 Spring bean 进行。spring-doc.cadn.net.cn
注入每个HttpSessionListener到SessionEventHttpSessionListenerAdapterspring-doc.cadn.net.cn

如果您将 Redis 支持与enableIndexingAndEvents设置为true,@EnableRedisHttpSession(enableIndexingAndEvents = true)，您需要做的就是注册每个HttpSessionListener作为 Bean 进行。例如，假设您希望支持 Spring Security 的并发控制，并且需要使用HttpSessionEventPublisher.在这种情况下，您可以添加HttpSessionEventPublisher作为 Bean 进行。在 Java 配置中，这可能如下所示：spring-doc.cadn.net.cn

@Configuration
@EnableRedisHttpSession
public class RedisHttpSessionConfig {

	@Bean
	public HttpSessionEventPublisher httpSessionEventPublisher() {
		return new HttpSessionEventPublisher();
	}

	// ...

}

在 XML 配置中，这可能如下所示：spring-doc.cadn.net.cn

<bean class="org.springframework.security.web.session.HttpSessionEventPublisher"/>

HttpSession集成

为什么选择 Spring Session 和HttpSession?

HttpSession使用 Redis

Redis 基于 Java 的配置

Spring Java 配置

Java Servlet 容器初始化

Redis 基于 XML 的配置

Spring XML 配置

XML Servlet 容器初始化

使用 Mongo 的 HttpSession

会话序列化机制

JacksonMongoSession转换器

JdkMongoSession转换器

HttpSession使用 JDBC

基于 Java 的 JDBC 配置

Spring Java 配置

Java Servlet 容器初始化

多个数据源

基于 JDBC XML 的配置

Spring XML 配置

XML Servlet 容器初始化

基于 JDBC Spring Boot 的配置

Spring Boot 配置

配置DataSource

Servlet 容器初始化

HttpSession 与 Hazelcast

Spring 配置

Servlet 容器初始化

如何HttpSession集成工作

HttpSession和 RESTful API

Spring 配置

Servlet 容器初始化

用HttpSessionListener

`HttpSession`集成

为什么选择 Spring Session 和`HttpSession`?

`HttpSession`使用 Redis

`HttpSession`使用 JDBC

配置`DataSource`

如何`HttpSession`集成工作

`HttpSession`和 RESTful API

用`HttpSessionListener`