Spring Session - HttpSession(快速入门)
本指南介绍了如何使用 Spring Session 以透明方式利用 Redis 来支持 Web 应用程序的 HttpSession,并使用基于 XML 的配置。
| 您可以在 httpsession-xml 示例应用程序 中找到完整的指南。 |
更新依赖项
在使用 Spring Session 之前,必须更新你的依赖项。如果你使用 Maven,则必须添加以下依赖项
<dependencies>
<!-- ... -->
<dependency>
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-data-redis</artifactId>
<version>3.5.3</version>
<type>pom</type>
</dependency>
<dependency>
<groupId>io.lettuce</groupId>
<artifactId>lettuce-core</artifactId>
<version>6.5.5.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>6.2.12</version>
</dependency>
</dependencies>
Spring XML 配置
添加所需的依赖项后,我们可以创建 Spring 配置。Spring 配置负责创建一个 Servlet 过滤器,该过滤器用 Spring Session 支持的实现替换 HttpSession 实现。为此,请添加以下 Spring 配置
(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 的 Spring Bean,它实现了 Filter。该过滤器负责替换由 Spring Session 支持的 HttpSession 实现。在此示例中,Spring Session 由 Redis 支持。 |
| 2 | 我们创建了一个 RedisConnectionFactory,用于将 Spring Session 连接到 Redis 服务器。我们将连接配置为连接到默认端口(6379)上的 localhost。有关配置 Spring Data Redis 的更多信息,请参阅参考文档。 |
XML Servlet 容器初始化
我们的 Spring 配置 创建了一个名为 springSessionRepositoryFilter 的 Spring Bean,它实现了 Filter。springSessionRepositoryFilter Bean 负责用一个由 Spring Session 支持的自定义实现来替换 HttpSession。
为了让我们的 Filter 发挥作用,我们需要指示 Spring 加载我们的 session.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 配置。
最后,我们需要确保我们的 Servlet 容器(即 Tomcat)为每个请求使用我们的 springSessionRepositoryFilter。以下代码片段为我们执行了最后一步:
<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 查找一个 Bean 并将其转换为 Filter。对于每个调用 DelegatingFilterProxy 的请求,都会调用 springSessionRepositoryFilter。
httpsession-xml 示例应用程序
本节介绍如何使用 httpsession-xml 示例应用程序。
运行 httpsession-xml 示例应用程序
您可以通过获取源代码并调用以下命令来运行示例:
要使示例正常工作,您必须在本地主机上安装 Redis 2.8+ 并以默认端口(6379)运行它。或者,您可以更新 RedisConnectionFactory 以指向 Redis 服务器。另一种选择是使用 Docker 在本地主机上运行 Redis。有关详细说明,请参阅Docker Redis 存储库。 |
$ ./gradlew :spring-session-sample-xml-redis:tomcatRun
您现在应该能够通过 localhost:8080/ 访问该应用程序
探索 httpsession-xml 示例应用程序
现在您可以尝试使用该应用程序。填写以下信息表单:
-
属性名称: username
-
属性值: rob
现在点击 设置属性 按钮。您现在应该会在表格中看到显示的值。
它是如何工作的?
我们在 SessionServlet 中与标准 HttpSession 进行交互,如下所示:
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,而是将值持久化到 Redis 中。Spring Session 会在您的浏览器中创建一个名为 SESSION 的 cookie。该 cookie 包含您的会话 ID。您可以查看 cookie(使用 Chrome 或 Firefox)。
您可以使用 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
现在你可以访问应用程序 localhost:8080/,你会发现我们添加的属性不再显示。