Spring Session - HttpSession（快速入門）
本指南介紹瞭如何使用 Spring Session，透過 Java 配置透明地利用 Redis 來支援 Web 應用程式的 HttpSession。
| 你可以在httpsession 示例應用程式中找到完整的指南。 |
更新依賴項
在使用 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>由於我們使用的是 SNAPSHOT 版本，我們需要確保新增 Spring Snapshot Maven 倉庫。你的 pom.xml 中必須包含以下內容
<repositories>
<!-- ... -->
<repository>
<id>spring-snapshot</id>
<url>https://repo.spring.io/libs-snapshot</url>
</repository>
</repositories>Spring Java 配置
新增所需的依賴項後，我們可以建立 Spring 配置。Spring 配置負責建立一個 Servlet 過濾器，該過濾器用 Spring Session 支援的實現替換 HttpSession 實現。為此，請新增以下 Spring 配置
@Configuration(proxyBeanMethods = false)
@EnableRedisHttpSession (1)
public class Config {
@Bean
public LettuceConnectionFactory connectionFactory() {
return new LettuceConnectionFactory(); (2)
}
}| 1 | @EnableRedisHttpSession 註解建立了一個名為 springSessionRepositoryFilter 的 Spring Bean，它實現了 Filter 介面。該過濾器負責替換 HttpSession 的實現，使其由 Spring Session 提供支援。在這種情況下，Spring Session 由 Redis 提供支援。 |
| 2 | 我們建立一個 RedisConnectionFactory，它將 Spring Session 連線到 Redis 伺服器。我們將連線配置為連線到預設埠 (6379) 上的 localhost。有關配置 Spring Data Redis 的更多資訊，請參閱 參考文件。 |
Java Servlet 容器初始化
我們的Spring 配置建立了一個名為 springSessionRepositoryFilter 的 Spring Bean，它實現了 Filter 介面。springSessionRepositoryFilter bean 負責將 HttpSession 替換為由 Spring Session 提供支援的自定義實現。
為了讓我們的 Filter 發揮作用，Spring 需要載入我們的 Config 類。最後，我們需要確保我們的 Servlet 容器（即 Tomcat）對每個請求都使用我們的 springSessionRepositoryFilter。幸運的是，Spring Session 提供了一個名為 AbstractHttpSessionApplicationInitializer 的實用類來簡化這兩個步驟。以下是一個示例
public class Initializer extends AbstractHttpSessionApplicationInitializer { (1)
public Initializer() {
super(Config.class); (2)
}
}我們類的名稱 (Initializer) 無關緊要。重要的是我們擴充套件了 AbstractHttpSessionApplicationInitializer。 |
| 1 | 第一步是擴充套件 AbstractHttpSessionApplicationInitializer。這樣做可以確保名為 springSessionRepositoryFilter 的 Spring Bean 在每個請求中都註冊到我們的 Servlet 容器中。 |
| 2 | AbstractHttpSessionApplicationInitializer 還提供了一種機制來確保 Spring 載入我們的 Config。 |
httpsession 示例應用程式
執行 httpsession 示例應用程式
您可以透過獲取原始碼並呼叫以下命令來執行示例：
$ ./gradlew :spring-session-sample-javaconfig-redis:tomcatRun
要使示例正常工作，您必須在本地主機上安裝 Redis 2.8+ 並以預設埠（6379）執行它。或者，您可以更新 RedisConnectionFactory 以指向 Redis 伺服器。另一種選擇是使用 Docker 在本地主機上執行 Redis。有關詳細說明，請參閱Docker Redis 儲存庫。 |
您現在應該能夠透過 localhost:8080/ 訪問該應用程式
探索 httpsession 示例應用程式
現在你可以嘗試使用該應用程式。為此，請填寫以下資訊：
-
屬性名稱： username
-
屬性值： rob
現在點選 設定屬性 按鈕。您現在應該會在表格中看到顯示的值。
它是如何工作的？
我們在 SessionServlet 中與標準 HttpSession 進行互動，如下所示：
@WebServlet("/session")
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/，你會發現我們新增的屬性不再顯示。
