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、服务器重启后的域对象数据

保持浏览器现状，重启服务器后，只向请求域共享数据；此时发现，会话域的数据也存在。