|
此版本仍在开发中,尚未被认为是稳定的。请使用最新的稳定版本 Spring Session 4.0.2! |
Spring Session - HttpSession (快速入门)
此指南描述了如何使用 Spring Session 透明地利用 Redis 来为基于 XML 配置的 web 应用程序的 HttpSession 提供支持。
| 您可以在此找到完整的指南:httpsession-xml 样例应用。 |
更新依赖项
在使用Spring Session之前,您必须更新您的依赖项。 如果您使用Maven,请添加以下依赖项:
<dependencies>
<!-- ... -->
<dependency>
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-data-redis</artifactId>
<version>3.5.6-SNAPSHOT</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.17</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接口。
过滤器负责将HttpSession实现替换为由Spring Session支持的方式。
在这个例子中,Spring Session由Redis支持。 |
| 2 | 我们创建一个RedisConnectionFactory来将Spring Session连接到Redis服务器。
我们配置了连接以连接到本地主机的默认端口(6379)
有关配置Spring Data Redis的更多信息,请参阅参考文档。 |
XML Servlet 容器初始化
我们的springSessionRepositoryFilter的Spring Bean,该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>
The 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>
The 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 进行交互。
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。
你可以在Chrome或Firefox中查看cookies。
可以使用redis-cli移除会话。 例如,在基于Linux的系统上,您可以输入以下命令:
$ redis-cli keys '*' | xargs redis-cli del
| The Redis 文档有安装 redis-cli 的说明。安装 redis-cli |
您也可以删除显式的密钥。为此,请在终端中输入以下命令,确保将7e8383a4-082c-4ffe-a4bc-c40fd3363c5e替换为您SESSION cookie的值:
$ redis-cli del spring:session:sessions:7e8383a4-082c-4ffe-a4bc-c40fd3363c5e
现在您可以在localhost:8080/访问应用程序,并看到我们添加的属性不再显示。