Spring Session - HttpSession (快速入門)

本指南介紹瞭如何使用 Spring Session 透明地利用 Redis 作為 Web 應用的 HttpSession 後端，並使用基於 XML 的配置。

你可以在 httpsession-xml 示例應用 中找到完整的指南。

更新依賴

在使用 Spring Session 之前，必須更新依賴。如果使用 Maven，需要新增以下依賴

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

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-data-redis</artifactId>
		<version>3.4.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.2.5</version>
	</dependency>
</dependencies>

Spring XML 配置

新增必要的依賴後，我們可以建立 Spring 配置。Spring 配置負責建立一個 Servlet 過濾器，用於將 HttpSession 的實現替換為由 Spring Session 支援的實現。為此，新增以下 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，它實現了 Filter 介面。該過濾器負責將 HttpSession 的實現替換為由 Spring Session 支援的實現。在此示例中，Spring Session 由 Redis 支援。
2 我們建立一個 RedisConnectionFactory，用於將 Spring Session 連線到 Redis 伺服器。我們將連線配置為連線到 localhost 的預設埠 (6379)。有關配置 Spring Data Redis 的更多資訊，請參閱參考文件。

XML Servlet 容器初始化

我們的Spring 配置建立了一個名為 springSessionRepositoryFilter 的 Spring Bean，它實現了 Filter 介面。springSessionRepositoryFilter bean 負責將 HttpSession 替換為由 Spring Session 支援的自定義實現。

為了讓我們的 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 包含你的會話 ID。你可以檢視 cookie（使用 Chrome 或 Firefox）。

可以使用 redis-cli 刪除會話。例如，在基於 Linux 的系統中可以輸入以下命令

	$ redis-cli keys '*' | xargs redis-cli del
Redis 文件提供了安裝 redis-cli 的說明。

或者，也可以刪除特定的 key。為此，請在終端中輸入以下命令，務必將 7e8383a4-082c-4ffe-a4bc-c40fd3363c5e 替換為你 SESSION cookie 的值

	$ redis-cli del spring:session:sessions:7e8383a4-082c-4ffe-a4bc-c40fd3363c5e

現在可以訪問 localhost:8080/ 應用，會看到我們新增的屬性不再顯示了。