SpringMVC：执行原理详解、配置文件和注解开发实现 SpringMVC

SpringMVC - 01

一、概述

SpringMVC 官方文档：点此进入

有关 MVC 架构模式的内容见之前的笔记：点此进入

1. SpringMVC 是 Spring Framework 的一部分，是基于 Java 实现 MVC 的轻量级 Web 框架，底层还是 Servlet；
2. Spring 的 Web 框架是围绕 DispatcherServlet 【调度 Servlet】设计的：
   • DispatcherServlet 的本质：是一个 Servlet；
   • DispatcherServlet 的作用：将请求分发到不同的处理器。
3. SpringMVC 的控制中心：DispatcherServlet；
4. SpringMVC 的核心三要素：处理器映射器、处理器适配器、视图解析器；
5. SpringMVC 与 Spring 兼容性好，无缝结合，并且功能强大：支持 RESTful 风格、异常处理、数据验证、格式化、本地化等；
6. SpringMVC 以请求为驱动，围绕一个中心 Servlet 分派请求及提供其他功能。

---

二、SpringMVC 执行原理

下图为 SpringMVC 的执行流程图，实线是 SpringMVC 框架提供的技术，不需要开发者实现，虚线需要实现。

组件：

• DispatcherServlet ：前端控制器，是整个 SpringMVC 的控制中心，作用：接收请求，响应结果，相当于电脑的 CPU；
• HandlerMapping ：处理器映射器，作用：根据 URL 查找处理器；
• Handler ：处理器，也称 Controller，和 Servlet 扮演的角色一致，作用：执行相关的请求处理逻辑，并返回相应的数据和视图信息，将其封装至 ModelAndView 对象中；
• HandlerExecutionChain：执行链，包含了处理器 Handler；
• HandlerAdapter ：处理器适配器，作用：按照特定规则去执行 Handler；
• ViewReslover ：视图解析器，作用：进行视图解析；
• ModelAndView ：SpringMVC 的底层对象，包括 Model 数据模型和 View 视图信息。

步骤：

1 ：用户发起请求到前端控制器 DispatcherServlet；

2 ：前端控制器请求处理器映射器 HandlerMappering 去通过 xml 配置或者注解来查找处理器 Handle；

3-4 ：找到处理器 Handle 以后 HandlerMappering 向前端控制器返回一个执行链 HandlerExecutionChain（包含了 Handle）；

5 ：前端控制器 DispatcherServlet 调用处理器适配器 HandlerAdapter 去执行处理器 Handler；

6 ：处理器适配器去执行 Handler；

7 ：Handler 执行完给处理器适配器 HandlerAdapter 返回 ModelAndView；

8 ：处理器适配器 HandlerAdapter 向前端控制器返回 ModelAndView；

9 ：前端控制器 DispatcherServlet 请求视图解析器 ViewResolver 去进行视图解析；

10 ：视图解析器 ViewResolver 向前端控制器返回 View；

11 ：前端控制器根据 View 对视图进行渲染，将 Model 中的模型数据填充到 View 视图中的 request 域，生成最终的 View（视图）；

12 ：前端控制器向用户响应结果。

备注：

1. SpringMVC 执行原理概述：拦截请求、解析 URL 找到处理器 Handle、执行 controller、解析数据和视图并展示。

2. SpringMVC 执行原理参考文档：

   • 参考文档 1：点此进入
   • 参考文档 2：点此进入

---

三、使用配置文件实现 SpringMVC

使用配置文件实现 SpringMVC 主要是为了理解 SpringMVC 的执行原理，步骤如下：

• 创建一个普通的 Maven 项目，导入依赖

<!-- Servlet 依赖 -->
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
</dependency>

<!-- JSP 依赖 -->
<dependency>
    <groupId>javax.servlet.jsp</groupId>
    <artifactId>jsp-api</artifactId>
    <version>2.1</version>
</dependency>

<!-- JSTL 表达式依赖 -->
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>jstl</artifactId>
    <version>1.2</version>
</dependency>

<!-- standard 标签库 -->
<dependency>
    <groupId>taglibs</groupId>
    <artifactId>standard</artifactId>
    <version>1.1.2</version>
</dependency>

<!-- spring-webmvc -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.3.18</version>
</dependency>

<!-- junit -->
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>

• 新建一个普通的 Maven 模块，在模块上右键选择 Add Framework Support... 后勾选 Web Application(4.0) 将模块转变为一个 Web 模块。注意：因为没有使用模板创建 Web 项目，所以此时生成的 web 文件夹不在 main 文件下，这样生成的 out 文件夹中没有依赖，所以要打开项目结构，建立 lib 文件夹，导入依赖。

• 在 web.xml 中配置 DispatcherServlet 前端控制器（整个 SpringMVC 的控制中心）

<?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">

    <!-- 配置 DispatcherServlet 前端控制器 -->
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- DispatcherServlet 绑定 Spring 的配置文件 -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring-mvc.xml</param-value>
        </init-param>
        <!-- 启动级别：1，和服务器一起启动 -->
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

• 编写 spring-mvc.xml 配置文件：包括配置处理器映射器、处理器适配器、视图解析器

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

    <!-- 处理器映射器 -->
    <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/>
    <!-- 处理器适配器 -->
    <bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>

    <!-- 视图解析器 -->
    <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 前缀 -->
        <property name="prefix" value="/WEB-INF/jsp/"/>
        <!-- 后缀 -->
        <property name="suffix" value=".jsp"/>
    </bean>

    <!-- BeanNameUrlHandlerMapping：根据 bean 的名字找到处理器映射器 -->
    <bean id="/hello" class="com.Sun3285.controller.ControllerDemo01"/>

</beans>

• 编写一个 Controller（处理器 Handler）实现 Controller 接口，重写方法（实现业务代码、视图跳转）

• 编写要跳转的页面

• 配置 Tomcat，测试

提示：可以将以上代码与第二部分 SpringMVC 的执行原理相对应起来看，可以加深理解。

---

四、使用注解开发实现 SpringMVC

在实际中，经常使用注解开发实现 SpringMVC，使用到的注解有：

注解	说明
@Controller	将编写的控制类注册为 bean，由 Spring 容器进行管理
@RequestMapping(“请求路径”)	完成映射关系，根据请求路径找到对应的处理器（Controller 控制器）

1. 步骤

注解开发步骤如下：

1. 创建一个普通的 Maven 项目，导入依赖；
2. 新建一个普通的 Maven 模块，转变为一个 Web 模块，打开项目结构，建立 lib 文件夹，添加依赖；
3. 在 web.xml 中配置 DispatcherServlet 前端控制器：
   • 配置 DispatcherServlet 前端控制器；
   • 绑定 Spring 的配置文件；
   • 设置启动级别。
4. 编写 spring-mvc.xml 配置文件：
   • 导入 context 和 mvc 的头文件约束；
   • 设置自动扫描包；
   • 设置让 SpringMVC 不处理静态资源；
   • 支持注解驱动；
   • 配置视图解析器。
5. 编写控制类，使用注解；
6. 编写要跳转的页面；
7. 配置 Tomcat，测试。

2. 实现

• 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">

    <!-- 配置 DispatcherServlet 前端控制器 -->
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- DispatcherServlet 绑定 Spring 的配置文件 -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring-mvc.xml</param-value>
        </init-param>
        <!-- 启动级别：1，和服务器一起启动 -->
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

• spring-mvc.xml

<?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"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc
        https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 自动扫描包，让指定包下的注解生效，由 IOC 容器统一管理 -->
    <context:component-scan base-package="com.Sun3285.controller"/>

    <!-- 让 SpringMVC 不处理静态资源 -->
    <mvc:default-servlet-handler/>

    <!-- 支持注解驱动 -->
    <mvc:annotation-driven/>

    <!-- 视图解析器 -->
    <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 前缀 -->
        <property name="prefix" value="/WEB-INF/jsp/"/>
        <!-- 后缀 -->
        <property name="suffix" value=".jsp"/>
    </bean>

</beans>

• 控制类

• 在要跳转的页面中取出 message 对应的值

• 配置 Tomcat，测试

---

五、总结

1. ModelAndView 类型的对象可以执行的方法：

方法	说明
addObject(String attributeName, Object attributeValue)	以键值对的形式赋值
setViewName(String viewName)	参数 viewName 通过视图解析器后组成 url 用于视图跳转

注意：这些方法由 ModelAndView 类型的对象执行。

2. Model 类型的对象可以执行的方法：

方法	说明
addAttribute(String attributeName, Object attributeValue)	以键值对的形式赋值

注意：这个方法由 Model 类型的对象执行，相当于 ModelAndView 类的 addObject 方法。

3. 将所有视图放在 WEB-INF 目录下，这样可以保证视图安全，因为这个目录下的文件，客户端不能直接访问；

4. 在 web.xml 中配置 DispatcherServlet 前端控制器时，url-pattern 中要使用 / ：

   • / ：只匹配所有的请求，不会去匹配 jsp 页面；

   • /* ：匹配所有的请求，包括 jsp 页面。

5. 在 spring-mvc.xml 配置文件中，通常我们只需要手动配置视图解析器，而处理器映射器和处理器适配器只需要开启注解驱动即可，省去了 xml 配置；

6. 在控制类中：

   • 类由 @Controller 注解声明，可以将编写的控制类注册为 bean，由 Spring 容器进行管理，在容器初始化时被自动扫描到；
   • 方法由 @RequestMapping 注解声明，可以完成映射关系，根据请求路径找到对应的处理器（Controller 控制器）；
   • 方法的参数为 Model 类型，可以通过调用方法来封装数据；
   • 方法的返回值为 String 类型，返回值会被视图解析器解析，从而组成一个跳转页面的 url；
   • 可以在控制类中写多个方法。

7. 使用配置文件实现 SpringMVC 主要是为了理解 SpringMVC 的执行原理，而使用注解开发实现 SpringMVC 才是实际中经常用到的。

---

注意：

1. SpringMVC 官方文档：https://docs.spring.io/spring-framework/docs/current/reference/html/web.html。