Spring Session - HttpSession (快速入門)

本指南說明如何使用 Spring Session 以透明方式運用 Redis 來支援網路應用程式的 HttpSession，並採用 XML 架構組態。

您可以在 httpsession-xml 範例應用程式中找到完整的指南。

更新相依性

在使用 Spring Session 之前，您必須更新您的相依性。如果您使用 Maven，您必須新增下列相依性

pom.xml
<dependencies>
	<!-- ... -->

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-data-redis</artifactId>
		<version>3.3.3</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>io.lettuce</groupId>
		<artifactId>lettuce-core</artifactId>
		<version>6.3.2.RELEASE</version>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>6.1.14</version>
	</dependency>
</dependencies>

Spring XML 組態

在新增必要的相依性之後，我們可以建立我們的 Spring 組態。Spring 組態負責建立一個 servlet 篩選器，以 Spring Session 支援的實作取代 HttpSession 實作。若要執行此操作，請新增下列 Spring 組態

src/main/webapp/WEB-INF/spring/session.xml
(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，該 Bean 實作 Filter。此篩選器負責取代 HttpSession 實作，使其由 Spring Session 支援。在此例中，Spring Session 是由 Redis 支援。
2 我們建立一個 RedisConnectionFactory，將 Spring Session 連線到 Redis 伺服器。我們將連線設定為連線到預設埠 (6379) 上的 localhost。如需設定 Spring Data Redis 的詳細資訊，請參閱參考文件。

XML Servlet 容器初始化

我們的 Spring 組態 建立了一個名為 springSessionRepositoryFilter 的 Spring Bean，該 Bean 實作 Filter。springSessionRepositoryFilter bean 負責以 Spring Session 支援的自訂實作取代 HttpSession。

為了讓我們的 Filter 發揮作用，我們需要指示 Spring 載入我們的 session.xml 組態。我們可以透過以下組態執行此操作

src/main/webapp/WEB-INF/web.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。以下程式碼片段為我們執行最後一步

src/main/webapp/WEB-INF/web.xml
<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 範例應用程式

您可以透過取得原始碼並調用以下命令來執行範例

為了使範例正常運作，您必須在 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

現在按一下設定屬性按鈕。您現在應該會在表格中看到顯示的值。

運作方式為何？

我們與下列清單中顯示的 SessionServlet 中的標準 HttpSession 互動

src/main/java/sample/SessionServlet.java
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 包含您 Session 的 ID。您可以檢視 Cookie (使用 Chrome 或 Firefox)。

您可以使用 redis-cli 移除 Session。例如，在以 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/ 上的應用程式，並查看我們新增的屬性不再顯示。