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.3.3</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>6.1.14</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`，將 Spring Session 連接到 H2 資料庫的嵌入式實例。我們配置 H2 資料庫，以使用 Spring Session 中包含的 SQL 腳本來建立資料庫表格。
3	我們建立一個 `transactionManager`，用於管理先前配置的 `dataSource` 的交易。

如需有關如何配置資料存取相關問題的更多資訊，請參閱 Spring Framework 參考文件。

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-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 包含您 session 的 ID。您可以檢視 cookie (使用 Chrome 或 Firefox)。

您可以使用 H2 Web Console 移除 session，網址為：localhost:8080/h2-console/ (JDBC URL 請使用 jdbc:h2:mem:testdb)

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