Spring Session - HttpSession（快速入門）

本指南介紹瞭如何使用 Spring Session 透明地利用關係型資料庫透過基於 XML 的配置來支援 Web 應用程式的 HttpSession。

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

更新依賴項

在使用 Spring Session 之前，必須更新依賴項。如果您使用 Maven，則必須新增以下依賴項：

pom.xml

<dependencies>
	<!-- ... -->

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-jdbc</artifactId>
		<version>3.4.3</version>
		<type>pom</type>
	</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.jdbc.config.annotation.web.http.JdbcHttpSessionConfiguration"/>

(2)
<jdbc:embedded-database id="dataSource" database-name="testdb" type="H2">
	<jdbc:script location="classpath:org/springframework/session/jdbc/schema-h2.sql"/>
</jdbc:embedded-database>

(3)
<bean class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
	<constructor-arg ref="dataSource"/>
</bean>

1	我們結合使用 `<context:annotation-config/>` 和 `JdbcHttpSessionConfiguration`，因為 Spring Session 尚未提供 XML 名稱空間支援（參見 gh-104）。這會建立一個名為 `springSessionRepositoryFilter` 的 Spring bean。該 bean 實現了 `Filter` 介面。該過濾器負責將 `HttpSession` 實現替換為由 Spring Session 支援的實現。在此示例中，Spring Session 由關係型資料庫支援。
2	我們建立了一個 `dataSource` bean，用於將 Spring Session 連線到嵌入式 H2 資料庫例項。我們配置 H2 資料庫使用 Spring Session 中包含的 SQL 指令碼建立資料庫表。
3	我們建立了一個 `transactionManager` bean，用於管理先前配置的 `dataSource` 的事務。

有關如何配置資料訪問相關內容的更多資訊，請參閱 Spring Framework 參考文件。

XML Servlet 容器初始化

我們的 Spring 配置建立了一個名為 springSessionRepositoryFilter 的 Spring bean，該 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-jdbc-xml` 示例應用程式

本節介紹如何使用 httpsession-jdbc-xml 示例應用程式。

執行 `httpsession-jdbc-xml` 示例應用程式

您可以透過獲取原始碼並執行以下命令來執行示例：

$ ./gradlew :spring-session-sample-xml-jdbc:tomcatRun

您現在應該能夠透過 localhost:8080/ 訪問該應用程式。

探索 `httpsession-jdbc-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，而是將值持久化到 H2 資料庫中。Spring Session 會在您的瀏覽器中建立一個名為 SESSION 的 cookie。該 cookie 包含您會話的 ID。您可以在瀏覽器中檢視 cookie（使用 Chrome 或 Firefox）。

您可以使用 H2 Web 控制檯刪除會話，控制檯地址為：localhost:8080/h2-console/（JDBC URL 請使用 jdbc:h2:mem:testdb）

現在您可以訪問應用程式 localhost:8080/，並觀察到之前新增的屬性不再顯示。