跳到主要内容

Spring Session - REST

QWen Max 中英对照 REST Spring Session - REST

本指南介绍了如何使用 Spring Session 透明地利用 Redis 来支持 Web 应用程序的 HttpSession，当你使用 REST 端点时。

备注

你可以在rest示例应用程序中找到完整的指南。

Index

更新依赖项​

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

<dependencies>
	<!-- ... -->

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-data-redis</artifactId>
		<version>3.4.2</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>io.lettuce</groupId>
		<artifactId>lettuce-core</artifactId>
		<version>6.3.2.RELEASE</version>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>6.2.3</version>
	</dependency>
</dependencies>
xml

Spring 配置​

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

@Configuration
@EnableRedisHttpSession 1
public class HttpSessionConfig {

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

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

}
java

  • @EnableRedisHttpSession 注解创建了一个名为 springSessionRepositoryFilter 的 Spring bean，它实现了 Filter。该过滤器负责将 HttpSession 实现替换为由 Spring Session 支持的实现。在这种情况下，Spring Session 由 Redis 支持。

  • 我们创建了一个 RedisConnectionFactory，用于将 Spring Session 连接到 Redis 服务器。我们配置连接以在默认端口（6379）上连接到本地主机。有关配置 Spring Data Redis 的更多信息，请参阅参考文档。

  • 我们自定义了 Spring Session 的 HttpSession 集成，以使用 HTTP 头来传递当前会话信息，而不是使用 cookies。

Servlet 容器初始化​

我们的 Spring 配置 创建了一个名为 springSessionRepositoryFilter 的 Spring Bean，它实现了 Filter。springSessionRepositoryFilter bean 负责用由 Spring Session 支持的自定义实现来替换 HttpSession。

为了让我们的 Filter 发挥作用，Spring 需要加载我们的 Config 类。我们在 Spring 的 MvcInitializer 中提供配置，如下例所示：

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

最后，我们需要确保我们的 Servlet 容器（即 Tomcat）对每个请求都使用我们的 springSessionRepositoryFilter。幸运的是，Spring Session 提供了一个名为 AbstractHttpSessionApplicationInitializer 的工具类，使得这样做变得简单。为此，使用默认构造函数继承该类，如下例所示：

public class Initializer extends AbstractHttpSessionApplicationInitializer {

}
java
备注

我们的类名（Initializer）并不重要。重要的是我们继承了 AbstractHttpSessionApplicationInitializer。

rest 示例应用程序​

本节介绍如何使用 rest 示例应用程序。

运行 rest 示例应用程序​

你可以通过获取源代码并运行以下命令来运行示例：

备注

为了让示例正常工作，您必须在本地主机上安装 Redis 2.8+ 并使用默认端口（6379）运行它。或者，您可以更新 RedisConnectionFactory 以指向一个 Redis 服务器。另一个选项是使用 Docker 在本地主机上运行 Redis。有关详细说明，请参阅 Docker Redis 仓库。

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

你现在应该能够访问 localhost:8080/ 上的应用程序了。

探索 rest 示例应用程序​

现在你可以尝试使用该应用程序。为此，请使用你喜爱的 REST 客户端请求 localhost:8080/

$ curl -v http://localhost:8080/

请注意，系统会提示您输入基本身份验证。请提供以下信息作为用户名和密码：

  • 用户名 user

  • 密码 password

然后运行以下命令：

$ curl -v http://localhost:8080/ -u user:password

在输出中，你应该注意到以下内容：

HTTP/1.1 200 OK
...
X-Auth-Token: 0dc1f6e1-c7f1-41ac-8ce2-32b6b3e57aa3

{"username":"user"}

具体来说，您应该注意到我们回复中的以下几点：

  • HTTP 状态现在是 200。

  • 我们有一个名为 X-Auth-Token 的头部，其中包含一个新的会话 ID。

  • 显示当前用户名。

我们现在可以使用 X-Auth-Token 来发起另一个请求，而无需再次提供用户名和密码。例如，以下命令将输出用户名，与之前一样：

$ curl -v http://localhost:8080/ -H "X-Auth-Token: 0dc1f6e1-c7f1-41ac-8ce2-32b6b3e57aa3"

唯一的区别是，响应头中没有提供会话ID，因为我们正在重用现有的会话。

如果我们使会话失效，X-Auth-Token 会在响应中显示为空值。例如，以下命令会使我们的会话失效：

$ curl -v http://localhost:8080/logout -H "X-Auth-Token: 0dc1f6e1-c7f1-41ac-8ce2-32b6b3e57aa3"

你可以看到输出中的 X-Auth-Token 提供了一个空的 String，这表明之前的会话已被失效：

HTTP/1.1 204 No Content
...
X-Auth-Token:

它是如何工作的？​

Spring Security 在 SecurityContextPersistenceFilter 中与标准的 HttpSession 进行交互。

Spring Security现在将值持久化在Redis中，而不是使用Tomcat的HttpSession。Spring Session会在你的浏览器中创建一个名为X-Auth-Token的头部。该头部包含你的会话ID。

如果你愿意，你可以很容易地看到该会话是在 Redis 中创建的。为此，请使用以下命令创建一个会话：

$ curl -v http://localhost:8080/ -u user:password

在输出中，您应该注意到以下内容：

HTTP/1.1 200 OK
...
X-Auth-Token: 7e8383a4-082c-4ffe-a4bc-c40fd3363c5e

{"username":"user"}

现在你可以使用 redis-cli 删除会话。例如，在基于 Linux 的系统上，你可以输入：

$ redis-cli keys '*' | xargs redis-cli del
提示

Redis 文档中有安装 redis-cli 的说明。

或者，您也可以删除显式的密钥。为此，请在终端中输入以下内容，并确保将 7e8383a4-082c-4ffe-a4bc-c40fd3363c5e 替换为您的 SESSION cookie 的值：

$ redis-cli del spring:session:sessions:7e8383a4-082c-4ffe-a4bc-c40fd3363c5e

我们现在可以使用 X-Auth-Token 来使用我们已删除的会话发起另一个请求，并观察到系统提示我们进行身份验证。例如，以下操作将返回 HTTP 401：

$ curl -v http://localhost:8080/ -H "X-Auth-Token: 0dc1f6e1-c7f1-41ac-8ce2-32b6b3e57aa3"