【SpringMVC 笔记】SpringMVC 原理 + 入门项目（xml 配置版 vs 注解版）

布满荆棘的人生 2023-02-16 04:16 81阅读 0赞

### SpringMVC 入门项目 ###

*  什么是 SpringMVC?
 *   *  中心控制器
     *  SpringMVC 执行原理
     *  执行流程
 *  xml 配置版
 *   *  1、创建一个 Web 项目
     *  2、pom.xml 中导入 SpringMVC 的依赖
     *  3、配置 web.xml，注册 DispatcherServlet
     *  4、编写 SpringMVC 的配置文件：springmvc-servlet.xml
     *  5、编写操作业务 Controller
     *  6、配置文件中注册 bean
     *  7、创建视图层 hello.jsp
     *  8、配置 Tomcat 启动测试！
     *  可能遇到的问题：访问出现404
 *  注解版
 *   *  1、创建一个 Web 项目
     *  2、pom.xml 中导入 SpringMVC 的依赖
     *   *  资源过滤 问题
     *  3、配置 web.xml，注册 DispatcherServlet
     *   *  / 和 /\* 的区别
     *  4、编写 SpringMVC 的配置文件：springmvc-servlet.xml
     *  5、编写操作业务 Controller
     *  6、创建视图层 hello.jsp
     *  7、配置 Tomcat 运行
 *  入门项目总结

> 更多内容参见 SpringMVC 学习笔记目录：[【Spring MVC】学习笔记汇总][Spring MVC]

# 什么是 SpringMVC? #

Spring MVC 是 Spring Framework 的一部分，是基于Java 实现 MVC 的轻量级 Web 框架。

详情查看：[SpringMVC 官方文档][SpringMVC]

## 中心控制器 ##

Spring 的 web 框架围绕 **DispatcherServlet** \[ 调度Servlet \] 设计。

DispatcherServlet 的作用是**将请求分发到不同的处理器**。

从 Spring 2.5 开始，使用 Java 5 或者以上版本的用户可以采用基于注解形式进行开发，十分简洁；

正因为 SpringMVC 简单、便捷、易学，天生和 Spring 无缝集成（使用 SpringIOC 和 Aop），使用 **约定优于配置**，能够进行简单的 JUnit 测试、支持 **Restful 风格**、异常处理、本地化、国际化、数据验证、类型转换、拦截器，等等… 所以我们要学习。

Spring MVC 框架像许多其他 MVC 框架一样，以请求为驱动，围绕一个中心 Servlet 分派请求及提供其他功能，**DispatcherServlet** 是一个实际的 Servlet (它继承自 `HttpServlet` 基类)。

## SpringMVC 执行原理 ##

多看几张原理图，体会一下。。。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 1]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 2]  
上图为 SpringMVC 的一个较完整的流程图，实线表示 SpringMVC 框架提供的技术，不需要开发者实现，虚线表示需要开发者实现。

## 执行流程 ##

**DispatcherServlet** 表示前置控制器，是整个 SpringMVC 的控制中心。

用户发出请求，**DispatcherServlet** 接收请求并拦截请求。

我们假设请求的 URL 为 : `http://localhost:8080/sm/hello`

如上 URL 拆分成三部分：

*  `http://localhost:8080` 表示服务器域名
 *  `sm` 表示部署在服务器上的 web 站点
 *  `hello` 表示控制器

通过分析，如上URL表示为：

1.  请求位于服务器 `localhost:8080` 上的 `sm` 站点的 `hello`控制器，用户发出请求。
2.  **HandlerMapping** 为处理器映射。  
    **DispatcherServlet** 调用 **HandlerMapping**，**HandlerMapping** 根据请求 url 查找 Handler。
3.  **HandlerExecution** 表示具体的 Handler。  
    主要作用是根据 url 查找控制器，如上 url 被查找控制器为：`hello`。
4.  **HandlerExecution** 将解析后的信息传递给 **DispatcherServlet**，如解析控制器映射等。
5.  **HandlerAdapter** 表示**处理器适配器**，其按照特定的规则去执行 Handler。
6.  **Handler** 让具体的 Controller 执行。
7.  Controller 将具体的执行信息返回给 **HandlerAdapter**，如 **ModelAndView**。
8.  **HandlerAdapter** 将视图逻辑名或模型传递给 **DispatcherServlet。**
9.  **DispatcherServlet** 调用**视图解析器** (ViewResolver) 解析 **HandlerAdapter** 传递的逻辑视图名。
10. **视图解析器** 将解析的逻辑视图名传给 **DispatcherServlet**。
11. **DispatcherServlet** 根据视图解析器解析的视图结果，调用具体的视图。
12. 最终视图呈现给用户。

# xml 配置版 #

xml 配置版就是体验一下，开发中不会使用，用的更多的是注解版。

## 1、创建一个 Web 项目 ##

新建一个 Moudle ， `springmvc-hello` ， 添加 web 的支持。

## 2、pom.xml 中导入 SpringMVC 的依赖 ##

<dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.2.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.2</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
        </dependency>
    </dependencies>

## 3、配置 web.xml，注册 DispatcherServlet ##

<?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">
    
       
       <servlet>
           <servlet-name>springmvc</servlet-name>
           <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
           
           <init-param>
               <param-name>contextConfigLocation</param-name>
               <param-value>classpath:springmvc-servlet.xml</param-value>
           </init-param>
           
           <load-on-startup>1</load-on-startup>
       </servlet>
    
       
       
       <servlet-mapping>
           <servlet-name>springmvc</servlet-name>
           <url-pattern>/</url-pattern>
       </servlet-mapping>
    
    </web-app>

## 4、编写 SpringMVC 的配置文件：springmvc-servlet.xml ##

`resources` 下创建配置文件`springmvc-servlet.xml`，往其中添加以下配置：

*  **处理映射器**（BeanNameUrlHandlerMapping）
 *  **处理适配器**（SimpleControllerHandlerAdapter）
 *  **视图解析器**（InternalResourceViewResolver）

<?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 http://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 class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="InternalResourceViewResolver">
            
            <property name="prefix" value="/WEB-INF/jsp/"/>
            
            <property name="suffix" value=".jsp"/>
        </bean>
    
        
        <bean id="/hello" class="com.yusael.controller.HelloController"/>
    
    </beans>

## 5、编写操作业务 Controller ##

`Controller` 要么实现 `Controller` 接口，要么使用 `@Controller` 注解；

*  实现 `Controller` 需要返回一个 `ModelAndView`，封装 **数据** 和 **视图**；

package com.yusael.controller;
    
    import org.springframework.web.servlet.ModelAndView;
    import org.springframework.web.servlet.mvc.Controller;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    // 实现 Controller 接口
    public class HelloController implements Controller { 
    
       public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception { 
           // ModelAndView 模型和视图
           ModelAndView mv = new ModelAndView();
    
           // 封装对象, 放在 ModelAndView 中
           mv.addObject("msg", "HelloSpringMVC!");
           // 封装要跳转的视图，放在 ModelAndView 中
           mv.setViewName("hello"); // 根据视图解析器, 自动拼接成 /WEB-INF/jsp/hello.jsp
           return mv;
      }
    }

## 6、配置文件中注册 bean ##

`springmvc-servlet.xml` 中将自己的类交给 SpringIOC 容器，注册 bean：

<bean id="/hello" class="com.yusael.controller.HelloController"/>

## 7、创建视图层 hello.jsp ##

编写一个要跳转 `hello.jsp` 页面，显示 `ModelandView` 存放的数据，以及我们的正常页面；

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
       <title>yusael</title>
    </head>
    <body>
    ${msg}
    </body>
    </html>

## 8、配置 Tomcat 启动测试！ ##

URL：`http:localhost:8080/hello`

## 可能遇到的问题：访问出现404 ##

在 IDEA 的项目发布中，添加 lib 依赖！

*  重启 Tomcat 即可解决！

# 注解版 #

## 1、创建一个 Web 项目 ##

新建一个 Moudle，`springmvc-hello-annotation`，添加 web 支持。

## 2、pom.xml 中导入 SpringMVC 的依赖 ##

主要有 Spring 框架核心库、Spring MVC、servlet , JSTL 等。

### 资源过滤 问题 ###

由于 Maven 可能存在 **资源过滤** 的问题，`pom.xml` 增加如下配置：

<build>
       <resources>
           <resource>
               <directory>src/main/java</directory>
               <includes>
                   <include>**/*.properties</include>
                   <include>**/*.xml</include>
               </includes>
               <filtering>false</filtering>
           </resource>
           <resource>
               <directory>src/main/resources</directory>
               <includes>
                   <include>**/*.properties</include>
                   <include>**/*.xml</include>
               </includes>
               <filtering>false</filtering>
           </resource>
       </resources>
    </build>

## 3、配置 web.xml，注册 DispatcherServlet ##

<?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">
    
       
       <servlet>
           <servlet-name>SpringMVC</servlet-name>
           <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
           
           <init-param>
               <param-name>contextConfigLocation</param-name>
               
               <param-value>classpath:springmvc-servlet.xml</param-value>
           </init-param>
           
           <load-on-startup>1</load-on-startup>
       </servlet>
       
       
       <servlet-mapping>
           <servlet-name>SpringMVC</servlet-name>
           <url-pattern>/</url-pattern>
       </servlet-mapping>
    
    </web-app>

### / 和 /\* 的区别 ###

`<url-pattern> / </url-pattern>` 不会匹配到 `.jsp`， 只针对我们编写的请求；即：`.jsp` 不会进入 spring 的 `DispatcherServlet` 类 。

`<url-pattern> /* </url-pattern>` 会匹配 `*.jsp`，会出现返回 jsp 视图 时再次进入 spring 的`DispatcherServlet` 类，导致找不到对应的 controller 所以报 404。

## 4、编写 SpringMVC 的配置文件：springmvc-servlet.xml ##

在 `resource` 目录下添加 `springmvc-servlet.xml` 配置文件，配置的形式与 Spring 容器配置基本类似，为了支持基于注解的 IOC，设置了 **自动扫描包** 的功能，具体配置信息如下：

<?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 http://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">
    
       
       <context:component-scan base-package="com.kuang.controller"/>
       
       <mvc:default-servlet-handler />
       
       <mvc:annotation-driven />
    
       
       <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="internalResourceViewResolver">
           
           <property name="prefix" value="/WEB-INF/jsp/" />
           
           <property name="suffix" value=".jsp" />
       </bean>
    
    </beans>

在视图解析器中我们把所有的视图都存放在 `/WEB-INF/` 目录下，这样可以保证视图安全，因为这个目录下的文件，客户端不能直接访问。

## 5、编写操作业务 Controller ##

编写一个 Java 控制类：`com.yusael.controller.HelloController`：

package com.yusael.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.Model;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    @Controller
    @RequestMapping("/HelloController")
    public class HelloController { 
    
    	//真实访问地址 : 项目名/HelloController/hello
    	@RequestMapping("/hello")
    	public String sayHello(Model model){ 
    		// 向模型中添加属性 msg 与值，可以在 JSP 页面中取出并渲染
    		model.addAttribute("msg", "hello,SpringMVC");
    		// web-inf/jsp/hello.jsp
    		return "hello";
    	}
    }

*  `@Controller` 是为了让 Spring IOC 容器初始化时自动扫描到；
 *  `@RequestMapping` 是为了映射请求路径，这里因为类与方法上都有映射所以访问时应该是 `/HelloController/hello`；
 *  方法中声明 `Model` 类型的参数是为了把 Action 中的数据带到视图中；
 *  方法返回的结果是视图的名称 `hello`，加上配置文件中的前后缀变成 `WEB-INF/jsp/hello.jsp`。

## 6、创建视图层 hello.jsp ##

在 `WEB-INF/jsp` 目录中创建 `hello.jsp` ， 视图可以直接取出并展示从 Controller 带回的信息；

可以通过 EL 表示取出 `Model` 中存放的值，或者对象；

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
       <title>SpringMVC</title>
    </head>
    <body>
    ${msg}
    </body>
    </html>

## 7、配置 Tomcat 运行 ##

URL：`http://localhost:8080/HelloController/hello`

# 入门项目总结 #

实现步骤其实非常的简单：

1.  新建一个web项目
2.  导入相关依赖
3.  编写 web.xml，注册 DispatcherServlet
4.  编写 springmvc 配置文件
5.  接下来就是去创建对应的控制类，controller
6.  最后完善前端视图和 controller 之间的对应
7.  测试运行调试

使用 SpringMVC 必须配置的三大件：

*  **处理器映射器**、**处理器适配器**、**视图解析器**

通常，我们只需要 **手动配置视图解析器**，而 处理器映射器 和 处理器适配器 只需要开启注解驱动即可，而省去了大段的 xml 配置。

[Spring MVC]: https://blog.csdn.net/weixin_43734095/article/details/106798883
[SpringMVC]: https://docs.spring.io/spring/docs/5.2.0.RELEASE/spring-framework-reference/web.html#spring-web
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200609224309720.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200609225430863.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200609225439470.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ==,size_16,color_FFFFFF,t_70