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/，你會發現我們新增的屬性不再顯示。
