本文最后更新于 2023-09-16，文章内容可能已经过时。

SpringMVC《源码剖析》1. 简介和基础注解

一、SpringMVC简介

这篇文章篇幅巨长，而且涉及大量的源码，是我看了不少的机构视频，还有博客整合总结的，其中主要关注源码部分，xml配置相关的可以忽略已经过时了。

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视图，渲染数据后最终响应给浏览器

2、什么是SpringMVC

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

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

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

3、SpringMVC的特点

  • Spring 家族原生产品 ，与 IOC 容器等基础设施无缝对接
  • 基于原生的Servlet ，通过了功能强大的前端控制器DispatcherServlet，对请求和响应进行统一处理
  • 表述层各细分领域需要解决的问题 全方位覆盖 ，提供 全面解决方案
  • 代码清新简洁 ，大幅度提升开发效率
  • 内部组件化程度高，可插拔式组件 即插即用 ，想要什么功能配置相应组件即可
  • 性能卓著 ，尤其适合现代大型、超大型互联网项目要求

二、@RequestMapping注解

1、@RequestMapping注解的功能

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

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

2、@RequestMapping注解的位置

@RequestMapping标识一个类：设置映射请求的请求路径的初始信息

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

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

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

}

3、@RequestMapping注解的value属性

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

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

@RequestMapping注解的value属性必须设置，至少通过请求地址匹配请求映射

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

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

4、@RequestMapping注解的method属性

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

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

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

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

@RequestMapping(
        value = {"/testRequestMapping", "/test"},
        method = {RequestMethod.GET, RequestMethod.POST}
)
public String testRequestMapping(){
    return "success";
}

注：

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部分会讲到

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属性-->/test</a><br>

@RequestMapping(
        value = {"/testRequestMapping", "/test"}
        ,method = {RequestMethod.GET, RequestMethod.POST}
        ,params = {"username","password!=123456"}
)
public String testRequestMapping(){
    return "success";
}

注：

若当前请求满足@RequestMapping注解的value和method属性，但是不满足params属性，此时页面回报错400：Parameter conditions “username, password!=123456” not met for actual request parameters: username={admin}, password={123456}

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错误，即资源未找到

7、SpringMVC支持ant风格的路径

？：表示任意的单个字符（必须有字符，不能为空，一些特殊的字符如？ / 不能匹配，因为在html中有特殊的作用）

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

/**：表示任意的一层或多层目录 如果前后有内容，那就真的当成两个*去解析了

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

8、SpringMVC支持路径中的占位符（重点）

原始方式：/deleteUser?id=1

rest方式：/user/1

不能为空，不能只有一个 /

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

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

@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

三、SpringMVC获取请求参数

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";
}

2、通过控制器方法的形参获取请求参数

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

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

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

注：

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

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

若使用 字符串类型 的形参，此参数的值为每个数据中间 使用逗号拼接 的结果
这里如果使用形参获取参数，如果为空会为null，在一些特定情况下，可能会报空指针异常，可以给形参加入@Nullable注解，即可不报错

3、@RequestParam

@RequestParam是将请求参数和控制器方法的形参创建映射关系

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

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

required：设置是否必须传输此请求参数，默认值为true，其实这里类似前面的RequestMapping里面的，params属性，“param”：要求请求映射所匹配的请求必须携带param请求参数，但是可以是空值。

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

类似我们学过的spring里面的@autoweried，也有一个required属性，默认为true，无法自动装配就报错，而基于xml实现的装配则是无法装配就为null

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

它用到的场景更多，因为前面的value映射，相当于让我们的参数可以改别名，让我们的参数名称，可以和请求的名称不同，但是我们完全可以使用一样的，或者是改前端的请求参数名字。

但是如果是默认值部分，这个值可传可不传的情况下，还得用条件判断，或者是三目运算符才能赋默认值

4、@RequestHeader

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

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

这里回顾一下，其实我们的RequestParam默认可以通过同名的方式映射到形参，我们如无必要，可以不用，但是请求头想获取到形参里面，就必须

5、@CookieValue

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

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

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>

@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'}

7、【源码分析】-自定义参数绑定原理

源码解析为什么能通过对象直接从请求域获取数据并反射给对象并返回给浏览器
这部分放在下面的Model View Map那边的参数解析器那里。

8、解决获取请求参数的乱码问题

这里科普一下，如果我们在设置字符编码之前，已经通过request获取parameter了，那么我们的设置将毫无意义，后续获取的参数编码都是原来的编码方式。

同时我们这里还要记住，我们处理 Get请求和Post请求的乱码方式是不同的，Get请求的参数会以字符串拼接的方式 ， 保存在请求报文的queryString里面 ，这里主要是设置Tomcat的xml配置文件，，在Connector里面的属性设置字符编码UTF-8，解决后台获取之后的乱码问题。Tomcat8之后的版本已经不需要设置了。但Tomcat8之前需要。

而Post请求是以form data的请求体进行数据的保存。

这里我们SpringMVC的DispatcherServlet已经设置 load-on-startup，tomcat创建之初，就会跟着一起创建 ，而除此之外三大组件还有监听器和过滤器，而最早实例化的就是ContextLoaderListener ，监听ServletContext对象的创建和销毁的过程(其实这里也被大家称作application，只会在容器建立之初建立一次，这里其实也能形象的理解为什么我们能实现域对象共享数据，因为我们把数据都给了这一个对象，自然通过这个对象获取的数据能被所有用户获取) ，适合用来像我们之前web学的用来读取bean.xml创建IOC容器，之类的一次性操作。

显然设置字符编码应该是，使用过滤器更适合完成这样的操作，这样每次request都会先于DispatcherServlet进行拦截和设置编码

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

这里看源码部分，可以看到有一个属性 encoding，然后找doFiler方法的时候没有找到和以前原生Filter一样的，这里找了父类，然后发现父类是抽象类，然后调用了一个名字类似的，然后去子类找这个，发现只有encoding不为空才会进行后续的操作。
对于 request 的编码，如果满足设置了encoding的值，或者是设置了强制转化，都会根据encoding的值设置编码。
而对于response 只有encoding不为空，且设置强制转化，才会进行转化。

这里看看就行，springboot 不需要配置

<!--配置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>forceResponseEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

注：

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