阶段四：热门框架（第二章：SpringMVC1）

大小曲奇(´ε｀　)

已于 2023-08-17 15:40:08 修改

阅读量92

点赞数

分类专栏：热门框架文章标签： java servlet 开发语言

于 2023-02-06 11:39:20 首次发布

本文链接：https://blog.csdn.net/weixin_52223770/article/details/128185729

版权

热门框架专栏收录该内容

8 篇文章 0 订阅

订阅专栏

本文详细介绍了SpringMVC框架的基本概念、入门案例，包括创建web工程、配置SpringMVC、定义Controller、处理请求与响应。同时，讲解了RESTful风格的请求映射路径、请求参数传递、响应JSON数据等关键点，并通过POSTMan工具展示了接口测试的使用。

摘要由CSDN通过智能技术生成

阶段四：热门框架（第二章：SpringMVC1）

1-SpringMVC

1-SpringMVC

今日目标

能够知道SpringMVC的优点
能够编写SpringMVC入门案例
能够使用PostMan发送请求
能够掌握普通类型参数传递
能够掌握POJO类型参数传递
能够掌握json数据参数传递
能够掌握响应json数据
能够掌握rest风格快速开发
能够完成基于restful页面数据交互案例

学习目标：

掌握基于SpringMVC获取请求参数与响应json数据操作
熟练应用基于REST风格的请求路径设置与参数传递
能够根据实际业务建立前后端开发通信协议并进行实现
基于SSM整合技术开发任意业务模块功能

一、SpringMVC简介

1、SpringMVC概述

问题导入

SpringMVC框架有什么优点？

SpringMVC是一种基于Java实现MVC模型的轻量级Web框架

MVC的全称模型(model)-视图(view)-控制器(controller)
优点
1. 使用简单，开发便捷（相比于Servlet）
2. 灵活性强
  
  java数据与前端的交流以json的格式来进行
  
  在学习SpringMVC之前，我们用的是三层架构：
  web：页面数据收集，产生页面；
  service：业务处理；
  dao：数据的持久化（存、查）

2、入门案例【重点】

代码：springmvc_01_quickstart

问题导入

在Controller中如何定义访问路径，如何响应数据？

2.1、实现步骤

1 创建web工程（Maven结构）
2 设置tomcat服务器，加载web工程(tomcat插件）
3 导入坐标（SpringMVC+Servlet）
4 定义处理请求的功能类（UserController）
5 编写SpringMVC配置类，加载处理请求的Bean。
6 加载SpringMVC配置，并设置SpringMVC请求拦截的路径

2.2、代码实现

【第一步】创建web工程（`Maven结构`）

【第二步】设置`tomcat服务器`，加载web工程(tomcat插件）【也可以不用坐标的形式】

<build>
    <plugins>
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.1</version>
        <configuration>
          <port>80</port>
          <path>/</path>
        </configuration>
      </plugin>
    </plugins>
  </build>

【第三步】导入坐标（`SpringMVC`+`Servlet`）

  <dependencies>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.2.10.RELEASE</version>
    </dependency>
  </dependencies>

注意事项：

课程版本基于Spring主版本5.2.10.RELEASE制作
导入spring-webmvc坐标自动依赖spring相关坐标

【第四步】定义处理请求的功能类（`UserController`）

package com.itheima.controller;

//定义表现层控制器bean
@Controller
public class UserController {

    //设置映射路径为/save，即外部访问路径
    @RequestMapping("/save")  //映射路径
    //设置当前操作返回结果为指定json数据（本质上是一个字符串信息）
    @ResponseBody  //告诉程序，返回的数据是响应体，不是数据，相应的内容就按照返回的东西给
    public String save(){
        System.out.println("user save ...");
        return "{'info':'springmvc'}";
    }

    //设置映射路径为/delete，即外部访问路径
    @RequestMapping("/delete")
    @ResponseBody
    public String delete(){
        System.out.println("user save ...");
        return "{'info':'springmvc'}";
    }
}

注意事项：
对于SpringMVC而言，Controller方法返回值默认表示要跳转的页面，没有对应的页面就会报错。如果不想跳转页面而是响应数据，那么就需要在方法上使用@ResponseBody注解。

【第五步】编写`SpringMVC`配置类，加载处理请求的Bean

package com.itheima.config;

//springmvc配置类，本质上还是一个spring配置类
@Configuration //这是一个配置类
@ComponentScan("com.itheima.controller")  //扫描路径
public class SpringMvcConfig {
}

【第六步】加载`SpringMVC配置`，并设置`SpringMVC请求拦截的路径`

package com.itheima.config;

//web容器配置类
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
    //加载springmvc配置类，产生springmvc容器（本质还是spring容器）
    protected WebApplicationContext createServletApplicationContext() {  //加载springMVC对应的容器对象
        //初始化WebApplicationContext对象
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        //加载指定配置类（使用注册的方式）
        ctx.register(SpringMvcConfig.class);
        return ctx;
    }

    //设置由springmvc控制器处理的请求映射路径
    protected String[] getServletMappings() {  //告诉那些请求归springMVC处理（到底是springMVC处理还是Tomcat处理）
        return new String[]{"/"};//代表所有的请求归springMVC处理；
    }

    //加载spring配置类
    protected WebApplicationContext createRootApplicationContext() { //spring的配置对应的容器对象
        return null;
    }
}

2.3、运行结果

在这里插入图片描述

2.4、案例注解和类解析【理解】

2.4.1、 @Controller注解

名称：@Controller
类型：类注解
位置：SpringMVC控制器类定义上方
作用：设定SpringMVC的核心控制器bean
范例

@Controller
public class UserController {
}

2.4.2、@RequestMapping注解

名称：@RequestMapping
类型：方法注解
位置：SpringMVC控制器方法定义上方
作用：设置当前控制器方法请求访问路径
范例

@RequestMapping("/save")
public void save(){
    System.out.println("user save ...");
}

注意：其实@RequestMapping注解还可以写到类上面，笔记后面会介绍到。

2.4.3、@ResponseBody注解

名称：@ResponseBody
类型：方法注解
位置：SpringMVC控制器方法定义上方
作用：设置当前控制器方法响应内容为当前返回值，无需解析
范例

@RequestMapping("/save")
@ResponseBody
public String save(){
    System.out.println("user save ...");
    return "{'info':'springmvc'}";
}

2.4.4、AbstractDispatcherServletInitializer类【知道即可】

AbstractDispatcherServletInitializer类是SpringMVC提供的快速初始化Web3.0容器的抽象类
AbstractDispatcherServletInitializer提供三个接口方法供用户实现
- createServletApplicationContext()方法，创建Servlet容器时，加载SpringMVC对应的bean并放入WebApplicationContext对象范围中，而WebApplicationContext的作用范围为ServletContext范围，即整个web容器范围。
```
//加载springmvc配置类，产生springmvc容器（本质还是spring容器）
protected WebApplicationContext createServletApplicationContext() {
    AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
    ctx.register(SpringMvcConfig.class);
    return ctx;
}
```
- getServletMappings()方法，设定SpringMVC对应的请求映射路径，设置为/表示拦截所有请求，任意请求都将转入到SpringMVC进行处理。
```
//设置由springmvc控制器处理的请求映射路径
protected String[] getServletMappings() {
    return new String[]{"/"};
}
```
- createRootApplicationContext()方法，如果创建Servlet容器时需要加载非SpringMVC对应的bean，使用当前方法进行，使用方式同createServletApplicationContext()
```
//加载spring配置类
protected WebApplicationContext createRootApplicationContext() {
    return null;
}
```

2.5、入门程序开发总结(1+N)

一次性工作
- 创建工程，设置服务器，加载工程
- 导入坐标
- 创建web容器启动类，加载SpringMVC配置，并设置SpringMVC请求拦截路径
- SpringMVC核心配置类（设置配置类，扫描controller包，加载Controller控制器bean）
多次工作
- 定义处理请求的控制器类
- 定义处理请求的控制器方法，并配置映射路径（@RequestMapping）与返回json数据（@ResponseBody）

3、入门案例工作流程分析【理解】

3.1、启动服务器初始化过程

服务器启动，执行ServletContainersInitConfig类，初始化web容器
执行createServletApplicationContext方法，创建了WebApplicationContext对象
加载SpringMvcConfig配置类
执行@ComponentScan加载对应的bean
加载UserController，每个@RequestMapping的名称对应一个具体的方法
执行getServletMappings方法，定义所有的请求都通过SpringMVC

3.2、单次请求过程

发送请求localhost/save
web容器发现所有请求都经过SpringMVC，将请求交给SpringMVC处理
解析请求路径/save
由/save匹配执行对应的方法save(）
执行save()
检测到有@ResponseBody直接将save()方法的返回值作为响应求体返回给请求方

4、Controller加载控制

代码：springmvc_02_bean_load

问题导入

因为功能不同，如何避免Spring错误的加载到SpringMVC的bean？

4.1、Controller加载控制与业务bean加载控制

SpringMVC相关bean（表现层bean）
Spring控制的bean
1. 业务bean（Service）
2. 功能bean（DataSource等）
SpringMVC相关bean加载控制
1. SpringMVC加载的bean对应的包均在com.itheima.controller包内
Spring相关bean加载控制
1. 方式一：Spring加载的bean设定扫描范围为com.itheima，排除掉controller包内的bean
2. 方式二【常用】：Spring加载的bean设定扫描范围为精准范围，例如service包、dao包等
3. 方式三：不区分Spring与SpringMVC的环境，加载到同一个环境中

4.2、方式一代码实现

名称：@ComponentScan
类型：类注解
范例

package com.itheima.config;

@Configuration
//设置spring配置类加载bean时的过滤规则，当前要求排除掉表现层对应的bean
//excludeFilters属性：设置扫描加载bean时，排除的过滤规则
//type属性：设置排除规则，当前使用按照bean定义时的注解类型进行排除
//classes属性：设置排除的具体注解类，当前设置排除@Controller定义的bean
@ComponentScan(value="com.itheima",
    excludeFilters = @ComponentScan.Filter(
        type = FilterType.ANNOTATION,
        classes = Controller.class
    )
)
public class SpringConfig {
}

属性
1. excludeFilters：排除扫描路径中加载的bean，需要指定类别（type）与具体项（classes）
2. includeFilters：加载指定的bean，需要指定类别（type）与具体项（classes）

4.2、方式二实现

@ComponentScan({"com.itheima.service","com.itheima.dao"})

4.3、Bean的加载格式【简化格式】

package com.itheima.config;

//web容器配置类
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
    //加载springmvc配置类，产生springmvc容器（本质还是spring容器）
    protected WebApplicationContext createServletApplicationContext() {  //加载springMVC对应的容器对象
        //初始化WebApplicationContext对象
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        //加载指定配置类（使用注册的方式）
        ctx.register(SpringMvcConfig.class);
        return ctx;
    }

    //设置由springmvc控制器处理的请求映射路径
    protected String[] getServletMappings() {  //告诉那些请求归springMVC处理（到底是springMVC处理还是Tomcat处理）
        return new String[]{"/"};//代表所有的请求归springMVC处理；
    }

    //加载spring配置类
    protected WebApplicationContext createRootApplicationContext() { //spring的配置对应的容器对象
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();      
        ctx.register(SpringConfig.class);        
        return ctx;  
    }
}

简化格式 【以后常用】

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer{
    //加载springmvc配置类，产生springmvc容器（本质还是spring容器）
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class}
    };
    
    //设置由springmvc控制器处理的请求映射路在
    protected String[] getServletMappings() {//告诉那些请求归springMVC处理（到底是springMVC处理还是Tomcat处理
        return new String[]{"/"};//代表所有的请求归springMVC处理；
    }
    
    //加载spring配置类
    protected Class<?>[] getRootConfigClasses() { //加载spring配置类，spring的配置对应的容器对象
        return new Class[]{SpringConfig.class};
    }
}

5、PostMan 【掌握】【我用的ApiPost】

5.1、PostMan介绍

Postman是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件。
作用：常用于进行接口测试

5.2、PostMan安装

双击资料中的“Postman-win64-8.3.1-Setup.exe”即可自动按照，打开之后需要注册，如果底部有如下链接，可以点击跳过注册

5.3、PostMan的使用

5.3.1、创建WorkSpace工作空间

在这里插入图片描述

5.3.2、发送请求获取json数据

在这里插入图片描述

5.3.3、保存当前请求

在这里插入图片描述

注意：第一次请求需要创建一个新的目录，后面就不需要创建新目录，直接保存到已经创建好的目录即可。

二、请求与响应

1、请求映射路径【重点】

代码：springmvc_03_request_mapping

问题导入

@RequestMapping注解可以写在哪？有什么作用？

1.1、@RequestMapping注解

名称：@RequestMapping
类型：方法注解类注解
位置：SpringMVC控制器方法定义上方
作用：设置当前控制器方法请求访问路径，如果设置在类上统一设置当前控制器方法请求访问路径前缀
范例

package com.itheima.controller;

@Controller
//类上方配置的请求映射与方法上面配置的请求映射连接在一起，形成完整的请求映射路径
@RequestMapping("/user")
public class UserController {
    //请求路径映射
    @RequestMapping("/save")
    @ResponseBody
    public String save(){
        System.out.println("user save ...");
        return "{'module':'user save'}";
    }
    //请求路径映射
    @RequestMapping("/delete")
    @ResponseBody
    public String delete(){
        System.out.println("user delete ...");
        return "{'module':'user delete'}";
    }
}

运行，访问：http://localhost:80/user/save；返回：{'module':'user save'}

2、请求参数

2.1、发送普通类型参数【重点】

代码：springmvc_04_request_param

问题导入

如何解决POST请求中文乱码问题？

2.1.1、请求方式

GET请求
POST请求

2.1.2、GET请求传递普通参数

普通参数：url地址传参，地址参数名与形参变量名相同，定义形参即可接收参数

package com.itheima.controller;

//请求参数
@Controller
public class UserController {
    //普通参数：请求参数与形参名称对应即可完成参数传递
    @RequestMapping("/commonParam")
    @ResponseBody
    public String commonParam(String name ,int age){
        System.out.println("普通参数传递 name ==> "+name);
        System.out.println("普通参数传递 age ==> "+age);
        return "{'module':'common param'}";
    }
}

问题：如果同学们传递的参数是中文试试，你们会发现接收到的参数出现了中文乱码问题。
原因：tomcat 8.5版本之后GET请求就不再出现中文乱码问题，但是我们使用的是tomcat7插件，所以会出现GET请求中文乱码问题。
解决：在pom.xml添加tomcat7插件处配置UTF-8字符集，解决GET请求中文乱码问题。

<build>
    <plugins>
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.1</version>
        <configuration>
          <port>80</port><!--tomcat端口号-->
          <path>/</path> <!--虚拟目录-->
          <uriEncoding>UTF-8</uriEncoding><!--访问路径编解码字符集-->
        </configuration>
      </plugin>
    </plugins>
  </build>

2.1.3、POST请求传递普通参数

普通参数：form表单post请求传参，表单参数名与形参变量名相同，定义形参即可接收参数

package com.itheima.controller;

//请求参数
@Controller
public class UserController {
    //普通参数：请求参数与形参名称对应即可完成参数传递
    @RequestMapping("/commonParam")
    @ResponseBody
    public String commonParam(String name ,int age){
        System.out.println("普通参数传递 name ==> "+name);
        System.out.println("普通参数传递 age ==> "+age);
        return "{'module':'common param'}";
    }
}

问题：我们发现，POST请求传递的参数如果包含中文那么就会出现中文乱码问题，说明我们之前配置的tomcat插件uri路径编解码字符集无法解决POST请求中文乱码问题。那么如何解决呢？

2.1.4、POST请求中文乱码处理

在加载SpringMVC配置的配置类中指定字符过滤器。

package com.itheima.config;

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
    //乱码处理
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        return new Filter[]{filter};
    }
}

2.2、五种类型参数传递

代码：springmvc_04_request_param

问题导入

当请求参数名与形参变量名不同，该如何接收请求参数？

2.2.1、五种类型参数介绍

普通参数
POJO（实体类）类型参数
嵌套POJO（实体类）类型参数
数组类型参数
集合类型参数

2.2.2、普通参数【重点】

普通参数：当请求参数名与形参变量名不同，使用@RequestParam绑定参数关系

package com.itheima.controller;
//请求参数
@Controller
public class UserController {

//普通参数：请求参数名与形参名不同时，使用@RequestParam注解关联请求参数名称与形参名称之间的关系
@RequestMapping("/commonParamDifferentName")
@ResponseBody
public String commonParamDifferentName(@RequestParam("name") String userName , int age){
    System.out.println("普通参数传递 userName ==> "+userName);
    System.out.println("普通参数传递 age ==> "+age);
    return "{'module':'common param different name'}";
}
}

名称：@RequestParam
类型：形参注解
位置：SpringMVC控制器方法形参定义前面
作用：绑定请求参数与处理器方法形参间的关系
参数：
- required：是否为必传参数
- defaultValue：参数默认值

2.2.3、POJO（实体类）参数【重点】

POJO参数：请求参数名与形参对象属性名相同，定义POJO类型形参即可接收参数

public class User {
    private String name;
    private int age;
    //自己添加getter/setter/toString()方法
}

//POJO参数：请求参数与形参对象中的属性对应即可完成参数传递
@RequestMapping("/pojoParam")
@ResponseBody
public String pojoParam(User user){
    System.out.println("pojo参数传递 user ==> "+user);
    return "{'module':'pojo param'}";
}

注意事项：请求参数key的名称要和POJO中属性的名称一致，否则无法封装。

2.2.4、嵌套POJO（实体类）类型参数

POJO对象中包含POJO对象

package com.itheima.domain;

public class User {
    private String name;
    private int age;
    private Address address;
    //自己添加getter/setter/toString()方法
}
public class Address {
    private String province;
    private String city;
    private Address address;
    //自己添加getter/setter/toString()方法
}

嵌套POJO参数：请求参数名与形参对象属性名相同，按照对象层次结构关系即可接收嵌套POJO属性参数

//嵌套POJO参数：嵌套属性按照层次结构设定名称即可完成参数传递
@RequestMapping("/pojoContainPojoParam")
@ResponseBody
public String pojoContainPojoParam(User user){
    System.out.println("pojo嵌套pojo参数传递 user ==> "+user);
    return "{'module':'pojo contain pojo param'}";
}

注意事项：请求参数key的名称要和POJO中属性的名称一致，否则无法封装。

2.2.5、数组类型参数

数组参数：请求参数名与形参对象属性名相同且请求参数为多个，定义数组类型即可接收参数

//数组参数：同名请求参数可以直接映射到对应名称的形参数组对象中
@RequestMapping("/arrayParam")
@ResponseBody
public String arrayParam(String[] likes){
    System.out.println("数组参数传递 likes ==> "+ Arrays.toString(likes));
    return "{'module':'array param'}";
}

2.2.6、集合类型参数

集合保存普通参数：请求参数名与形参集合对象名相同且请求参数为多个，@RequestParam绑定参数关系

//集合参数：同名请求参数可以使用@RequestParam注解映射到对应名称的集合对象中作为数据
@RequestMapping("/listParam")
@ResponseBody
public String listParam(@RequestParam List<String> likes){
    System.out.println("集合参数传递 likes ==> "+ likes);
    return "{'module':'list param'}";
}

2.3、json数据参数传递

代码：springmvc_04_request_param

问题导入

问题：@EnableWebMvc注解和@ResponseBody注解有什么用？

2.3.1、json数据参数介绍

json普通数组（[“”,“”,“”,…]）
json对象（{key:value,key:value,…}）
json对象数组（[{key:value,…},{key:value,…}]）

2.3.2、传递json普通数组

2.3.2.1、代码演示

添加json数据转换相关坐标的依赖

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.0</version>
</dependency>

设置发送json数据（请求body中添加json数据）
开启自动转换json数据的支持

@Configuration
@ComponentScan("com.itheima.controller")
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMvcConfig {
}

注意事项：
@EnableWebMvc注解功能强大，该注解整合了多个功能，此处仅使用其中一部分功能，即json数据进行自动类型转换

在Controller中编写方法接收json参数

//集合参数：json格式
//1.开启json数据格式的自动转换，在配置类中开启@EnableWebMvc
//2.使用@RequestBody注解将外部传递的json数组数据映射到形参的集合对象中作为数据
@RequestMapping("/listParamForJson")
@ResponseBody
public String listParamForJson(@RequestBody List<String> likes){
    System.out.println("list common(json)参数传递 list ==> "+likes);
    return "{'module':'list common for json param'}";
}

2.3.2.2、@EnableWebMvc注解介绍

名称：@EnableWebMvc
类型：配置类注解
位置：SpringMVC配置类定义上方
作用：开启SpringMVC多项辅助功能
范例：

@Configuration
@ComponentScan("com.itheima.controller")
@EnableWebMvc
public class SpringMvcConfig {
}

2.3.2.3、@RequestBody注解介绍

名称：@RequestBody
类型：形参注解
位置：SpringMVC控制器方法形参定义前面
作用：将请求中请求体所包含的数据传递给请求参数，此注解一个处理器方法只能使用一次
范例：

@RequestMapping("/listParamForJson")
@ResponseBody
public String listParamForJson(@RequestBody List<String> likes){
    System.out.println("list common(json)参数传递 list ==> "+likes);
    return "{'module':'list common for json param'}";
}

2.3.3、传递json对象

先定义User对象

POJO（实体类）参数：json数据与形参对象属性名相同，定义POJO类型形参即可接收参数

//POJO参数：json格式
//1.开启json数据格式的自动转换，在配置类中开启@EnableWebMvc
//2.使用@RequestBody注解将外部传递的json数据映射到形参的实体类对象中，要求属性名称一一对应
@RequestMapping("/pojoParamForJson")
@ResponseBody
public String pojoParamForJson(@RequestBody User user){
    System.out.println("pojo(json)参数传递 user ==> "+user);
    return "{'module':'pojo for json param'}";
}

2.3.4、传递json对象数组

POJO集合参数：json数组数据与集合泛型属性名相同，定义List类型形参即可接收参数

//集合参数：json格式
//1.开启json数据格式的自动转换，在配置类中开启@EnableWebMvc
//2.使用@RequestBody注解将外部传递的json数组数据映射到形参的保存实体类对象的集合对象中，要求属性名称一一对应
@RequestMapping("/listPojoParamForJson")
@ResponseBody
public String listPojoParamForJson(@RequestBody List<User> list){
    System.out.println("list pojo(json)参数传递 list ==> "+list);
    return "{'module':'list pojo for json param'}";
}

2.3.5、@RequestBody与@RequestParam区别

区别
@RequestParam用于接收url地址传参，表单传参【application/x-www-form-urlencoded】
@RequestBody用于接收json数据【application/json】
应用
后期开发中，发送json格式数据为主，@RequestBody应用较广
如果发送非json格式数据，选用@RequestParam接收请求参数

3、日期类型参数传递【重点】

代码：springmvc_04_request_param

问题导入

@DateTimeFormat注解的作用是什么？

3.1、代码演示

日期类型数据基于系统不同格式也不尽相同
2088/08/18
2088-08-18
2088/08/28 8:08:08
接收形参时，根据不同的日期格式设置不同的接收方式

//日期参数 http://localhost:80/dataParam?date=2088/08/08&date1=2088-08-18&date2=2088/08/28 8:08:08
//使用@DateTimeFormat注解设置日期类型数据格式，默认格式yyyy/MM/dd
@RequestMapping("/dataParam")
@ResponseBody
public String dataParam(Date date,
                  @DateTimeFormat(pattern="yyyy-MM-dd") Date date1,
                  @DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss") Date date2){
    System.out.println("参数传递 date ==> "+date);
    System.out.println("参数传递 date1(yyyy-MM-dd) ==> "+date1);
    System.out.println("参数传递 date2(yyyy/MM/dd HH:mm:ss) ==> "+date2);
    return "{'module':'data param'}";
}

3.2、@DateTimeFormat注解介绍

名称：@DateTimeFormat
类型：形参注解
位置：SpringMVC控制器方法形参前面
作用：设定日期时间型数据格式
属性：pattern：指定日期时间格式字符串

3.3、工作原理

其内部依赖Converter接口

public interface Converter<S, T> {
    @Nullable
    T convert(S var1);
}

请求参数年龄数据（String→Integer）
json数据转对象（json → POJO）
日期格式转换（String → Date）

3.4、注意事项

传递日期类型参数必须在配置类上使用@EnableWebMvc注解。其功能之一：根据类型匹配对应的类型转换器。

4、响应

代码：springmvc_05_request_param

问题导入

如何响应json数据？

4.1、响应页面【了解】

@Controller
public class UserController {

    //响应页面/跳转页面
    //返回值为String类型，设置返回值为页面名称，即可实现页面跳转
    @RequestMapping("/toJumpPage")
    public String toJumpPage(){
        System.out.println("跳转页面");
        return "page.jsp";
    }
}

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
    <head>
        <title>Title</title>
    </head>
    <body>
        <h2>Hello Spring MVC!</h2>
    </body>
</html>

4.2、文本数据【了解】

//响应文本数据
//返回值为String类型，设置返回值为任意字符串信息，即可实现返回指定字符串信息，需要依赖@ResponseBody注解
@RequestMapping("/toText")
@ResponseBody
public String toText(){
    System.out.println("返回纯文本数据");
    return "response text";
}

4.3、响应json数据【重点】

响应POJO对象

//响应POJO对象
//返回值为实体类对象，设置返回值为实体类类型，即可实现返回对应对象的json数据，需要依赖@ResponseBody注解和@EnableWebMvc注解
@RequestMapping("/toJsonPOJO")
@ResponseBody
public User toJsonPOJO(){
    System.out.println("返回json对象数据");
    User user = new User();
    user.setName("itcast");
    user.setAge(15);
    return user;
}

响应POJO集合对象

//响应POJO集合对象
//返回值为集合对象，设置返回值为集合类型，即可实现返回对应集合的json数组数据，需要依赖@ResponseBody注解和@EnableWebMvc注解
@RequestMapping("/toJsonList")
@ResponseBody
public List<User> toJsonList(){
    System.out.println("返回json集合数据");
    User user1 = new User();
    user1.setName("传智播客");
    user1.setAge(15);

    User user2 = new User();
    user2.setName("黑马程序员");
    user2.setAge(12);

    List<User> userList = new ArrayList<User>();
    userList.add(user1);
    userList.add(user2);

    return userList;
}

注意：需要添加jackson-databind依赖以及在SpringMvcConfig配置类上添加@EnableWebMvc注解

    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.9.0</version>
    </dependency>

在这里插入图片描述

三、REST风格

1 REST简介

问题导入

Rest风格使用了几种请求方式定义访问行为？

1.1、REST介绍

访问网络资源的形式

REST（Representational State Transfer），表现形式状态转换
- 传统风格资源描述形式
  http://localhost/user/getById?id=1
  http://localhost/user/saveUser
- REST风格描述形式
  http://localhost/user/1
  http://localhost/user
优点：
- 隐藏资源的访问行为，无法通过地址得知对资源是何种操作
- 书写简化

1.2、RESTful介绍

按照REST风格访问资源时使用行为动作区分对资源进行了何种操作
http://localhost/users 查询全部用户信息——GET（查询）
http://localhost/users/1 查询指定用户信息——GET（查询）
http://localhost/users 添加用户信息——POST（新增/保存）
http://localhost/users 修改用户信息——PUT（修改/更新）
http://localhost/users/1 删除用户信息——DELETE（删除）
根据REST风格对资源进行访问称为RESTful

注意事项

上述行为是约定方式，约定不是规范，可以打破，所以称REST风格，而不是REST规范
描述模块的名称通常使用复数，也就是加s的格式描述，表示此类资源，而非单个资源，例如：users、books、accounts……

2、RESTful入门案例

代码：springmvc_06_rest

问题导入

Rest风格如何通过路径传递参数？

2.1、RESTful快速入门

做法：在Controller中定义方法时设定"http请求动作(请求方式)“和"设定请求参数（路径变量）”

package com.itheima.controller;

@Controller
public class UserController {

    //设置当前请求方法为POST，表示REST风格中的添加操作
    @RequestMapping(value = "/users",method = RequestMethod.POST)
    @ResponseBody
    public String save(){
        System.out.println("user save...");
        return "{'module':'user save'}";
    }

    //设置当前请求方法为DELETE，表示REST风格中的删除操作
    //@PathVariable注解用于设置路径变量（路径参数），要求路径上设置对应的占位符，并且占位符名称与方法形参名称相同
    @RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id){
        System.out.println("user delete..." + id);
        return "{'module':'user delete'}";
    }

    //设置当前请求方法为PUT，表示REST风格中的修改操作
    @RequestMapping(value = "/users",method = RequestMethod.PUT)
    @ResponseBody
    public String update(@RequestBody User user){
        System.out.println("user update..."+user);
        return "{'module':'user update'}";
    }

    //设置当前请求方法为GET，表示REST风格中的查询操作
    //@PathVariable注解用于设置路径变量（路径参数），要求路径上设置对应的占位符，并且占位符名称与方法形参名称相同
    @RequestMapping(value = "/users/{id}" ,method = RequestMethod.GET)
    @ResponseBody
    public String getById(@PathVariable Integer id){
        System.out.println("user getById..."+id);
        return "{'module':'user getById'}";
    }

    //设置当前请求方法为GET，表示REST风格中的查询操作
    @RequestMapping(value = "/users",method = RequestMethod.GET)
    @ResponseBody
    public String getAll(){
        System.out.println("user getAll...");
        return "{'module':'user getAll'}";
    }
}

2.2 @PathVariable介绍

名称：@PathVariable
类型：形参注解
位置：SpringMVC控制器方法形参定义前面
作用：绑定路径参数与处理器方法形参间的关系，要求路径参数名与形参名一一对应

2.3、@RequestBody、@RequestParam、@PathVariable区别和应用

区别
@RequestParam用于接收url地址传参或表单传参
@RequestBody用于接收json数据
@PathVariable用于接收路径参数，使用{参数名称}描述路径参数
应用
后期开发中，发送请求参数超过1个时，以json格式为主，@RequestBody应用较广
如果发送非json格式数据，选用@RequestParam接收请求参数
采用RESTful进行开发，当参数数量较少时，例如1个，可以采用@PathVariable接收请求路径变量，通常用于传递id值

3、REST快速开发【重点】

代码：springmvc_06_rest

3.1、代码中的问题

在这里插入图片描述

以上截图中的代码和我们之前写的UserController中的方法类似，其中图中两个方法都有三处是有问题的，可以进行优化。存在的问题如下：

问题1：每个方法的@RequestMapping注解中都定义了访问路径/books，重复性太高。
问题2：每个方法的@RequestMapping注解中都要使用method属性定义请求方式，重复性太高。
问题3：每个方法响应json都需要加上@ResponseBody注解，重复性太高。

3.2、Rest快速开发【重点】【取代2.1】

解决以上三个问题

解决问题1：在Controller类上使用@RequestMapping定义共同的访问路径。

@Controller
@RequestMapping("/books")
public class BookController {
    
    @RequestMapping(method = RequestMethod.POST)
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }
    @RequestMapping(value = "/{id}" ,method = RequestMethod.DELETE)
    public String delete(@PathVariable Integer id){
        System.out.println("book delete..." + id);
        return "{'module':'book delete'}";
    }
    @RequestMapping(method = RequestMethod.PUT)
    public String update(@RequestBody Book book){
        System.out.println("book update..."+book);
        return "{'module':'book update'}";
    }
    @RequestMapping(value = "/{id}" ,method = RequestMethod.GET)
    public String getById(@PathVariable Integer id){
        System.out.println("book getById..."+id);
        return "{'module':'book getById'}";
    }

    @RequestMapping(method = RequestMethod.GET)
    public String getAll(){
        System.out.println("book getAll...");
        return "{'module':'book getAll'}";
    }
}

解决问题2：使用@GetMapping @PostMapping @PutMapping @DeleteMapping代替@RequestMapping(method=RequestMethod.XXX)

@Controller   
@RequestMapping("/books")
public class BookController {

//    @RequestMapping( method = RequestMethod.POST)
    @PostMapping//使用@PostMapping简化Post请求方法对应的映射配置
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }

//    @RequestMapping(value = "/{id}" ,method = RequestMethod.DELETE)
    @DeleteMapping("/{id}")  //使用@DeleteMapping简化DELETE请求方法对应的映射配置
    public String delete(@PathVariable Integer id){
        System.out.println("book delete..." + id);
        return "{'module':'book delete'}";
    }

//    @RequestMapping(method = RequestMethod.PUT)
    @PutMapping   //使用@PutMapping简化Put请求方法对应的映射配置
    public String update(@RequestBody Book book){
        System.out.println("book update..."+book);
        return "{'module':'book update'}";
    }

//    @RequestMapping(value = "/{id}" ,method = RequestMethod.GET)
    @GetMapping("/{id}")    //使用@GetMapping简化GET请求方法对应的映射配置
    public String getById(@PathVariable Integer id){
        System.out.println("book getById..."+id);
        return "{'module':'book getById'}";
    }

//    @RequestMapping(method = RequestMethod.GET)
    @GetMapping      //使用@GetMapping简化GET请求方法对应的映射配置
    public String getAll(){
        System.out.println("book getAll...");
        return "{'module':'book getAll'}";
    }
}

名称：@GetMapping @PostMapping @PutMapping @DeleteMapping
类型：方法注解
位置：基于SpringMVC的RESTful开发控制器方法定义上方
作用：设置当前控制器方法请求访问路径与请求动作，每种对应一个请求动作，例如@GetMapping对应GET请求
属性：
value（默认）：请求访问路径

解决问题3：在Controller类上使用@RestController注解，等同于@Controller与@ResponseBody两个注解组合功能

@RestController     //使用@RestController注解替换@Controller与@ResponseBody注解，简化书写
@RequestMapping("/books")
public class BookController {
    //方法省略了没写
}

名称：@RestController
类型：类注解
位置：基于SpringMVC的RESTful开发控制器类定义上方
作用：设置当前控制器类为RESTful风格，等同于@Controller与@ResponseBody两个注解组合功能

在这里插入图片描述

4、案例：基于RESTful页面数据交互

代码：springmvc_07_rest_case

4.1、案例效果和环境准备

4.1.1、案例效果

在这里插入图片描述

4.1.2、环境准备

//POJO实体类
public class Book {
    private Integer id;
    private String type;
    private String name;
    private String description;
    //自己重写getter、setter、toString()方法...
}

//SpringMVC容器初始化类
public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }

    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }

    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
    //乱码处理
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        return new Filter[]{filter};
    }
}

//SpringMVC配置类
@Configuration
@ComponentScan({"com.itheima.controller","com.itheima.config"})
@EnableWebMvc
public class SpringMvcConfig {
}

4.2、代码实现

4.2.1、制作SpringMVC控制器，并通过ApiPost测试接口功能

package com.itheima.controller;

@RestController
@RequestMapping("/books")
public class BookController {

    @PostMapping
    public String save(@RequestBody Book book){
        System.out.println("book save ==> "+ book);
        return "{'module':'book save success'}";
    }

    @GetMapping
    public List<Book> getAll(){
        System.out.println("book getAll is running ...");
        
        List<Book> bookList = new ArrayList<Book>();

        Book book1 = new Book();
        book1.setType("计算机");
        book1.setName("SpringMVC入门教程");
        book1.setDescription("小试牛刀");
        bookList.add(book1);

        Book book2 = new Book();
        book2.setType("计算机");
        book2.setName("SpringMVC实战教程");
        book2.setDescription("一代宗师");
        bookList.add(book2);

        Book book3 = new Book();
        book3.setType("计算机丛书");
        book3.setName("SpringMVC实战教程进阶");
        book3.setDescription("一代宗师呕心创作");
        bookList.add(book3);

        return bookList;
    }
}

在这里插入图片描述

4.2.2、设置对静态资源的访问 `放行`【重要】

放行非SpringMVC的请求

package com.itheima.config;

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    //设置静态资源访问过滤，当前类需要设置为配置类，并被扫描加载
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        //当访问/pages/????时候，从/pages目录下查找内容
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
        registry.addResourceHandler("/js/**").addResourceLocations("/js/");
        registry.addResourceHandler("/css/**").addResourceLocations("/css/");
        registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
    }
}

4.2.3、前端页面通过异步提交访问后台控制器

//添加
saveBook () {
    axios.post("/books",this.formData).then((res)=>{

    });
},
//主页列表查询
getAll() {
    axios.get("/books").then((res)=>{
        this.dataList = res.data;
    });
},