SpringMVC笔记

此笔记为B站尚硅谷 springMVC 视频学习笔记，视频链接：点我

1. SpringMVC简介

1.1. 什么是MVC

MVC是一种软件架构的思想，将软件按照模型、视图、控制器来划分

• M：Model，模型层，指工程中的JavaBean，作用是处理数据，JavaBean分为两类：
  • 一类称为实体类Bean：专门存储业务数据，如 Student、User 等
  • 一类称为业务处理 Bean：指 Service 或 Dao 对象，专门用于处理业务逻辑和数据访问。
• V：View，视图层，指工程中的html或jsp等页面，作用是与用户进行交互，展示数据
• C：Controller，控制层，指工程中的servlet，作用是接收请求和响应浏览器

MVC的工作流程：
用户通过视图层发送请求到服务器，在服务器中请求被Controller接收，Controller 调用相应的Model层处理请求，处理完毕将结果返回到Controller，Controller再根据请求处理的结果找到相应的View视图，渲染数据后最终响应给浏览器。

1.2. 什么是SpringMVC

SpringMVC是Spring的一个后续产品，是Spring的一个子项目。

SpringMVC 是 Spring 为表述层开发提供的一整套完备的解决方案。在表述层框架历经 Strust、WebWork、Strust2 等诸多产品的历代更迭之后，目前业界普遍选择了 SpringMVC 作为 Java EE 项目表述层开发的首选方案。

注：三层架构分为表述层（或表示层）、业务逻辑层、数据访问层，表述层表示前台页面和后台servlet。

1.3. SpringMVC的特点

Spring 家族原生产品，与 IOC 容器等基础设施无缝对接。

基于原生的Servlet，通过了功能强大的前端控制器DispatcherServlet，对请求和响应进行统一处理。

表述层各细分领域需要解决的问题全方位覆盖，提供全面解决方案。

代码清新简洁，大幅度提升开发效率。

内部组件化程度高，可插拔式组件即插即用，想要什么功能配置相应组件即可。

性能卓著，尤其适合现代大型、超大型互联网项目要求。

2. HelloWorld

2.1. 开发环境

IDE：idea 2019.2

构建工具：maven3.5.4

服务器：tomcat7

Spring版本：5.3.1

2.2. 创建maven工程

1. 添加web模块

2. 打包方式：war

3. 引入依赖

   <dependencies>
       
       <dependency>
           <groupId>org.springframeworkgroupId>
           <artifactId>spring-webmvcartifactId>
           <version>5.3.1version>
       dependency>
       
       <dependency>
           <groupId>ch.qos.logbackgroupId>
           <artifactId>logback-classicartifactId>
           <version>1.2.3version>
       dependency>
       
       <dependency>
           <groupId>javax.servletgroupId>
           <artifactId>javax.servlet-apiartifactId>
           <version>3.1.0version>
           <scope>providedscope>
       dependency>
       
       <dependency>
           <groupId>org.thymeleafgroupId>
           <artifactId>thymeleaf-spring5artifactId>
           <version>3.0.12.RELEASEversion>
       dependency>
   dependencies>
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27

2.3. 配置web.xml

注册SpringMVC的前端控制器DispatcherServlet

• 默认配置方式

  使用此配置方式，SpringMVC的配置文件默认位于WEB-INF下，默认名称为-servlet.xml，例如，以下配置所对应SpringMVC的配置文件位于WEB-INF下，文件名为springMVC-servlet.xml。

  
  <servlet>
      <servlet-name>springMVCservlet-name>
      <servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
  servlet>
  <servlet-mapping>
      <servlet-name>springMVCservlet-name>
      
      <url-pattern>/url-pattern>
  servlet-mapping>
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10

• 扩展配置方式

  可通过 init-param 标签设置SpringMVC配置文件的位置和名称，通过 load-on-startup 标签设置SpringMVC前端控制器**DispatcherServlet**的初始化时间。

  
  <servlet>
      <servlet-name>springMVCservlet-name>
      <servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
      
      <init-param>
          
          <param-name>contextConfigLocationparam-name>
          
          <param-value>classpath:springMVC.xmlparam-value>
      init-param>
      
      <load-on-startup>1load-on-startup>
  servlet>
  <servlet-mapping>
      <servlet-name>springMVCservlet-name>
      
      <url-pattern>/url-pattern>
  servlet-mapping>
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23

注：

\标签中使用/和/*的区别：

• / 所匹配的请求可以是/login或.html或.js或.css方式的请求路径，但是 /
  不能匹配.jsp请求路径的请求，因此可以避免在访问jsp页面时，该请求被DispatcherServlet处理，然后找不到相应的页面。
• /* 则能够匹配所有请求，例如在使用过滤器时，若需要对所有请求进行过滤，就需要使用/*的写法。
• /** 相比于/* ，可以匹配更多层级的目录。

2.4. 创建请求控制器

由于前端控制器对浏览器发送的请求进行了统一的处理，但是具体的请求有不同的处理过程，因此需要创建处理具体请求的类，即请求控制器。

请求控制器中每一个处理请求的方法称为控制器方法。

因为SpringMVC的控制器由一个POJO（普通的Java类）实现，因此需要通过@Controller注解将其标识为一个控制层组件，交给Spring的IOC容器管理，此时SpringMVC才能够识别控制器的存在。

@Controller
public class HelloController {
}
1
2
3

2.5. 创建springMVC配置文件

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

    
    <context:component-scan base-package="com.atguigu.mvc.controller"/>

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

    
    <mvc:default-servlet-handler/>

    
    <mvc:annotation-driven>
        <mvc:message-converters>
            
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <property name="defaultCharset" value="UTF-8"/>
                <property name="supportedMediaTypes">
                    <list>
                        <value>text/htmlvalue>
                        <value>application/jsonvalue>
                    list>
                property>
            bean>
        mvc:message-converters>
    mvc:annotation-driven>

beans>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

注意在文件开头，必须引入相对应的命名空间，才可使用对应的标签。

2.6. 测试HelloWorld

• 实现对首页的访问

  在请求控制器中创建处理请求的方法

  // @RequestMapping注解：处理请求和控制器方法之间的映射关系
  // @RequestMapping注解的value属性可以通过请求地址匹配请求，/ 表示当前工程的上下文路径
  // localhost:8080/springMVC/
  @RequestMapping("/")
  public String index() {
      //设置视图名称
      return "index";
  }
  1
  2
  3
  4
  5
  6
  7
  8

• 通过超链接跳转到指定页面

  在主页index.html中设置超链接

  DOCTYPE html>
  <html lang="en" xmlns:th="http://www.thymeleaf.org">
  <head>
      <meta charset="UTF-8">
      <title>首页title>
  head>
  <body>
  <h1>首页h1>
  <a th:href="@{/hello}">HelloWorlda><br/>
  body>
  html>
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11

• 在请求控制器中创建处理请求的方法

  @RequestMapping("/hello")
  public String helloWorld() {
      return "target";
  }
  1
  2
  3
  4

之后通过配置idea的tomcat和运行项目，启动tomcat之后，访问http:8080/springMVC，就可以跳转到index页面。

该跳转，是通过@RequestMapping("/") public String index()映射跳转到的，因此 index.html 页面应该放到
webapp/WEB-INF/template 才能被 thymeleaf 视图解析器扫描到。

2.7. 总结

浏览器发送请求，若请求地址符合前端控制器的url-pattern，则该请求会被前端控制器DispatcherServlet处理。前端控制器会读取SpringMVC的核心配置文件，通过扫描组件找到控制器，将请求地址和控制器中@RequestMapping注解的value属性值进行匹配。若匹配成功，该注解所标识的控制器方法就是处理请求的方法。处理请求的方法需要返回一个字符串类型的视图名称，该视图名称会被视图解析器解析，加上前缀和后缀组成视图的路径，通过Thymeleaf对视图进行渲染，最终转发到视图所对应页面。

3. @RequestMapping

3.1. @RequestMapping功能

从注解名称上我们可以看到，@RequestMapping注解的作用就是将请求和处理请求的控制器方法关联起来，建立映射关系。

SpringMVC 接收到指定的请求，就会来找到在映射关系中对应的控制器方法来处理这个请求。

3.2. @RequestMapping位置

@RequestMapping标识一个类：设置映射请求的请求路径的初始信息，该初始配置值会拼接到类中所有方法注解值的前面。

@RequestMapping标识一个方法：设置映射请求请求路径的具体信息。

@Controller
@RequestMapping("/test")
public class RequestMappingController {

    //此时请求映射所映射的请求的请求路径为：/test/testRequestMapping
    @RequestMapping("/testRequestMapping")
    public String testRequestMapping() {
        return "success";
    }


1
2
3
4
5
6
7
8
9
10
11

3.3. @RequestMapping的value属性

@RequestMapping注解的value属性通过请求的请求地址匹配请求映射。

@RequestMapping注解的value属性是一个字符串类型的数组，表示该请求映射能够匹配多个请求地址所对应的请求。

@RequestMapping注解的value属性必须设置。

<a th:href="@{/testRequestMapping}">测试@RequestMapping的value属性-->/testRequestMappinga><br>
<a th:href="@{/test}">测试@RequestMapping的value属性-->/testa><br>
1
2

@RequestMapping(value = {"/testRequestMapping", "/test"})
public String testRequestMapping() {
    return "success";
}
1
2
3
4

3.4. @RequestMapping的method属性

@RequestMapping注解的method属性通过请求的请求方式（get或post）匹配请求映射。

@RequestMapping注解的method属性是一个RequestMethod类型的数组，表示该请求映射能够匹配多种请求方式的请求。

若当前请求的请求地址满足请求映射的value属性，但是请求方式不满足method属性，则浏览器报错405：Request
method ‘POST’ not supported。

<a th:href="@{/test}">测试@RequestMapping的value属性-->/testa><br>
<form th:action="@{/test}" method="post">
    <input type="submit">
form>
1
2
3
4

@RequestMapping(
        value = {"/testRequestMapping", "/test"},
        method = {RequestMethod.GET, RequestMethod.POST}
)
public String testRequestMapping() {
    return "success";
}
1
2
3
4
5
6
7

注：

1. 对于处理指定请求方式的控制器方法，SpringMVC中提供了@RequestMapping的派生注解

• 处理get请求的映射–>@GetMapping

• 处理post请求的映射–>@PostMapping

• 处理put请求的映射–>@PutMapping

• 处理delete请求的映射–>@DeleteMapping

2. 常用的请求方式有get，post，put，delete

• 但是目前浏览器只支持get和post，若在form表单提交时，为method设置了其他请求方式的字符串（put或delete），则按照默认的请求方式get处理。

• 若要发送put和delete请求，则需要通过spring提供的过滤器HiddenHttpMethodFilter，在RESTful部分会讲到。

3.5. @RequestMapping的params属性（了解）

@RequestMapping注解的params属性通过请求的请求参数匹配请求映射。

@RequestMapping注解的params属性是一个字符串类型的数组，可以通过四种表达式设置请求参数和请求映射的匹配关系。

• “param”：要求请求映射所匹配的请求必须携带param请求参数。

• “!param”：要求请求映射所匹配的请求不能携带param请求参数。

• “param=value”：要求请求映射所匹配的请求必须携带param请求参数且param=value。

• “param!=value”：要求请求映射所匹配的请求必须携带param请求参数但是param!=value。

  <a th:href="@{/test(username='admin',password=123456)">测试@RequestMapping的params属性-->/testa><br>
  1

  @RequestMapping(
          value = {"/testRequestMapping", "/test"},
          method = {RequestMethod.GET, RequestMethod.POST},
          params = {"username", "password!=123456"}
  )
  public String testRequestMapping() {
      return "success";
  }
  1
  2
  3
  4
  5
  6
  7
  8

若当前请求满足@RequestMapping注解的value和method属性，但是不满足params属性，此时页面回报错

400：Parameter
conditions “username, password!=123456” not met for actual request
parameters: username={admin}, password={123456}。

3.6. @RequestMapping的headers属性（了解）

@RequestMapping注解的headers属性通过请求的请求头信息匹配请求映射。

@RequestMapping注解的headers属性是一个字符串类型的数组，可以通过四种表达式设置请求头信息和请求映射的匹配关系。

• header：要求请求映射所匹配的请求必须携带header请求头信息。

• !header：要求请求映射所匹配的请求不能携带header请求头信息。

• header=value：要求请求映射所匹配的请求必须携带header请求头信息且header=value。

• header!=value：要求请求映射所匹配的请求必须携带header请求头信息且header!=value。

  若当前请求满足@RequestMapping注解的value和method属性，但是不满足headers属性，此时页面显示404错误，即资源未找到。

3.7. SpringMVC支持ant风格的路径

?：表示任意的单个字符。

*：表示任意的0个或多个字符。

**：表示任意的一层或多层目录。

注意：在使用**时，只能使用/**/xxx的方式。

3.8. SpringMVC支持路径中的占位符（重点）

原始方式：/deleteUser?id=1

rest方式：/deleteUser/1

SpringMVC路径中的占位符常用于RESTful风格中，当请求路径中将某些数据通过路径的方式传输到服务器时，就可以在相应的@RequestMapping注解的value属性中通过占位符 {xxx} 表示传输的数据，再通过@PathVariable注解，将占位符所表示的数据赋值给控制器方法的形参。

<a th:href="@{/testRest/1/admin}">测试路径中的占位符-->/testResta><br>
1

@RequestMapping("/testRest/{id}/{username}")
public String testRest(@PathVariable("id") String id, @PathVariable("username") String username) {
    System.out.println("id:" + id + ",username:" + username);
    return "success";
}
//最终输出的内容为-->id:1,username:admin
1
2
3
4
5
6

4. SpringMVC获取请求参数

4.1. 通过ServletAPI获取

将HttpServletRequest作为控制器方法的形参，此时HttpServletRequest类型的参数表示封装了当前请求的请求报文的对象。

@RequestMapping("/testParam")
public String testParam(HttpServletRequest request) {
    String username = request.getParameter("username");
    String password = request.getParameter("password");
    System.out.println("username:" + username + ",password:" + password);
    return "success";
}
1
2
3
4
5
6
7

4.2. 通过控制器方法的形参获取请求参数

在控制器方法的形参位置，设置和请求参数同名的形参，当浏览器发送请求，匹配到请求映射时，DispatcherServlet 就会将请求参数赋值给相应的形参。

<a th:href="@{/testParam(username='admin',password=123456)}">测试获取请求参数-->/testParama><br>
1

@RequestMapping("/testParam")
public String testParam(String username, String password) {
    System.out.println("username:" + username + ",password:" + password);
    return "success";
}
1
2
3
4
5

注：

若请求所传输的请求参数中有多个同名的请求参数，此时可以在控制器方法的形参中设置字符串数组或者字符串类型的形参接收此请求参数。

若使用字符串数组类型的形参，此参数的数组中包含每一个数据。

若使用字符串类型的形参，此参数的值为每个数据中间使用逗号拼接的结果。

4.3. @RequestParam

@RequestParam会对请求参数和控制器方法的形参创建映射关系，该注解需要添加到形参前面。

@RequestParam注解一共有三个属性：

• value：指定为形参赋值的请求参数的参数名。

• required：设置是否必须传输此请求参数，默认值为true。

  若设置为true，则当前请求必须传输value所指定的请求参数，若没有传输该请求参数，且没有设置defaultValue属性，则页面报错400：Required String parameter \'xxx\' is not present；若设置为false，则当前请求不是必须传输value所指定的请求参数，若没有传输，则注解所标识的形参的值为null。

• defaultValue：不管required属性值为true或false，当value所指定的请求参数没有传输或传输的值为空字符串时，则使用默认值为形参赋值。

4.4. @RequestHeader

@RequestHeader会对请求头信息和控制器方法的形参创建映射关系。

@RequestHeader注解一共有三个属性：value、required、defaultValue，用法同@RequestParam。

4.5. @CookieValue

@CookieValue会对cookie数据和控制器方法的形参创建映射关系。

@CookieValue注解一共有三个属性：value、required、defaultValue，用法同@RequestParam。

4.6. 通过POJO获取请求参数

可以在控制器方法的形参位置设置一个实体类类型的形参，此时若浏览器传输的请求参数的参数名和实体类中的属性名一致，则请求参数会为此属性赋值。

<form th:action="@{/testpojo}" method="post">
    用户名：<input type="text" name="username"><br>
    密码：<input type="password" name="password"><br>
    性别：<input type="radio" name="sex" value="男">男<input type="radio" name="sex" value="女">女<br>
    年龄：<input type="text" name="age"><br>
    邮箱：<input type="text" name="email"><br>
    <input type="submit">
form>
1
2
3
4
5
6
7
8

@Data
public class User {
    private String username;
    private String password;
    private String sex;
    private int age;
    private String email;
}
1
2
3
4
5
6
7
8

@RequestMapping("/testpojo")
public String testPojo(User user){
    System.out.println(user);
    return "success";
}
//最终结果-->User{id=null, username='张三', password='123', age=23, sex='男', email='123@qq.com'}
1
2
3
4
5
6

4.7. 解决获取请求参数的乱码问题

解决获取请求参数的乱码问题，可以使用SpringMVC提供的编码过滤器CharacterEncodingFilter，但是必须在web.xml中进行注册。

<filter>
    <filter-name>CharacterEncodingFilterfilter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilterfilter-class>
    <init-param>
        <param-name>encodingparam-name>
        <param-value>UTF-8param-value>
    init-param>
    <init-param>
        <param-name>forceResponseEncodingparam-name>
        <param-value>trueparam-value>
    init-param>
filter>
<filter-mapping>
    <filter-name>CharacterEncodingFilterfilter-name>
    <url-pattern>/*url-pattern>
filter-mapping>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

注：

SpringMVC中处理编码的过滤器一定要配置到其他过滤器之前，否则无效。

5. 域对象共享数据

5.1. 使用ServletAPI向request域对象共享数据

@RequestMapping("/testServletAPI")
public String testServletApi(HttpServletRequest request) {
    request.setAttribute("testScope", "hello,servletAPI");
    return "success";
}
1
2
3
4
5

5.2. 使用ModelAndView向request域对象共享数据

@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView() {
    /**
     * ModelAndView有Model和View的功能
     * Model主要用于向请求域共享数据
     * View主要用于设置视图，实现页面跳转
     */
    ModelAndView mav = new ModelAndView();
    //向请求域共享数据
    mav.addObject("testScope", "hello,ModelAndView");
    //设置视图，实现页面跳转
    mav.setViewName("success");
    return mav;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

5.3. 使用Model向request域对象共享数据

@RequestMapping("/testModel")
public String testModel(Model model) {
    model.addAttribute("testScope", "hello,Model");
    return "success";
}
1
2
3
4
5

5.4. 使用map向request域对象共享数据

@RequestMapping("/testMap")
public String testMap(Map<String, Object> map) {
    map.put("testScope", "hello,Map");
    return "success";
}
1
2
3
4
5

5.5. 使用ModelMap向request域对象共享数据

@RequestMapping("/testModelMap")
public String testModelMap(ModelMap modelMap) {
    modelMap.addAttribute("testScope", "hello,ModelMap");
    return "success";
}
1
2
3
4
5

5.6. 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 {}
1
2
3
4

5.7. 向session域共享数据

@RequestMapping("/testSession")
public String testSession(HttpSession session) {
    session.setAttribute("testSessionScope", "hello,session");
    return "success";
}
1
2
3
4
5

5.8. 向application域共享数据

@RequestMapping("/testApplication")
public String testApplication(HttpSession session) {
    ServletContext application = session.getServletContext();
    application.setAttribute("testApplicationScope", "hello,application");
    return "success";
}
1
2
3
4
5
6

6. SpringMVC的视图

SpringMVC中的视图是View接口，视图的作用是渲染数据，将模型Model中的数据展示给用户。

SpringMVC视图的种类很多，默认有转发视图和重定向视图。

当工程引入jstl依赖后，转发视图会自动转换为JstlView。

若使用的视图技术为Thymeleaf，在SpringMVC的配置文件中配置了Thymeleaf的视图解析器，由此视图解析器解析之后所得到的是ThymeleafView。

6.1. ThymeleafView

当控制器方法中所设置的视图名称没有任何前缀时，此时的视图名称会被SpringMVC配置文件中所配置的视图解析器解析，视图名称拼接视图前缀和视图后缀所得到的最终路径，会通过转发的方式实现跳转。

@RequestMapping("/testHello")
public String testHello() {
    return "hello";
}
1
2
3
4

6.2. 转发视图

SpringMVC中默认的转发视图是InternalResourceView。

SpringMVC中创建转发视图的情况：

当控制器方法中所设置的视图名称以"forward:"为前缀时，创建InternalResourceView视图，此时的视图名称不会被SpringMVC配置文件中所配置的视图解析器解析，而是会将前缀"forward:"去掉，剩余部分作为最终路径通过转发的方式实现跳转。

例如"forward:/"，“forward:/employee”。

@RequestMapping("/testForward")
public String testForward() {
    return "forward:/testHello";
}
1
2
3
4

6.3. 重定向视图

SpringMVC中默认的重定向视图是RedirectView。

当控制器方法中所设置的视图名称以"redirect:"为前缀时，创建RedirectView视图，此时的视图名称不会被SpringMVC配置文件中所配置的视图解析器解析，而是会将前缀"redirect:"去掉，剩余部分作为最终路径通过重定向的方式实现跳转。

例如"redirect:/"，“redirect:/employee”。

@RequestMapping("/testRedirect")
public String testRedirect() {
    return "redirect:/testHello";
}
1
2
3
4

注：

重定向视图在解析时，会先将redirect:前缀去掉，然后会判断剩余部分是否以/开头，若是则会自动拼接上下文路径。

6.4. 视图控制器view-controller

当控制器方法中，仅仅用来实现页面跳转，即只需要设置视图名称时，可以将处理器方法使用view-controller标签进行表示。

<mvc:view-controller path="/testView" view-name="success">mvc:view-controller>
1
2
3
4
5

注：

当SpringMVC中设置了view-controller时，其他控制器中的请求映射将全部失效，此时需要在SpringMVC的核心配置文件中设置开启mvc注解驱动的标签：mvc:annotation-driven/ 。

7. RESTful

7.1. RESTful简介

REST：Representational State Transfer，表现层资源状态转移。

1. 资源

   资源是一种看待服务器的方式，即，将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个抽象的概念，所以它不仅仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西，可以将资源设计的要多抽象有多抽象，只要想象力允许而且客户端应用开发者能够理解。与面向对象设计类似，资源是以名词为核心来组织的，首先关注的是名词。一个资源可以由一个或多个URI来标识。URI既是资源的名称，也是资源在Web上的地址。对某个资源感兴趣的客户端应用，可以通过资源的URI与其进行交互。

2. 资源的表述

   资源的表述是一段对于资源在某个特定时刻的状态的描述。可以在客户端-服务器端之间转移（交换）。资源的表述可以有多种格式，例如HTML/XML/JSON/纯文本/图片/视频/音频等等。资源的表述格式可以通过协商机制来确定。请求-响应方向的表述通常使用不同的格式。

3. 状态转移

   状态转移说的是：在客户端和服务器端之间转移（transfer）代表资源状态的表述。通过转移和操作资源的表述，来间接实现操作资源的目的。

7.2. RESTful的实现

具体说，就是 HTTP 协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。

它们分别对应四种基本操作：GET 用来获取资源，POST 用来新建资源，PUT 用来更新资源，DELETE 用来删除资源。

REST 风格提倡 URL 地址使用统一的风格设计，从前到后各个单词使用斜杠分开，不使用问号键值对方式携带请求参数，而是将要发送给服务器的数据作为 URL 地址的一部分，以保证整体风格的一致性。

7.3. HiddenHttpMethodFilter

由于浏览器只支持发送get和post方式的请求，那么该如何发送put和delete请求呢？

SpringMVC 提供了 HiddenHttpMethodFilter 帮助我们将 POST 请求转换为 DELETE 或 PUT 请求。

HiddenHttpMethodFilter 处理put和delete请求的条件：

• 当前请求的请求方式必须为post。

• 当前请求必须传输请求参数_method。

满足以上条件，HiddenHttpMethodFilter 过滤器就会将当前请求的请求方式转换为请求参数**_method的值，因此请求参数_method**的值才是最终的请求方式。

在web.xml中注册HiddenHttpMethodFilter 。

<filter>
    <filter-name>HiddenHttpMethodFilterfilter-name>
    <filter-class>org.springframework.web.filter.HiddenHttpMethodFilterfilter-class>
filter>
<filter-mapping>
    <filter-name>HiddenHttpMethodFilterfilter-name>
    <url-pattern>/*url-pattern>
filter-mapping>
1
2
3
4
5
6
7
8

注：

到目前为止，该SpringMVC项目中配置了两个过滤器：CharacterEncodingFilter和HiddenHttpMethodFilter。在web.xml中注册时，必须先注册CharacterEncodingFilter，再注册HiddenHttpMethodFilter。

原因：

• 在 CharacterEncodingFilter 中通过 request.setCharacterEncoding(encoding) 方法设置字符集。

• request.setCharacterEncoding(encoding) 方法要求前面不能有任何获取请求参数的操作。

• 而 HiddenHttpMethodFilter 恰恰有一个获取请求方式的操作：

  String paramValue = request.getParameter(*this*.methodParam);
  1

8. RESTful案例

8.1. 准备工作

和传统 CRUD 一样，实现对员工信息的增删改查。

1. 搭建环境

2. 准备实体类

   @Data
   @AllArgsConstructor
   @NoArgsConstructor
   public class Employee {
       private Integer id;
       private String lastName;
       private String email;
       //1 male, 0 female
       private Integer gender;
   }
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10

3. 准备dao模拟数据

   @Repository
   public class EmployeeDao {
   
       private static Map<Integer, Employee> employees;
   
       static {
           employees = new HashMap<>();
           employees.put(1001, new Employee(1001, "E-AA", "aa@163.com", 1));
           employees.put(1002, new Employee(1002, "E-BB", "bb@163.com", 1));
           employees.put(1003, new Employee(1003, "E-CC", "cc@163.com", 0));
           employees.put(1004, new Employee(1004, "E-DD", "dd@163.com", 0));
           employees.put(1005, new Employee(1005, "E-EE", "ee@163.com", 1));
       }
   
       private static Integer initId = 1006;
   
       /**
        * 如果没有，就添加；如果有，就修改。
        */
       public void save(Employee employee) {
           if (employee.getId() == null) {
               employee.setId(initId++);
           }
           employees.put(employee.getId(), employee);
       }
   
       public Collection<Employee> getAll() {
           return employees.values();
       }
   
       public Employee get(Integer id) {
           return employees.get(id);
       }
   
       public void delete(Integer id) {
           employees.remove(id);
       }
   }
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38

8.2. 功能清单

8.3. 具体功能：访问首页

1. 配置view-controller

   <mvc:view-controller path="/" view-name="index"/>
   1

2. 创建页面

   DOCTYPE html>
   <html lang="en" xmlns:th="http://www.thymeleaf.org">
   <head>
       <meta charset="UTF-8">
       <title>Titletitle>
   head>
   <body>
   <h1>首页h1>
   <a th:href="@{/employee}">访问员工信息a>
   body>
   html>
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11

8.4. 具体功能：查询所有员工数据

1. 控制器方法

   @RequestMapping(value = "/employee", method = RequestMethod.GET)
   public String getEmployeeList(Model model) {
       Collection<Employee> employeeList = employeeDao.getAll();
       model.addAttribute("employeeList", employeeList);
       return "employee_list";
   }
   1
   2
   3
   4
   5
   6

2. 创建employee_list.html

   DOCTYPE html>
   <html lang="en" xmlns:th="http://www.thymeleaf.org">
   <head>
       <meta charset="UTF-8">
       <title>Employee Infotitle>
       <script type="text/javascript" th:src="@{/static/js/vue.js}">script>
   head>
   <body>
   
   <table border="1" cellpadding="0" cellspacing="0" style="text-align: center;" id="dataTable">
       <tr>
           <th colspan="5">Employee Infoth>
       tr>
       <tr>
           <th>idth>
           <th>lastNameth>
           <th>emailth>
           <th>genderth>
           <th>options(<a th:href="@{/toAdd}">adda>)th>
       tr>
       <tr th:each="employee : ${employeeList}">
           <td th:text="${employee.id}">td>
           <td th:text="${employee.lastName}">td>
           <td th:text="${employee.email}">td>
           <td th:text="${employee.gender}">td>
           <td>
               <a class="deleteA" @click="deleteEmployee" th:href="@{'/employee/'+${employee.id}}">deletea>
               <a th:href="@{'/employee/'+${employee.id}}">updatea>
           td>
       tr>
   table>
   body>
   html>
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33

8.5. 具体功能：删除

1. 创建处理delete请求方式的表单

   
   <form id="delete_form" method="post">
       
       <input type="hidden" name="_method" value="delete"/>
   form>
   1
   2
   3
   4
   5

2. 创建删除超链接绑定点击事件

   1. 引入vue.js

      <script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
      1

3. 删除超链接

   <a class="deleteA" @click="deleteEmployee" th:href="@{'/employee/'+${employee.id}}">deletea>
   1

4. 通过vue处理点击事件

   <script type="text/javascript">
       var vue = new Vue({
           el: "#dataTable",
           methods: {
               //event表示当前事件
               deleteEmployee: function (event) {
                   //通过id获取表单标签
                   var delete_form = document.getElementById("delete_form");
                   //将触发事件的超链接的href属性为表单的action属性赋值
                   delete_form.action = event.target.href;
                   //提交表单
                   delete_form.submit();
                   //阻止超链接的默认跳转行为
                   event.preventDefault();
               }
           }
       });
   </script>
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18

5. 控制器方法

   @RequestMapping(value = "/employee/{id}", method = RequestMethod.DELETE)
   public String deleteEmployee(@PathVariable("id") Integer id) {
       employeeDao.delete(id);
       return "redirect:/employee";
   }
   1
   2
   3
   4
   5

8.6. 具体功能：跳转到添加数据页面

1. 配置view-controller

   <mvc:view-controller path="/toAdd" view-name="employee_add"/>
   1

2. 创建employee_add.html

   DOCTYPE html>
   <html lang="en" xmlns:th="http://www.thymeleaf.org">
   <head>
       <meta charset="UTF-8">
       <title>Add Employeetitle>
   head>
   <body>
   
   <form th:action="@{/employee}" method="post">
       lastName:<input type="text" name="lastName"><br>
       email:<input type="text" name="email"><br>
       gender:<input type="radio" name="gender" value="1">male
       <input type="radio" name="gender" value="0">female<br>
       <input type="submit" value="add"><br>
   form>
   
   body>
   html>
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18

8.7. 具体功能：执行保存

控制器方法

@RequestMapping(value = "/employee", method = RequestMethod.POST)
public String addEmployee(Employee employee) {
    employeeDao.save(employee);
    return "redirect:/employee";
}
1
2
3
4
5

8.8. 具体功能：跳转到更新数据页面

1. 修改超链接

   <a th:href="@{'/employee/'+${employee.id}}">updatea>
   1

2. 控制器方法

   @RequestMapping(value = "/employee/{id}", method = RequestMethod.GET)
   public String getEmployeeById(@PathVariable("id") Integer id, Model model) {
       Employee employee = employeeDao.get(id);
       model.addAttribute("employee", employee);
       return "employee_update";
   }
   1
   2
   3
   4
   5
   6

3. 创建employee_update.html

   DOCTYPE html>
   <html lang="en" xmlns:th="http://www.thymeleaf.org">
   <head>
       <meta charset="UTF-8">
       <title>Update Employeetitle>
   head>
   <body>
   
   <form th:action="@{/employee}" method="post">
       <input type="hidden" name="_method" value="put">
       <input type="hidden" name="id" th:value="${employee.id}">
       lastName:<input type="text" name="lastName" th:value="${employee.lastName}"><br>
       email:<input type="text" name="email" th:value="${employee.email}"><br>
       
       gender:<input type="radio" name="gender" value="1" th:field="${employee.gender}">male
       <input type="radio" name="gender" value="0" th:field="${employee.gender}">female<br>
       <input type="submit" value="update"><br>
   form>
   
   body>
   html>
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24

8.9. 具体功能：执行更新

控制器方法

@RequestMapping(value = "/employee", method = RequestMethod.PUT)
public String updateEmployee(Employee employee) {
    employeeDao.save(employee);
    return "redirect:/employee";
}
1
2
3
4
5

9. HttpMessageConverter

HttpMessageConverter，报文信息转换器，将请求报文转换为Java对象，或将Java对象转换为响应报文。

HttpMessageConverter 提供了两个注解和两个类型：@RequestBody，@ResponseBody，RequestEntity，ResponseEntity。

9.1. @RequestBody

@RequestBody可以获取请求体，在控制器方法设置一个形参，使用@RequestBody进行标识，当前请求的请求体就会为当前注解所标识的形参赋值。

<form th:action="@{/testRequestBody}" method="post">
    用户名：<input type="text" name="username"><br>
    密码：<input type="password" name="password"><br>
    <input type="submit">
form>
1
2
3
4
5

@RequestMapping("/testRequestBody")
public String testRequestBody(@RequestBody String requestBody) {
    System.out.println("requestBody:" + requestBody);
    return "success";
}
1
2
3
4
5

输出结果：

requestBody:username=admin&password=123456

9.2. RequestEntity

RequestEntity会将请求报文进行封装，在控制器方法的形参中设置该类型的形参，当前请求的请求报文就会赋值给该形参，可以通过getHeaders()获取请求头信息，通过getBody()获取请求体信息。

@RequestMapping("/testRequestEntity")
public String testRequestEntity(RequestEntity<String> requestEntity) {
    System.out.println("requestHeader:" + requestEntity.getHeaders());
    System.out.println("requestBody:" + requestEntity.getBody());
    return "success";
}
1
2
3
4
5
6

输出结果：

requestHeader:[host:“localhost:8080”,
connection:“keep-alive”, content-length:“27”,
cache-control:“max-age=0”, sec-ch-ua:“” Not A;Brand";v=“99”,
“Chromium”;v=“90”, “Google Chrome”;v=“90"”,
sec-ch-ua-mobile:“?0”, upgrade-insecure-requests:“1”,
origin:“http://localhost:8080”, user-agent:“Mozilla/5.0
(Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko)
Chrome/90.0.4430.93 Safari/537.36”]
requestBody:username=admin&password=123

9.3. @ResponseBody

@ResponseBody用于标识一个控制器方法，可以将该方法的返回值直接作为响应报文的响应体响应到浏览器。

@RequestMapping("/testResponseBody")
@ResponseBody
public String testResponseBody() {
    return "success";
}
1
2
3
4
5

结果：浏览器页面显示 success 字符串。

9.3.1. SpringMVC处理json

@ResponseBody处理json的步骤：

1. 导入jackson的依赖

   <dependency>
       <groupId>com.fasterxml.jackson.coregroupId>
       <artifactId>jackson-databindartifactId>
       <version>2.12.1version>
   dependency>
   1
   2
   3
   4
   5

2. 在SpringMVC的核心配置文件中开启mvc的注解驱动，此时在HandlerAdaptor中会自动装配一个消息转换器：MappingJackson2HttpMessageConverter，可以将响应到浏览器的Java对象转换为Json格式的字符串。

   <mvc:annotation-driven/>
   1

3. 在处理器方法上使用@ResponseBody注解进行标识。

4. 将Java对象直接作为控制器方法的返回值返回，框架会将其自动转换为Json格式的字符串。

   @RequestMapping("/testResponseUser")
   @ResponseBody
   public User testResponseUser() {
       return new User(1001, "admin", "123456", 23, "男");
   }
   1
   2
   3
   4
   5

   浏览器的页面中展示的结果：

   {“id”:1001,“username”:“admin”,“password”:“123456”,“age”:23,“sex”:“男”}

9.3.2. SpringMVC处理ajax

1. 请求超链接

   <div id="app">
       <a th:href="@{/testAjax}" @click="testAjax">testAjaxa><br>
   div>
   1
   2
   3

2. 通过vue和axios处理点击事件

   <script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
   <script type="text/javascript" th:src="@{/static/js/axios.min.js}"></script>
   <script type="text/javascript">
       var vue = new Vue({
           el: "#app",
           methods: {
               testAjax: function (event) {
                   axios({
                       method: "post",
                       url: event.target.href,
                       params: {
                           username: "admin",
                           password: "123456"
                       }
                   }).then(function (response) {
                       alert(response.data);
                   });
                   event.preventDefault();
               }
           }
       });
   </script>
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22

3. 控制器方法

   @RequestMapping("/testAjax")
   @ResponseBody
   public String testAjax(String username, String password) {
       System.out.println("username:" + username + ",password:" + password);
       return "hello,ajax";
   }
   1
   2
   3
   4
   5
   6

9.3.3. @RestController注解

@RestController注解是springMVC提供的一个复合注解，标识在控制器的类上，就相当于为类添加了@Controller注解，并且为其中的每个方法添加了 @ResponseBody 注解。

9.4. ResponseEntity

ResponseEntity用于标识控制器方法的返回值类型，该控制器方法的返回值就是响应到浏览器的响应报文。

可用于文件的上传和下载，具体查看下个章节。

10. 文件上传和下载

10.1. 文件下载

使用ResponseEntity实现下载文件的功能。

@RequestMapping("/testDown")
public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws IOException {
    //获取ServletContext对象
    ServletContext servletContext = session.getServletContext();
    //获取服务器中文件的真实路径
    String realPath = servletContext.getRealPath("/static/img/1.jpg");
    //创建输入流
    InputStream is = new FileInputStream(realPath);
    //创建字节数组
    byte[] bytes = new byte[is.available()];
    //将流读到字节数组中
    is.read(bytes);
    //创建HttpHeaders对象设置响应头信息
    MultiValueMap<String, String> headers = new HttpHeaders();
    //设置要下载方式以及下载文件的名字
    headers.add("Content-Disposition", "attachment;filename=1.jpg");
    //设置响应状态码
    HttpStatus statusCode = HttpStatus.OK;
    //创建ResponseEntity对象
    ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes, headers, statusCode);
    //关闭输入流
    is.close();
    return responseEntity;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

10.2. 文件上传

文件上传要求form表单的请求方式必须为post，并且添加属性enctype=“multipart/form-data”。

SpringMVC中将上传的文件封装到MultipartFile对象中，通过此对象可以获取文件相关信息。

上传步骤

1. 添加依赖

   <dependency>
       <groupId>commons-fileuploadgroupId>
       <artifactId>commons-fileuploadartifactId>
       <version>1.3.1version>
   dependency>
   1
   2
   3
   4
   5

2. 在SpringMVC的配置文件中添加配置

   
   <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">bean>
   1
   2

3. 控制器方法

   @RequestMapping("/testUp")
   public String testUp(MultipartFile file, HttpSession session) throws IOException {
       //获取上传的文件的文件名
       String fileName = file.getOriginalFilename();
       //处理文件重名问题
       String hzName = Objects.requireNonNull(fileName).substring(fileName.lastIndexOf("."));
       fileName = UUID.randomUUID() + hzName;
       //获取服务器中photo目录的路径
       ServletContext servletContext = session.getServletContext();
       String realPath = servletContext.getRealPath("photo");
       File directory = new File(realPath);
       if (!directory.exists()) {
           directory.mkdirs();
       }
       String finalPath = realPath + File.separator + fileName;
       //实现上传功能
       file.transferTo(new File(finalPath));
       return "success";
   }
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19

11. 拦截器

11.1. 拦截器的配置

SpringMVC中的拦截器用于拦截控制器方法的执行。

SpringMVC中的拦截器需要实现HandlerInterceptor。

SpringMVC的拦截器必须在SpringMVC的配置文件中进行配置。

<bean class="com.atguigu.mvc.interceptor.FirstInterceptor">bean>
<ref bean="firstInterceptor">ref>

<mvc:interceptor>
    <mvc:mapping path="/**"/>
    <mvc:exclude-mapping path="/testRequestEntity"/>
    <ref bean="firstInterceptor">ref>
mvc:interceptor>

1
2
3
4
5
6
7
8
9

11.2. 拦截器的三个抽象方法

SpringMVC中的拦截器有三个抽象方法：

• preHandle：控制器方法执行之前执行preHandle()，其boolean类型的返回值表示拦截或放行，返回true为放行，即调用控制器方法；返回false表示拦截，即不调用控制器方法。

• postHandle：控制器方法执行之后执行postHandle()。

• afterComplation：处理完视图和模型数据，渲染视图完毕之后执行afterComplation()。

11.3. 多个拦截器的执行顺序

1. 若每个拦截器的preHandle()都返回true

   此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关：

   ​ preHandle()会按照配置的顺序执行，而postHandle()和afterComplation()会按照配置的反序执行。

2. 若某个拦截器的preHandle()返回了false

   preHandle()返回false的和它之前的拦截器的preHandle()都会执行，postHandle()都不执行，返回false的拦截器之前的拦截器的afterComplation()会执行。

12. 异常处理器

12.1. 基于配置的异常处理

SpringMVC提供了一个处理控制器方法执行过程中所出现的异常的接口：HandlerExceptionResolver。

HandlerExceptionResolver接口的实现类有：DefaultHandlerExceptionResolver和SimpleMappingExceptionResolver。

SpringMVC提供了自定义的异常处理器SimpleMappingExceptionResolver，下面是使用方式。

<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
    <property name="exceptionMappings">
        <props>
            
            <prop key="java.lang.ArithmeticException">errorprop>
        props>
    property>
    
    <property name="exceptionAttribute" value="ex">property>

//@ControllerAdvice将当前类标识为异常处理的组件
@ControllerAdvice
public class ExceptionController {
    //@ExceptionHandler用于设置所标识方法处理的异常
    @ExceptionHandler(ArithmeticException.class)
    //ex表示当前请求处理中出现的异常对象
    public String handleArithmeticException(Exception ex, Model model) {
        model.addAttribute("ex", ex);
        return "error";
    }
}
1
2
3
4
5
6
7
8
9
10
11

@Configuration
public class SpringConfig {
    //ssm整合之后，spring的配置信息写在此类中
}
1
2
3
4

@Configuration
//扫描组件
@ComponentScan("com.atguigu.mvc.controller")
//开启MVC注解驱动
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    //使用默认的servlet处理静态资源
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    //配置文件上传解析器
    @Bean
    public CommonsMultipartResolver multipartResolver() {
        return new CommonsMultipartResolver();
    }

    //配置拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        FirstInterceptor firstInterceptor = new FirstInterceptor();
        registry.addInterceptor(firstInterceptor).addPathPatterns("/**");
    }

    //配置视图控制

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("index");
    }

    //配置异常映射
    @Override
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
        SimpleMappingExceptionResolver exceptionResolver = new SimpleMappingExceptionResolver();
        Properties prop = new Properties();
        prop.setProperty("java.lang.ArithmeticException", "error");
        //设置异常映射
        exceptionResolver.setExceptionMappings(prop);
        //设置共享异常信息的键
        exceptionResolver.setExceptionAttribute("ex");
        resolvers.add(exceptionResolver);
    }

    //配置生成模板解析器
    @Bean
    public ITemplateResolver templateResolver() {
        WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
        // ServletContextTemplateResolver需要一个ServletContext作为构造参数，可通过WebApplicationContext 的方法获得
        ServletContextTemplateResolver templateResolver = new ServletContextTemplateResolver(webApplicationContext.getServletContext());
        templateResolver.setPrefix("/WEB-INF/templates/");
        templateResolver.setSuffix(".html");
        templateResolver.setCharacterEncoding("UTF-8");
        templateResolver.setTemplateMode(TemplateMode.HTML);
        return templateResolver;
    }

    //生成模板引擎并为模板引擎注入模板解析器
    @Bean
    public SpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
        SpringTemplateEngine templateEngine = new SpringTemplateEngine();
        templateEngine.setTemplateResolver(templateResolver);
        return templateEngine;
    }

    //生成视图解析器并未解析器注入模板引擎
    @Bean
    public ViewResolver viewResolver(SpringTemplateEngine templateEngine) {
        ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
        viewResolver.setCharacterEncoding("UTF-8");
        viewResolver.setTemplateEngine(templateEngine);
        return viewResolver;
    }


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

import com.atguigu.mvc.configuration.SpringConfig;
import com.atguigu.mvc.configuration.WebConfig;
import org.springframework.web.filter.CharacterEncodingFilter;
import org.springframework.web.filter.HiddenHttpMethodFilter;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

import javax.servlet.Filter;

public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer {

    /**
     * 指定spring的配置类
     *
     * @return
     */
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }

    /**
     * 指定SpringMVC的配置类
     *
     * @return
     */
    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{WebConfig.class};
    }

    /**
     * 指定DispatcherServlet的映射规则，即url-pattern
     *
     * @return
     */
    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    /**
     * 添加过滤器
     *
     * @return
     */
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter encodingFilter = new CharacterEncodingFilter();
        encodingFilter.setEncoding("UTF-8");
        encodingFilter.setForceRequestEncoding(true);
        HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
        return new Filter[]{encodingFilter, hiddenHttpMethodFilter};
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

@RequestMapping("/")
public String index() {
    //设置视图名称
    return "index";
}
1
2
3
4
5

protected WebApplicationContext initWebApplicationContext() {
    WebApplicationContext rootContext = WebApplicationContextUtils.getWebApplicationContext(getServletContext());
    WebApplicationContext wac = null;

    if (this.webApplicationContext != null) {
        // A context instance was injected at construction time -> use it
        wac = this.webApplicationContext;
        if (wac instanceof ConfigurableWebApplicationContext) {
            ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac;
            if (!cwac.isActive()) {
                // The context has not yet been refreshed -> provide services such as
                // setting the parent context, setting the application context id, etc
                if (cwac.getParent() == null) {
                    // The context instance was injected without an explicit parent -> set
                    // the root application context (if any; may be null) as the parent
                    cwac.setParent(rootContext);
                }
                configureAndRefreshWebApplicationContext(cwac);
            }
        }
    }
    if (wac == null) {
        // No context instance was injected at construction time -> see if one
        // has been registered in the servlet context. If one exists, it is assumed
        // that the parent context (if any) has already been set and that the
        // user has performed any initialization such as setting the context id
        wac = findWebApplicationContext();
    }
    if (wac == null) {
        // No context instance is defined for this servlet -> create a local one
        // 创建WebApplicationContext
        wac = createWebApplicationContext(rootContext);
    }

    if (!this.refreshEventReceived) {
        // Either the context is not a ConfigurableApplicationContext with refresh
        // support or the context injected at construction time had already been
        // refreshed -> trigger initial onRefresh manually here.
        synchronized (this.onRefreshMonitor) {
            // 刷新WebApplicationContext
            onRefresh(wac);
        }
    }

    if (this.publishContext) {
        // Publish the context as a servlet context attribute.
        // 将IOC容器在应用域共享
        String attrName = getServletContextAttributeName();
        getServletContext().setAttribute(attrName, wac);
    }

    return wac;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

protected WebApplicationContext createWebApplicationContext(@Nullable ApplicationContext parent) {
    Class<?> contextClass = getContextClass();
    if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
        throw new ApplicationContextException(
                "Fatal initialization error in servlet with name '" + getServletName() +
                        "': custom WebApplicationContext class [" + contextClass.getName() +
                        "] is not of type ConfigurableWebApplicationContext");
    }
    // 通过反射创建 IOC 容器对象
    ConfigurableWebApplicationContext wac = (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);

    wac.setEnvironment(getEnvironment());
    // 设置父容器
    wac.setParent(parent);
    String configLocation = getContextConfigLocation();
    if (configLocation != null) {
        wac.setConfigLocation(configLocation);
    }
    configureAndRefreshWebApplicationContext(wac);
    return wac;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

protected void initStrategies(ApplicationContext context) {
    initMultipartResolver(context);
    initLocaleResolver(context);
    initThemeResolver(context);
    initHandlerMappings(context);
    initHandlerAdapters(context);
    initHandlerExceptionResolvers(context);
    initRequestToViewNameTranslator(context);
    initViewResolvers(context);
    initFlashMapManager(context);
}
1
2
3
4
5
6
7
8
9
10
11

protected final void processRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

    long startTime = System.currentTimeMillis();
    Throwable failureCause = null;

    LocaleContext previousLocaleContext = LocaleContextHolder.getLocaleContext();
    LocaleContext localeContext = buildLocaleContext(request);

    RequestAttributes previousAttributes = RequestContextHolder.getRequestAttributes();
    ServletRequestAttributes requestAttributes = buildRequestAttributes(request, response, previousAttributes);

    WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
    asyncManager.registerCallableInterceptor(FrameworkServlet.class.getName(), new RequestBindingInterceptor());

    initContextHolders(request, localeContext, requestAttributes);

    try {
        // 执行服务，doService()是一个抽象方法，在DispatcherServlet中进行了重写
        doService(request, response);
    } catch (ServletException | IOException ex) {
        failureCause = ex;
        throw ex;
    } catch (Throwable ex) {
        failureCause = ex;
        throw new NestedServletException("Request processing failed", ex);
    } finally {
        resetContextHolders(request, previousLocaleContext, previousAttributes);
        if (requestAttributes != null) {
            requestAttributes.requestCompleted();
        }
        logResult(request, response, failureCause, asyncManager);
        publishRequestHandledEvent(request, response, startTime, failureCause);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

@Override
protected void doService(HttpServletRequest request, HttpServletResponse response) throws Exception {
    logRequest(request);

    // Keep a snapshot of the request attributes in case of an include,
    // to be able to restore the original attributes after the include.
    Map<String, Object> attributesSnapshot = null;
    if (WebUtils.isIncludeRequest(request)) {
        attributesSnapshot = new HashMap<>();
        Enumeration<?> attrNames = request.getAttributeNames();
        while (attrNames.hasMoreElements()) {
            String attrName = (String) attrNames.nextElement();
            if (this.cleanupAfterInclude || attrName.startsWith(DEFAULT_STRATEGIES_PREFIX)) {
                attributesSnapshot.put(attrName, request.getAttribute(attrName));
            }
        }
    }

    // Make framework objects available to handlers and view objects.
    request.setAttribute(WEB_APPLICATION_CONTEXT_ATTRIBUTE, getWebApplicationContext());
    request.setAttribute(LOCALE_RESOLVER_ATTRIBUTE, this.localeResolver);
    request.setAttribute(THEME_RESOLVER_ATTRIBUTE, this.themeResolver);
    request.setAttribute(THEME_SOURCE_ATTRIBUTE, getThemeSource());

    if (this.flashMapManager != null) {
        FlashMap inputFlashMap = this.flashMapManager.retrieveAndUpdate(request, response);
        if (inputFlashMap != null) {
            request.setAttribute(INPUT_FLASH_MAP_ATTRIBUTE, Collections.unmodifiableMap(inputFlashMap));
        }
        request.setAttribute(OUTPUT_FLASH_MAP_ATTRIBUTE, new FlashMap());
        request.setAttribute(FLASH_MAP_MANAGER_ATTRIBUTE, this.flashMapManager);
    }

    RequestPath requestPath = null;
    if (this.parseRequestPath && !ServletRequestPathUtils.hasParsedRequestPath(request)) {
        requestPath = ServletRequestPathUtils.parseAndCache(request);
    }

    try {
        // 处理请求和响应
        doDispatch(request, response);
    } finally {
        if (!WebAsyncUtils.getAsyncManager(request).isConcurrentHandlingStarted()) {
            // Restore the original attribute snapshot, in case of an include.
            if (attributesSnapshot != null) {
                restoreAttributesAfterInclude(request, attributesSnapshot);
            }
        }
        if (requestPath != null) {
            ServletRequestPathUtils.clearParsedRequestPath(request);
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
    HttpServletRequest processedRequest = request;
    HandlerExecutionChain mappedHandler = null;
    boolean multipartRequestParsed = false;

    WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);

    try {
        ModelAndView mv = null;
        Exception dispatchException = null;

        try {
            processedRequest = checkMultipart(request);
            multipartRequestParsed = (processedRequest != request);

            // Determine handler for the current request.
            /*
                mappedHandler：调用链
                包含handler、interceptorList、interceptorIndex
                handler：浏览器发送的请求所匹配的控制器方法
                interceptorList：处理控制器方法的所有拦截器集合
                interceptorIndex：拦截器索引，控制拦截器afterCompletion()的执行
            */
            mappedHandler = getHandler(processedRequest);
            if (mappedHandler == null) {
                noHandlerFound(processedRequest, response);
                return;
            }

            // Determine handler adapter for the current request.
            // 通过控制器方法创建相应的处理器适配器，调用所对应的控制器方法
            HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

            // Process last-modified header, if supported by the handler.
            String method = request.getMethod();
            boolean isGet = "GET".equals(method);
            if (isGet || "HEAD".equals(method)) {
                long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
                if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {
                    return;
                }
            }

            // 调用拦截器的preHandle()
            if (!mappedHandler.applyPreHandle(processedRequest, response)) {
                return;
            }

            // Actually invoke the handler.
            // 由处理器适配器调用具体的控制器方法，最终获得ModelAndView对象
            mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

            if (asyncManager.isConcurrentHandlingStarted()) {
                return;
            }

            applyDefaultViewName(processedRequest, mv);
            // 调用拦截器的postHandle()
            mappedHandler.applyPostHandle(processedRequest, response, mv);
        } catch (Exception ex) {
            dispatchException = ex;
        } catch (Throwable err) {
            // As of 4.3, we're processing Errors thrown from handler methods as well,
            // making them available for @ExceptionHandler methods and other scenarios.
            dispatchException = new NestedServletException("Handler dispatch failed", err);
        }
        // 后续处理：处理模型数据和渲染视图
        processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
    } catch (Exception ex) {
        triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
    } catch (Throwable err) {
        triggerAfterCompletion(processedRequest, response, mappedHandler, new NestedServletException("Handler processing failed", err));
    } finally {
        if (asyncManager.isConcurrentHandlingStarted()) {
            // Instead of postHandle and afterCompletion
            if (mappedHandler != null) {
                mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
            }
        } else {
            // Clean up any resources used by a multipart request.
            if (multipartRequestParsed) {
                cleanupMultipart(processedRequest);
            }
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

private void processDispatchResult(HttpServletRequest request, HttpServletResponse response, @Nullable HandlerExecutionChain mappedHandler, @Nullable ModelAndView mv, @Nullable Exception exception) throws Exception {

    boolean errorView = false;

    if (exception != null) {
        if (exception instanceof ModelAndViewDefiningException) {
            logger.debug("ModelAndViewDefiningException encountered", exception);
            mv = ((ModelAndViewDefiningException) exception).getModelAndView();
        } else {
            Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);
            mv = processHandlerException(request, response, handler, exception);
            errorView = (mv != null);
        }
    }

    // Did the handler return a view to render?
    if (mv != null && !mv.wasCleared()) {
        // 处理模型数据和渲染视图
        render(mv, request, response);
        if (errorView) {
            WebUtils.clearErrorRequestAttributes(request);
        }
    } else {
        if (logger.isTraceEnabled()) {
            logger.trace("No view rendering, null ModelAndView returned.");
        }
    }

    if (WebAsyncUtils.getAsyncManager(request).isConcurrentHandlingStarted()) {
        // Concurrent handling started during a forward
        return;
    }

    if (mappedHandler != null) {
        // Exception (if any) is already handled..
        // 调用拦截器的afterCompletion()
        mappedHandler.triggerAfterCompletion(request, response, null);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39