boot-redis.md

# Spring Session- Spring Boot

本指南描述了在使用 Spring 引导时如何使用 Spring Session 透明地利用 Redis 来支持 Web 应用程序的`HttpSession`。

|   |你可以在[引导示例应用程序](#boot-sample)中找到完整的指南。|
|---|--------------------------------------------------------------------------------|

[Index](../index.html)

## 更新依赖项

在使用 Spring Session 之前，你必须确保你的依赖关系。我们假设你正在使用一个有效的启动 Web 应用程序。如果正在使用 Maven，则必须添加以下依赖项：

POM.xml

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

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-data-redis</artifactId>
	</dependency>
</dependencies>
```

Spring 启动为 Spring Session 模块提供了依赖管理，因此不需要显式声明依赖版本。

##  Spring 引导配置

在添加了所需的依赖项之后，我们就可以创建我们的 Spring 启动配置了。多亏了一流的自动配置支持，由 Redis 支持的设置 Spring Session 非常简单，只需向你的`application.properties`添加一个配置属性，如以下清单所示：

SRC/主/资源/应用程序.properties

```
spring.session.store-type=redis # Session store type.
```

在这种情况下， Spring boot 应用的配置相当于手动添加`@EnableRedisHttpSession`注释。这将创建一个名为`springSessionRepositoryFilter`的 Spring  Bean，实现`Filter`。过滤器负责替换要由 Spring Session 支持的`HttpSession`实现。

使用`application.properties`还可以进行进一步的定制，如以下清单所示：

SRC/主/资源/应用程序.properties

```
server.servlet.session.timeout= # Session timeout. If a duration suffix is not specified, seconds is used.
spring.session.redis.flush-mode=on_save # Sessions flush mode.
spring.session.redis.namespace=spring:session # Namespace for keys used to store sessions.
```

有关更多信息，请参见 Spring 引导文档的[Spring Session](https://docs.spring.io/spring-boot/docs/2.5.6/reference/htmlsingle/#boot-features-session)部分。

## 配置 Redis 连接

Spring 启动会自动创建一个`RedisConnectionFactory`，它将 Spring Session 连接到端口 6379（默认端口）上本地主机上的 Redis 服务器。在生产环境中，你需要更新配置以指向 Redis 服务器。例如，你可以在应用程序中包含以下内容：

SRC/主/资源/应用程序.properties

```
spring.redis.host=localhost # Redis server host.
spring.redis.password= # Login password of the redis server.
spring.redis.port=6379 # Redis server port.
```

有关更多信息，请参见 Spring 引导文档的[连接到 Redis](https://docs.spring.io/spring-boot/docs/2.5.6/reference/htmlsingle/#boot-features-connecting-to-redis)部分。

##  Servlet 容器初始化

我们的[Spring Boot Configuration](#boot-spring-configuration)创建了一个名为`springSessionRepositoryFilter`的 Spring  Bean，它实现了`Filter`。`springSessionRepositoryFilter` Bean 负责用 Spring Session 支持的自定义实现替换`HttpSession`。

为了使我们的`Filter`发挥其魔力， Spring 需要加载我们的`Config`类。最后，我们需要确保我们的 Servlet 容器（即 Tomcat）为每个请求使用我们的`springSessionRepositoryFilter`。幸运的是，Boot 为我们解决了这两个步骤。

## 引导示例应用程序

引导示例应用程序演示了如何在使用 Spring 引导时使用 Spring Session 透明地利用 Redis 来支持 Web 应用程序的`HttpSession`。

### 运行引导示例应用程序

你可以通过获取[源代码](https://github.com/spring-projects/spring-session/archive/main.zip)并调用以下命令来运行示例：

```
$ ./gradlew :spring-session-sample-boot-redis:bootRun
```

|   |要使示例工作，你必须在 localhost 上[安装 Redis2.8+](https://redis.io/download)并使用默认端口（6379）运行它。<br/>或者，你可以更新`RedisConnectionFactory`以指向 Redis 服务器。<br/>另一个选项是使用[Docker](https://www.docker.com/)在 localhost 上运行 Redis。详细说明见[Docker Redis 存储库](https://hub.docker.com/_/redis/)。|
|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

现在你应该可以在[http://localhost:8080/](http://localhost:8080/)上访问应用程序了。

### 探索`security`示例应用程序

现在你可以尝试使用该应用程序了。输入以下内容即可登录：

* **用户 Name** *User*

* **密码** *密码*

现在点击**登录**按钮。你现在应该会看到一条消息，表明你是用先前输入的用户登录的。用户的信息存储在 Redis 中，而不是 Tomcat 的`HttpSession`实现中。

### 它是如何工作的？

我们不使用 Tomcat 的`HttpSession`，而是在 Redis 中保存这些值。 Spring Session 用一个由 Redis 支持的实现替换`HttpSession`。当 Spring Security 的`SecurityContextPersistenceFilter`将`SecurityContext`保存到`HttpSession`时，它将被持久化到 Redis 中。

当创建一个新的`HttpSession`时， Spring Session 将在浏览器中创建一个名为`SESSION`的 cookie。该 cookie 包含你的会话的 ID。你可以查看 cookies（使用[Chrome](https://developers.google.com/web/tools/chrome-devtools/manage-data/cookies)或[Firefox](https://developer.mozilla.org/en-US/docs/Tools/Storage_Inspector)）。

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

```
	$ redis-cli keys '*' | xargs redis-cli del
```

|   |Redis 文档中有[安装 Redis-CLI](https://redis.io/topics/quickstart)的说明。|
|---|--------------------------------------------------------------------------------------------------------|

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

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

现在，你可以访问[http://localhost:8080/](http://localhost:8080/)上的应用程序，并观察到我们不再经过身份验证。