斗转星移，无人能及——Spring MVC

Spring MVC 简介

• MVC 模式是软件工程中的一种软件架构模式，把软件系统分为 3 个基本部分：模型（Model）、视图（View）和控制器（Controller）。
  • 模型（Model）
    • Model 是由一个实体 Bean 实现的，是数据的载体
  • 视图（View）
    • 在 Java EE 应用程序中，View 可以由 JSP（Java Server Page）担任。
    • 在目前的前/后端分离模式下，View 已经由前端取代。
  • 控制器（Controller）
    • 在 Java EE 应用中，Controller 可能是一个 Servlet。
    • 在 Spring MVC 中，控制器的核心是 DispatcherServlet。

接收参数的各种方式

• Spring MVC 接收参数的方式大致可以分为以下 4 种：
  • 无注解方式
  • ＠RequestParam 方式
  • ＠PathVariable 方式
  • ＠RequestBody 方式

常用注解

• @Controller
  • ＠Controller 用来修饰类，表示该类为一个 Controller 对象。
  • Spring 容器在启动时会将该类实例化。
• @RequestMapping
  • ＠RequestMapping 用来修饰类或方法，设置接口的访问路径。
  • 在修饰类时，一般用于设置该类下所有接口路径的前缀。
• @ResponseBody
  • ＠ResponseBody 用来修饰类或方法。
  • 在修饰方法时，该方法以 JSON 格式返回数据；
  • 在修饰类时，该类下的所有方法默认都以 JSON 格式返回数据。
• @RequestParam
  • ＠RequestParam 用来修饰参数，可以根据名字与参数进行绑定，相当于 ServletRequest.getParameter()。
• @RequestBody
  • ＠RequestBody 用来修饰参数，接收 JSON 格式的参数，经常应用于 AJAX 请求，前/后端分离的场景下。
• @PathVariable
  • ＠PathVariable 用来修饰参数，用于获取 URL 上的值。
• 组合注解
  • 由多个注解或一个注解与一个特定的属性值组成的注解，相当于对注解的一种封装；
  • 封装后的注解具有多个功能；
  • @RestController=@Controller+@ResponseBody；
  • @GetMapping=@RequestMapping(method=RequestMethod.GET)；
  • @PostMapping=@RequestMapping(method=RequestMethod.POST)；
  • @PutMapping=@RequestMapping(method=RequestMethod.PUT)；
  • @PatchMapping=@RequestMapping(method=RequestMethod.PATCH)；
  • @DeleteMapping=@RequestMapping(method=RequestMethod.DELETE)。

准备工作

• 在正式开始之前，需要做一些准备工作。
  • 首先，我们需要创建一个 User 类，用来接收 JSON 参数及返回 JSON 数据：

    public class User {private String name;private int age;
    }
    

  • 使用 ＠Data 注解时，需要在 pom 文件中添加以下依赖：

    org.projectlomboklombok
    
    

  • 然后，我们需要在 Intellij IDEA 中安装 Lombok 插件。
  • 最后，我们需要创建一个 ParamController 类：

    @RestController
    public class ParamController {
    }
    

无注解方式

• 无注解方式最简单，其写法和之前的 Hello World 程序差不多：

  @GetMapping("/noAnnotation")
  public User noAnnotation(User user) {return user;
  }
  

• 在浏览器中访问 http://localhost:8080/noAnnotation?name=无注解方式&age=1，会看到浏览器中打印出如下内容：
  

＠RequestParam 方式

• ＠RequestParam 有 4 个属性：
  
• 示例代码为：

  @GetMapping("/requestParam")
  public User requestParam(@RequestParam String name, @RequestParam int age) {User user = new User();user.setName(name);user.setAge(age);return user;
  }
  

• 在浏览器中访问 http://localhost:8080/requestparam?name=＠RequestParam方式&age=2，会看到浏览器中打印出如下内容：
  

＠PathVariable 方式

• ＠PathVariable 有 3 个属性：
  
• 示例代码如下：

  @GetMapping("/pathVariable/{name}/{age}")
  public User pathVariable(@PathVariable String name, @PathVariable int age) {User user = new User();user.setName(name);user.setAge(age);return user;
  }
  

• 在浏览器中访问 http://localhost:8080/pathVariable/＠PathVariable 方式/3，会看到浏览器中打印出如下内容：
  

＠RequestBody 方式

• ＠RequestBody 只有一个属性：
  
• 示例代码如下：

  @PostMapping("/requestBody")
  public User requestBody(@RequestBody User user) {return user;
  }
  

• 注意，这次需要使用 POST 方式请求接口，而浏览器的地址栏不能直接发送 POST 请求。
• 所以，我们需要借助其他工具，可以使用 Postman、Intellij IDEA 自带的 HTTP Client 或其他 HTTP 发送工具，以 postman 为例：
  

参数校验

• 说到传参，就避不开参数校验。
  • 在实际开发中，我们需要根据需求对参数进行各种各样的校验：是否为空、是否超出取值范围、是否为数字、E-mail 格式是否正确等。
  • 在没有数据校验 API 之前，我们需要自己实现这些校验的代码。

开启参数校验

• 添加 validation 的 Starter 依赖：

  org.springframework.bootspring-boot-starter-validation
  
  

• 为数据对象添加注解：

  @Data
  public class User {@NotBlank(message = "名字不能为空")private String name;@Min( value = 1, message = "年龄要不能小于 1")@Max( value = 120, message = "年龄要不能大于 120")private int age;@Email(message = "Email格式不正确")private String email;@Past(message = "生日必须为过去的时间")private LocalDate birthDay;
  }
  

• 为需要进行校验的参数添加 ＠Valid 注解：

  @PostMapping("/requestBody")
  public User requestBody(@RequestBody @Validated User user) {return user;
  }
  

常用的参数校验注解

原理分析

流程分析

• Spring MVC 最核心的思想在于 DispatcherServlet。
  • 在现在的开发模式中，我们主要使用的也是 Spring MVC 的这一核心功能。
  • 浏览器发起一个请求：
    • DispatcherServlet 接收用户请求。
    • DispatcherServlet 根据用户请求通过 HandlerMapping 找到对应的 Handler，得到一个 HandlerExecutionChain。
    • DispatcherServlet 通过 HandlerAdapter 调用 Controller 进行后续业务逻辑处理。
    • DispatcherServlet 通过 ViewResolver 进行视图解析并返回 View。
    • DispatcherServlet 对 View 进行渲染。
    • 当返回 JSON 格式的数据时，DispatcherServlet 会省去对视图处理的步骤。
      

深入核心

• Spring MVC 的 3 个核心组件：
  • Handler
    • Handler 是用来做具体事情的，对应的是 Controller 里面的方法。
    • 所有有 ＠RequestMapping 的方法都可以被看作一个 Handler。
  • HandlerMapping
    • HandlerMapping 是用来找到 Handler 的，是请求路径与 Handler 的映射关系。
  • HandlerAdapter
    • HandlerAdapter 是一个适配器。
    • 它是用来跟具体的 Handler 配合使用的。
• DispatcherServlet 最核心的方法是 doDispatch：
  • 根据请求找到 Handler；
  • 根据 Handler 找到对应的 HandlerAdapter；
  • 用 HandlerAdapter 处理 Handler；
  • 处理经过以上步骤的结果。

拦截器

• 拦截器在日常开发中有很重要的地位，可以帮助我们完成很多重要的功能：
  • 登录认证；
  • 权限验证；
  • 记录日志；
  • 性能监控。
• Spring MVC 中所有的拦截器都实现/继承自 HandlerInterceptor 接口。
  • 如果想要编写一个自定义拦截器，就需要实现/继承HandlerInterceptor 接口或其子接口/实现类。
    
  • 拦截器的执行流程：
    • 执行 preHandle 方法
      • 该方法会返回一个布尔值。
      • 如果为false，则结束本次请求；
      • 如果为true，则继续本次请求。
    • 执行处理器逻辑，也就是 Controller。
      • 执行 postHandle 方法。
      • 执行 afterCompletion 方法。
    • 多个拦截器按照先进后出的顺序执行。