5、SpringMVC之域對象共用數據

5.1、域對象簡介

• 請求域（request）：一次請求範圍內有效

• 會話域（session）：一次會話範圍內有效

• 應用域（application）：整個應用範圍內有效

5.2、環境搭建

5.2.1、右擊project創建新module

5.2.2、選擇maven

5.2.3、設置module名稱和路徑

5.2.4、module初始狀態

5.2.5、配置打包方式和引入依賴

註意：預設的打包方式為 jar，為了能配置web資源，需要將打包方式設置為 war

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.rain</groupId>
    <artifactId>spring_mvc_scopeObject</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <dependencies>
        <!-- SpringMVC (基於依賴的傳遞性，會間接引入Spring的依賴)-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.1</version>
        </dependency>
        <!-- 日誌（Thymeleaf必須要sl4j，logback則是sl4j的實現） -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
        <!-- ServletAPI -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
            <scope>provided</scope>
        </dependency>
        <!-- Spring5和Thymeleaf整合包 -->
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
            <version>3.0.12.RELEASE</version>
        </dependency>
    </dependencies>
    
</project>

5.2.6、配置web資源目錄

打開Project Structure，選擇對應的module，併為該module創建一個web.xml文件

註意：web.xml文件需要放到web資源路徑（工程路徑\src\main\webapp）下

5.2.7、配置web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!--配置SpringMVC的前端控制器DispatcherServlet，對瀏覽器發送的請求統一進行處理-->
    <servlet>
        <servlet-name>SpringMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!--通過初始化參數指定SpringMVC配置文件的位置和名稱-->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc.xml</param-value>
        </init-param>
        <!--將DispatcherServlet的初始化時間提前到伺服器啟動時-->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>SpringMVC</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <!--配置springMVC的編碼過濾器-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <!--該初始化參數用於設置請求參數的編碼方式-->
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <!--該初始化參數用於設置響應參數也使用同樣的編碼方式-->
            <param-name>forceEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

</web-app>

5.2.8、創建SpringMVC的配置文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">

    <!--在指定的包中，掃描控制層組件-->
    <context:component-scan base-package="org.rain.controller"></context:component-scan>

    <!-- 配置Thymeleaf視圖解析器 -->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/>
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean
                            class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!-- 視圖首碼 -->
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        <!-- 視圖尾碼 -->
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8" />
                    </bean>
                </property>
            </bean>
        </property>
    </bean>

</beans>

5.2.9、創建請求控制器

package org.rain.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @author liaojy
 * @date 2023/10/11 - 08:37
 */
@Controller
public class PortalController {

    @RequestMapping("/")
    public String portal(){
        return "index";
    }

}

5.2.10、創建靜態資源目錄及頁面

註意html要引入thymeleaf的約束：xmlns:th="http://www.thymeleaf.org"

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首頁</title>
</head>
<body>

</body>
</html>

註意html要引入thymeleaf的約束：xmlns:th="http://www.thymeleaf.org"

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>成功</title>
</head>
<body>

<h1>success.html</h1>

</body>
</html>

5.2.11、配置tomcat

5.3、使用ServletAPI向請求域共用數據

5.3.1、控制器方法示例

    @RequestMapping("/test/servletAPI")
    public String testServletAPI(HttpServletRequest request){
        request.setAttribute("testRequestScope","Hello,ServletAPI!");
        return "success";
    }

5.3.2、頁面請求示例

<a th:href="@{/test/servletAPI}">測試使用ServletAPI向請求域對象共用數據</a>

5.3.3、頁面獲取域對象中的數據示例

testRequestScope：<span th:text="${testRequestScope}"></span>

5.3.4、測試效果

5.4、使用ModelAndView向請求域共用數據（官方推薦）

5.4.1、控制器方法示例

註意：使用ModelAndView向請求域對象共用數據時，控制器方法需要返回的是ModelAndView對象，而不是表示邏輯視圖的字元串

    @RequestMapping("/test/mav")
    public ModelAndView testMAV(){
        /**
         * ModelAndView包含Model和View的功能
         * Model的功能：向請求域中共用數據
         * View的功能：設置邏輯視圖，實現頁面調整
         */
        ModelAndView mav = new ModelAndView();
        // 向請求域中共用數據
        mav.addObject("testRequestScope","Hello,ModelAndView!");
        // 設置邏輯視圖，實現頁面調整
        mav.setViewName("success");
        return mav;
    }

5.4.2、頁面請求示例

<a th:href="@{/test/mav}">測試使用ModelAndView向請求域對象共用數據</a>

5.4.3、頁面獲取域對象中的數據示例

testRequestScope：<span th:text="${testRequestScope}"></span>

5.4.4、測試效果

5.5、使用Model向請求域共用數據（實際常用）

5.5.1、控制器方法示例

註意：Model 是一個介面，具體對象由DispatcherServlet幫助創建並傳給控制器方法的形參

    @RequestMapping("/test/model")
    public String testModel(Model model){
        model.addAttribute("testRequestScope","Hello,Model!");
        return "success";
    }

5.5.2、頁面請求示例

<a th:href="@{/test/model}">測試使用Model向請求域對象共用數據</a>

5.5.3、頁面獲取域對象中的數據示例

testRequestScope：<span th:text="${testRequestScope}"></span>

5.5.4、測試效果

5.6、使用ModelMap向請求域共用數據

5.6.1、控制器方法示例

註意：ModelMap 對象由 DispatcherServlet 幫助創建並傳給控制器方法的形參

    @RequestMapping("/test/modelMap")
    public String testModelMap(ModelMap modelMap){
        modelMap.addAttribute("testRequestScope","Hello,ModelMap!");
        return "success";
    }

5.6.2、頁面請求示例

<a th:href="@{/test/modelMap}">測試使用ModelMap向請求域對象共用數據</a>

5.6.3、頁面獲取域對象中的數據示例

testRequestScope：<span th:text="${testRequestScope}"></span>

5.6.4、測試效果

5.7、使用Map向請求域共用數據

5.7.1、控制器方法示例

註意：Map 對象由 DispatcherServlet 幫助創建並傳給控制器方法的形參

    @RequestMapping("/test/map")
    public String testMap(Map<String,Object> map){
        map.put("testRequestScope","Hello,Map!");
        return "success";
    }

5.7.2、頁面請求示例

<a th:href="@{/test/map}">測試使用Map向請求域對象共用數據</a>

5.7.3、頁面獲取域對象中的數據示例

testRequestScope：<span th:text="${testRequestScope}"></span>

5.7.4、測試效果

5.8、Model、ModelMap、Map之間的關係

控制器方法中，Model、ModelMap、Map類型的實參其實本質上都是 BindingAwareModelMap 類型的

++++++++++++++++++++++++++++++++分割線++++++++++++++++++++++++++++++++

++++++++++++++++++++++++++++++++分割線++++++++++++++++++++++++++++++++

++++++++++++++++++++++++++++++++分割線++++++++++++++++++++++++++++++++

public interface Model{}
public class ModelMap extends LinkedHashMap<String, Object> {}
public class ExtendedModelMap extends ModelMap implements Model {}
public class BindingAwareModelMap extends ExtendedModelMap {}

5.9、使用ServletAPI向會話域共用數據

5.9.1、控制器方法示例

    @RequestMapping("/test/session")
    public String testSession(HttpSession httpSession){
        httpSession.setAttribute("testSessionScope","Hello,HttpSession!");
        return "success";
    }

5.9.2、頁面請求示例

<a th:href="@{/test/session}">測試使用ServletAPI向會話域對象共用數據</a>

5.9.3、頁面獲取會話域中的數據示例

註意：使用thymeleaf語法獲取會話域中的數據時，要使用session.首碼

testSessionScope：<span th:text="${session.testSessionScope}"></span>

5.9.4、測試效果

5.10、使用ServletAPI嚮應用域共用數據

5.10.1、控制器方法示例

註意：應用域對象 ServletContext 需要通過會話域對象 HttpSession 間接獲取

    @RequestMapping("/test/application")
    public String testApplication(HttpSession httpSession){
        ServletContext servletContext = httpSession.getServletContext();
        servletContext.setAttribute("testApplicationScope","Hello,Application!");
        return "success";
    }

5.10.2、頁面請求示例

<a th:href="@{/test/application}">測試使用ServletAPI嚮應用域對象共用數據</a>

5.10.3、頁面獲取應用域中的數據示例

註意：使用thymeleaf語法獲取會話域中的數據時，要使用application.首碼

testApplicationScope：<span th:text="${application.testApplicationScope}"></span>

5.10.4、測試效果

5.11、Idea配置session的鈍化和活化

• 會話域的數據，在關閉瀏覽器後失效；

• 應用域的數據，在關閉伺服器後失效；

• 即使重啟伺服器，只要瀏覽器沒有關閉或重啟，會話域的數據就能持續存在；

• session的鈍化：伺服器關閉時，將會話域中的數據保存在磁碟的文件中（tomcat的work目錄）；

• session的活化：伺服器啟動時，將保存在磁碟文件中的會話域數據恢復到伺服器的記憶體中。

註意：如果會話域中的數據是實體類對象，則該實體類需要實現序列化介面才能被session鈍化和活化。

通過idea啟動的web應用預設不支持session的鈍化和活化，需要手動配置開啟，開啟配置如上圖所示。

5.11.1、測試效果

5.11.1.1、伺服器重啟前的域對象數據

依次嚮應用域、會話域和請求域共用數據

5.11.1.2、伺服器重啟後的域對象數據

保持瀏覽器現狀，重啟伺服器後，只向請求域共用數據；此時發現，會話域的數據也存在。