|
对于最新的稳定版本，请使用 Spring Session 3.5.2！ |
春季会话 - 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.1.6</version>
<type>pom</type>
</dependency>
<dependency>
<groupId>io.lettuce</groupId>
<artifactId>lettuce-core</artifactId>
<version>6.2.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>6.0.20</version>
</dependency>
</dependencies>Spring XML 配置
添加所需的依赖项后，我们可以创建 Spring 配置。
Spring 配置负责创建一个 servlet 过滤器，该过滤器将HttpSession实现，由 Spring Session 支持的实现。
为此，请添加以下 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实现Filter.
过滤器负责更换HttpSession由 Spring Session 支持的实现。
在这种情况下，Spring Session 由 Redis 支持。 |
| 2 | 我们创建一个RedisConnectionFactory将 Spring Session 连接到 Redis 服务器。
我们将连接配置为连接到默认端口 （6379） 上的本地主机
有关配置 Spring Data Redis 的更多信息，请参阅参考文档。 |
XML Servlet 容器初始化
我们的 Spring 配置创建了一个名为springSessionRepositoryFilter实现Filter. 这springSessionRepositoryFilterbean 负责将HttpSession使用由 Spring Session 支持的自定义实现。
为了我们的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并将其转换为Filter.
对于每个请求DelegatingFilterProxy被调用时，springSessionRepositoryFilter被调用。
httpsession-xml示例应用
本节介绍如何使用httpsession-xml示例应用程序。
运行httpsession-xml示例应用
您可以通过获取源代码并调用以下命令来运行示例：
要使示例正常工作，您必须在 localhost 上安装 Redis 2.8+ 并使用默认端口 （6379） 运行它。或者，您可以更新RedisConnectionFactory指向 Redis 服务器。另一种选择是使用 Docker 在 localhost 上运行 Redis。有关详细说明，请参阅 Docker Redis 存储库。 |
$ ./gradlew :spring-session-sample-xml-redis:tomcatRun
您现在应该能够在 localhost：8080/ 访问该应用程序
探索httpsession-xml示例应用
现在您可以尝试使用该应用程序。使用以下信息填写表格：
-
属性名称：username
-
属性值：rob
现在点击 设置属性（Set Attribute） 按钮。您现在应该会看到表中显示的值。
它是如何工作的？
我们与标准互动HttpSession在SessionServlet如以下清单所示：
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/ 的应用程序，并看到我们添加的属性不再显示。