SpringMVC是隶属于Spring框架的一部分，主要是用来进行Web开发，是对Servlet进行了封装。

SpringMVC是处于Web层的框架，所以其主要作用就是用来接收前段发过来的请求和数据，然后经过处理之后将处理结果响应给前端，所以如何处理情趣和响应是SpringMVC中非常重要的一块内容。

REST是一种软件架构风格，可以降低开发的复杂性，提高系统的可伸缩性，后期的应用也是非常广泛。

对于SpringMVC的学习，最终要达成的目标：

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

SpringMVC概述

学习SpringMVC我们先来回顾下现在Web程序是如何做的，我们现在的Web程序大都基于MVC三层架构来实现的。

• 如果所有的处理都交给Servlet来处理的话，所有的东西都耦合在一起，对后期的维护和扩展极其不利
  • 所以将后端服务器Servlet拆分成三层，分别是web、service和dao
  • web层主要由servlet来处理，负责页面请求和数据的收集以及响应结果给前端
  • service层主要负责业务逻辑的处理
  • dao层主要负责数据的增删改查操作
• 但servlet处理请求和数据时，存在一个问题：一个servlet只能处理一个请求
• 针对web层进行优化，采用MVC设计模式，将其设计为Controller、View和Model
  • controller负责请求和数据的接收，接收后将其转发给service进行业务处理
  • service根据需要会调用dao对数据进行增删改查
  • dao把数据处理完后，将结果交给service，service再交给controller
  • controller根据需求组装成Model和View，Model和View组合起来生成页面，转发给前端浏览器
  • 这样做的好处就是controller可以处理多个请求，并对请求进行分发，执行不同的业务操作
    随着互联网的发展，上面的模式因为是同步调用，性能慢慢的跟不上需求，所以异步调用慢慢的走到了前台，是现在比较流行的一种处理方式。
    
• 因为是异步调用，所以后端不需要返回View视图，将其去除
• 前端如果通过异步调用的方式进行交互，后端就需要将返回的数据转换成JSON格式进行返回
• SpringMVC主要负责的就是
  • controller如何接收请求和数据
  • 如何将请求和数据转发给业务层
  • 如何将响应数据转换成JSON发挥到前端
• SpringMVC是一种基于Java实现MVC模型的轻量级Web框架
• 优点
• 使用简单、开发快捷（相比较于Servlet）
• 灵活性强

SpringMVC入门案例

因为SpringMVC是一个Web框架，将来是要替换Servlet,所以先来回顾下以前Servlet是如何进行开发的?

1. 创建web工程(Maven结构)

2. 设置tomcat服务器，加载web工程(tomcat插件)

3. 导入坐标(Servlet)

4. 定义处理请求的功能类(UserServlet)

5. 设置请求映射(配置映射关系)
   SpringMVC的制作过程和上述流程几乎是一致的，具体的实现流程是什么?

6. 创建web工程(Maven结构)

7. 设置tomcat服务器，加载web工程(tomcat插件)

8. 导入坐标(SpringMVC+Servlet)

9. 定义处理请求的功能类(UserController)

10. 设置请求映射(配置映射关系)

11. 将SpringMVC设定加载到Tomcat容器中

案例制作

• 步骤一：创建Maven项目

• 导入所需坐标(SpringMVC+Servlet)

  1 2 3 4 5 6 7 8 9 10 11 12 13

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

• 步骤三：创建SpringMVC控制器类（等同于我们前面做的Servlet）

  1 2 3 4 5 6 7 8 9 10 11 12

  //定义Controller，使用@Controller定义Bean @Controller public class UserController { //设置当前访问路径，使用@RequestMapping @RequestMapping("/save") //设置当前对象的返回值类型 @ResponseBody public String save(){ System.out.println("user save ..."); return "{'module':'SpringMVC'}"; } }

• 步骤四：初始化SpringMVC环境（同Spring环境），设定SpringMVC加载对应的Bean

  1 2 3 4 5 6 7

  //创建SpringMVC的配置文件，加载controller对应的bean @Configuration // @ComponentScan("com.blog.controller") public class SpringMvcConfig { }

• 步骤五：初始化Servlet容器，加载SpringMVC环境，并设置SpringMVC技术处理的请求

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

  //定义一个servlet容器的配置类，在里面加载Spring的配置，继承AbstractDispatcherServletInitializer并重写其方法 public class ServletContainerInitConfig extends AbstractDispatcherServletInitializer { //加载SpringMvc容器配置 protected WebApplicationContext createServletApplicationContext() { AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext(); context.register(SpringMvcConfig.class); return context; } //设置哪些请求归SpringMvc处理 protected String[] getServletMappings() { //所有请求都交由SpringMVC处理 return new String[]{"/"}; } //加载Spring容器配置 protected WebApplicationContext createRootApplicationContext() { return null; } }

• 步骤六：访问http://localhost:8080/save
  页面上成功出现{‘info’:’springmvc’}，至此我们的SpringMVC入门案例就完成了

知识点1：@Controller

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

知识点2：@RequestMapping

名称 @RequestMapping
类型 类注解或方法注解
位置 SpringMVC控制器类或方法定义上方
作用 设置当前控制器方法请求访问路径
相关属性 value(默认)，请求访问路径

知识点3：@ResponseBody

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

入门案例小结

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

工作流程解析

这里将SpringMVC分为两个阶段来分析，分别是启动服务器初始化过程和单次请求过程

启动服务器初始化过程

1. 服务器启动，执行ServletContainerInitConfig类，初始化web容器

• 功能类似于web.xml

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

  public class ServletContainerInitConfig extends AbstractDispatcherServletInitializer { protected WebApplicationContext createServletApplicationContext() { AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext(); context.register(SpringMvcConfig.class); return context; } protected String[] getServletMappings() { return new String[]{"/"}; } protected WebApplicationContext createRootApplicationContext() { return null; } }

2. 执行createServletApplicationContext方法，创建了WebApplicationContext对象

• 该方法加载SpringMVC的配置类SpringMvcConfig来初始化SpringMVC的容器

  1 2 3 4 5

  protected WebApplicationContext createServletApplicationContext() { AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext(); context.register(SpringMvcConfig.class); return context; }

3. 加载SpringMvcConfig配置类

   1 2 3 4 5

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

4. 执行@ComponentScan加载对应的bean

• 扫描指定包及其子包下所有类上的注解，如Controller类上的@Controller注解

5. 加载UserController，每个@RequestMapping的名称对应一个具体的方法

• 此时就建立了 /save 和 save()方法的对应关系

  1 2 3 4 5 6 7 8 9

  @Controller public class UserController { @RequestMapping("/save") @ResponseBody public String save(){ System.out.println("user save ..."); return "{'module':'SpringMVC'}"; } }

6. 执行getServletMappingsS方法，设定SpringMVC拦截请求的路径规则

• /代表所拦截请求的路径规则，只有被拦截后才能交给SpringMVC来处理请求

  1 2 3

  protected String[] getServletMappings() { return new String[]{"/"}; }

单次请求过程

1. 发送请求http://localhost:8080/save
2. web容器发现该请求满足SpringMVC拦截规则，将请求交给SpringMVC处理
3. 解析请求路径/save
4. 由/save匹配执行对应的方法save()
5. 上面的第5步已经将请求路径和方法建立了对应关系，通过/save就能找到对应的save()方法
6. 执行save()
7. 检测到有@ResponseBody直接将save()方法的返回值作为响应体返回给请求方

Bean加载控制

问题分析

入门案例的内容已经做完了，在入门案例中我们创建过一个SpringMvcConfig的配置类，在之前学习Spring的时候也创建过一个配置类SpringConfig。这两个配置类都需要加载资源，那么它们分别都需要加载哪些内容?
我们先来回顾一下项目结构

• com.blog下有config、controller、service、dao这四个包
  • config目录存入的是配置类，写过的配置类有:
  • ServletContainersInitConfig
  • SpringConfig
  • SpringMvcConfig
  • JdbcConfig
  • MybatisConfig
  • controller目录存放的是SpringMVC的controller类
  • service目录存放的是service接口和实现类
  • dao目录存放的是dao/Mapper接口 controller、service和dao这些类都需要被容器管理成bean对象，那么到底是该让SpringMVC加载还是让Spring加载呢?
• SpringMVC控制的bean
  • 表现层bean,也就是controller包下的类
• Spring控制的bean
  • 业务bean(Service)
  • 功能bean(DataSource等)
    分析清楚谁该管哪些bean以后，接下来要解决的问题是如何让Spring和SpringMVC分开加载各自的内容。

思路分析

对于上面的问题，解决方案也比较简单

• 加载Spring控制的bean的时候，排除掉SpringMVC控制的bean
  那么具体该如何实现呢？
• 方式一：Spring加载的bean设定扫描范围com.blog，排除掉controller包内的bean
• 方式二：Spring加载的bean设定扫描范围为精确扫描，具体到service包，dao包等
• 方式三：不区分Spring与SpringMVC的环境，加载到同一个环境中(了解即可)

环境准备

在入门案例的基础上追加一些类来完成环境准备

• 导入坐标

  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

  <dependency> <groupId>com.alibaba</groupId> <artifactId>druid</artifactId> <version>1.1.16</version> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.5.6</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.46</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-jdbc</artifactId> <version>5.2.10.RELEASE</version> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> <version>1.3.0</version> </dependency>

• com.blog.config下新建SpringConfig类

  1 2 3 4

  @Configuration @ComponentScan("com.blog") public class SpringConfig { }

• 创建一张数据表

  1 2 3 4 5

  create table tb_user( id int primary key auto_increment, name varchar(25), age int )

• 新建com.blog.service，com.blog.dao，com.blog.domain包，并编写如下几个类

  UserUserDaoUserServiceUserServiceImpl

  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

  public class User { private Integer id; private String name; private Integer age; public User() { } public User(Integer id, String name, Integer age) { this.id = id; this.name = name; this.age = age; } public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } @Override public String toString() { return "User{" + "id=" + id + ", name='" + name + '\'' + ", age=" + age + '}'; } }

  1 2 3 4

  public interface UserDao { @Insert("insert into tb_user(`name`,age) values (#{name},#{age})") public void save(User user); }

  1 2 3

  public interface UserService { void save(User user); }

  1 2 3 4 5

  public class UserServiceImpl implements UserService { public void save(User user) { System.out.println("user service ..."); } }

• 编写App运行类

  1 2 3 4 5 6

  public class App { public static void main(String[] args) { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class); System.out.println(context.getBean(UserController.class)); } }

设置bean加载控制

• 运行App运行类，如果Spring配置类扫描到了UserController类，则会正常输出，否则将报错
  当前配置环境下，将正常输出

com.blog.controller.UserController@8e0379d

• 解决方案一：修改Spring配置类，设定扫描范围为精准范围

  1 2 3 4

  @Configuration @ComponentScan({"com.blog.dao","com.blog.service"}) public class SpringConfig { }

  再次运行App运行类，报错NoSuchBeanDefinitionException，说明Spring配置类没有扫描到UserController，目的达成

• 解决方案二：修改Spring配置类，设定扫描范围为com.blog，排除掉controller包中的bean

  1 2 3 4 5 6 7 8

  @Configuration @ComponentScan(value = "com.blog", excludeFilters = @ComponentScan.Filter( type = FilterType.ANNOTATION, classes = Controller.class )) public class SpringConfig { }

• excludeFilters属性：设置扫描加载bean时，排除的过滤规则

• type属性：设置排除规则，当前使用按照bean定义时的注解类型进行排除

  • ANNOTATION：按照注解排除
  • ASSIGNABLE_TYPE:按照指定的类型过滤
  • ASPECTJ:按照Aspectj表达式排除，基本上不会用
  • REGEX:按照正则表达式排除
  • CUSTOM:按照自定义规则排除

• classes属性：设置排除的具体注解类，当前设置排除@Controller定义的bean

运行程序之前，我们还需要把SpringMvcConfig配置类上的@ComponentScan注解注释掉，否则不会报错，将正常输出

• 出现问题的原因是
  • Spring配置类扫描的包是com.blog
  • SpringMVC的配置类，SpringMvcConfig上有一个@Configuration注解，也会被Spring扫描到
  • SpringMvcConfig上又有一个@ComponentScan，把controller类又给扫描进来了
  • 所以如果不把@ComponentScan注释掉，Spring配置类将Controller排除，但是因为扫描到SpringMVC的配置类，又将其加载回来，演示的效果就出不来
  • 解决方案，也简单，把SpringMVC的配置类移出Spring配置类的扫描范围即可。
    运行程序，同样报错NoSuchBeanDefinitionException，目的达成

最后一个问题，有了Spring的配置类，要想在tomcat服务器启动将其加载，我们需要修改ServletContainersInitConfig

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

public class ServletContainerInitConfig extends AbstractDispatcherServletInitializer {
    //加载SpringMvc配置
    protected WebApplicationContext createServletApplicationContext() {
        AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
        context.register(SpringMvcConfig.class);
        return context;
    }
    //设置哪些请求归SpringMvc处理
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    //加载Spring容器配置
    protected WebApplicationContext createRootApplicationContext() {
        AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
        context.register(SpringConfig.class);
        return context;
    }
}

对于上面的ServletContainerInitConfig配置类，Spring还提供了一种更简单的配置方式，可以不用再去创建AnnotationConfigWebApplicationContext对象，不用手动register对应的配置类
我们改用继承它的子类AbstractAnnotationConfigDispatcherServletInitializer，然后重写三个方法即可

1
2
3
4
5
6
7
8
9
10
11
12
13
14

public class ServletContainerInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {

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

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

    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
}

知识点：@ComponentScan

名称 @ComponentScan
类型 类注解
位置 类定义上方
作用 设置spring配置类扫描路径，用于加载使用注解格式定义的bean
相关属性 excludeFilters:排除扫描路径中加载的bean,需要指定类别(type)和具体项(classes)
includeFilters:加载指定的bean，需要指定类别(type)和具体项(classes)

PostMan工具的使用

官网下载：https://www.postman.com/downloads/

请求与响应

前面我们已经完成了入门案例相关的知识学习，接来了我们就需要针对SpringMVC相关的知识点进行系统的学习。
SpringMVC是web层的框架，主要的作用是接收请求、接收数据、响应结果。
所以这部分是学习SpringMVC的重点内容，这里主要会讲解四部分内容:

• 请求映射路径
• 请求参数
• 日期类型参数传递
• 响应JSON数据

设置请求映射路径

环境准备

• 创建一个Maven项目
• 导入坐标
  这里暂时只导servlet和springmvc的就行

1
2
3
4
5
6
7
8
9
10
11
12
13

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

• 编写UserController和BookController

  UserControllerBookController

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

  @Controller 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'}"; } }

  1 2 3 4 5 6 7 8 9 10

  @Controller public class BookController { @RequestMapping("/save") @ResponseBody public String save(){ System.out.println("book save .."); return "{'module':'book module'}"; } }

• 创建SpringMvcConfig配置类

  1 2 3 4

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

• 创建ServletContainersInitConfig类，初始化web容器

  1 2 3 4 5 6 7 8 9 10 11 12 13

  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[]{"/"}; } }

• 直接启动Tomcat服务器，会报错
  com.blog.controller.UserController#save()
  to { /save}: There is already ‘bookController’ bean method
  com.blog.controller.BookController#save() mapped.

从错误信息可以看出:

• UserController有一个save方法，访问路径为http://localhost/save
• BookController也有一个save方法，访问路径为http://localhost/save
• 当访问http://localhost/save的时候，到底是访问UserController还是BookController?

问题分析

团队多人开发，每人设置不同的请求路径，冲突问题该如何解决?

• 解决思路:为不同模块设置模块名作为请求路径前置
  • 对于Book模块的save,将其访问路径设置http://localhost/book/save
  • 对于User模块的save,将其访问路径设置http://localhost/user/save
    这样在同一个模块中出现命名冲突的情况就比较少了。

设置映射路径

• 修改Controller
  UserControllerBookController

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

  @Controller public class UserController { @RequestMapping("/user/save") @ResponseBody public String save(){ System.out.println("user save .."); return "{'module':'user save'}"; } @RequestMapping("/user/delete") @ResponseBody public String delete(){ System.out.println("user delete .."); return "{'module':'user delete'}"; } }

  1 2 3 4 5 6 7 8 9 10

  @Controller public class BookController { @RequestMapping("/book/save") @ResponseBody public String save(){ System.out.println("book save .."); return "{'module':'book module'}"; } }

问题是解决了，但是每个方法前面都需要进行修改，写起来比较麻烦而且还有很多重复代码，如果/user后期发生变化，所有的方法都需要改，耦合度太高。

• 优化路径配置
  UserControllerBookController

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

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

  1 2 3 4 5 6 7 8 9 10 11

  @Controller @RequestMapping("/book") public class BookController { @RequestMapping("/save") @ResponseBody public String save(){ System.out.println("book save .."); return "{'module':'book module'}"; } }

参数请求

请求路径设置好后，只要确保页面发送请求地址和后台Controller类中配置的路径一致，就可以接收到前端的请求，接收到请求后，如何接收页面传递的参数?

关于请求参数的传递与接收是和请求方式有关系的，目前比较常见的两种请求方式为：

• GET请求
• POST请求

针对于不同的请求前端如何发送，后端如何接收?

环境准备

• 继续使用上面的环境即可，编写两个模型类User类Address类

  UserAddress

  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

  public class User { private String name; private int age; public User() { } public User(String name, int age) { this.name = name; this.age = age; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } @Override public String toString() { return "User{" + "name='" + name + '\'' + ", age=" + age + '}'; } }

  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

  public class Address { private String province; private String city; public String getProvince() { return province; } public void setProvince(String province) { this.province = province; } public String getCity() { return city; } public void setCity(String city) { this.city = city; } public Address() { } public Address(String province, String city) { this.province = province; this.city = city; } @Override public String toString() { return "Address{" + "province='" + province + '\'' + ", city='" + city + '\'' + '}'; } }

• 同时修改一下UserController类

  1 2 3 4 5 6 7 8 9 10 11

  @Controller @RequestMapping("/user") public class UserController { @RequestMapping("/commonParam") @ResponseBody public String commonParam(String name){ System.out.println("普通参数传递name --> " + name); return "{'module':'commonParam'}"; } }

• GET发送单个参数

  • 启动Tomcat服务器，发送请求与参数：http://localhost/commonParam?name=Jerry
  • 接收参数

    1 2 3 4 5 6 7 8 9 10

    @Controller public class UserController { @RequestMapping("/commonParam") @ResponseBody public String commonParam(String name){ System.out.println("普通参数传递name --> " + name); return "{'module':'commonParam'}"; } }

    注意get请求的key需与commonParam中的形参名一致
    控制台输出普通参数传递name –> Jerry

• GET发送多个参数

  • 发送请求与参数：localhost:8080/user/commonParam?name=Jerry&age=18
  • 接收参数

1
2
3
4
5
6
7
8
9
10
11
12

@Controller
@RequestMapping("/user")
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':'commonParam'}";
    }
}

控制台输出

普通参数传递name –> Jerry
普通参数传递age –> 18

接收参数
和GET一致，不用做任何修改

1
2
3
4
5
6
7
8
9
10
11
12

@Controller
@RequestMapping("/user")
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':'commonParam'}";
    }
}

控制台输出如下

普通参数传递name –> Tom
普通参数传递age –> 19

• POST请求中文乱码
  如果我们在发送post请求的时候，使用了中文，则会出现乱码
• 解决方案：配置过滤器

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

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

重启Tomcat服务器，并发送post请求，使用中文，控制台输出如下

普通参数传递name –> 张三
普通参数传递age –> 19

五种类型参数传递

前面我们已经能够使用GET或POST来发送请求和数据，所携带的数据都是比较简单的数据，接下来在这个基础上，我们来研究一些比较复杂的参数传递，常见的参数种类有

• 普通类型
• POJO类型参数
• 嵌套POJO类型参数
• 数组类型参数
• 集合类型参数

下面我们就来挨个学习这五种类型参数如何发送，后台如何接收

普通类型

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

• 发送请求与参数：localhost:8080/user/commonParam?name=Helsing&age=1024
• 后台接收参数

1
2
3
4
5
6
7
8
9
10
11
12

@Controller
@RequestMapping("/user")
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':'commonParam'}";
    }
}

• 控制台输出
  普通参数传递name –> Helsing
  普通参数传递age –> 1024

如果形参与地址参数名不一致该如何解决?例如地址参数名为username，而形参变量名为name，因为前端给的是username，后台接收使用的是name,两个名称对不上，会导致接收数据失败

• 解决方案：使用@RequestParam注解
  • 发送请求与参数：localhost:8080/user/commonParam?username=Helsing&age=1024
  • 后台接收参数

1
2
3
4
5
6
7
8
9
10
11
12

@Controller
@RequestMapping("/user")
public class UserController {

    @RequestMapping("/commonParam")
    @ResponseBody
    public String commonParam(@RequestParam("username") String name, int age){
        System.out.println("普通参数传递name --> " + name);
        System.out.println("普通参数传递age --> " + age);
        return "{'module':'commonParam'}";
    }
}

POJO数据类型

简单数据类型一般处理的是参数个数比较少的请求，如果参数比较多，那么后台接收参数的时候就比较复杂，这个时候我们可以考虑使用POJO数据类型。

• POJO参数：请求参数名与形参对象属性名相同，定义POJO类型形参即可接收参数
  此时需要使用前面准备好的两个POJO类

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

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

    public User() {
    }

    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

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

public class Address {
    private String province;
    private String city;

    public String getProvince() {
        return province;
    }

    public void setProvince(String province) {
        this.province = province;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    public Address() {
    }
    
    public Address(String province, String city) {
        this.province = province;
        this.city = city;
    }

    @Override
    public String toString() {
        return "Address{" +
                "province='" + province + '\'' +
                ", city='" + city + '\'' +
                '}';
    }
}public class Address {
    private String province;
    private String city;

    public String getProvince() {
        return province;
    }

    public void setProvince(String province) {
        this.province = province;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    public Address() {
    }
    
    public Address(String province, String city) {
        this.province = province;
        this.city = city;
    }

    @Override
    public String toString() {
        return "Address{" +
                "province='" + province + '\'' +
                ", city='" + city + '\'' +
                '}';
    }
}

• 发送请求和参数：localhost:8080/user/pojoParam?name=Helsing&age=1024
• 后台接收参数

1
2
3
4
5
6
7

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

控制台输出如下
POJO参数传递user –> User{name=‘Helsing’, age=1024}

嵌套POJO类型

• 环境准备
  我们先将之前写的Address类，嵌套在User类中

  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

  public class User { private String name; private int age; private Address address; public Address getAddress() { return address; } public void setAddress(Address address) { this.address = address; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } public User() { } public User(String name, int age, Address address) { this.name = name; this.age = age; this.address = address; } @Override public String toString() { return "User{" + "name='" + name + '\'' + ", age=" + age + ", address=" + address + '}'; } }

• 嵌套POJO参数：请求参数名与形参对象属性名相同，按照对象层次结构关系即可接收嵌套POJO属性参数
• 发送请求和参数：localhost:8080/user/pojoParam?name=Helsing&age=1024&address.province=Beijing&address.city=Beijing
• 后台接收参数

1
2
3
4
5
6

@RequestMapping("/pojoParam")
@ResponseBody
public String pojoParam(User user){
    System.out.println("POJO参数传递user --> " + user);
    return "{'module':'pojo param'}";
}

控制台输出如下
POJO参数传递user –> User{name=‘Helsing’, age=1024, address=Address{province=‘Beijing’, city=‘Beijing’}}

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

集合类型

数组能接收多个值，那么集合是否也可以实现这个功能呢?

• 发送请求和参数：localhost:8080/user/listParam?hobbies=sing&hobbies=jump&hobbies=rap&hobbies=basketball
• 后台接收参数

  1 2 3 4 5 6

  @RequestMapping("/listParam") @ResponseBody public String listParam(List hobbies) { System.out.println("集合参数传递user --> " + hobbies); return "{'module':'list param'}"; }

• 运行程序，报错java.lang.IllegalArgumentException: Cannot generate variable name for non-typed Collection parameter type
  • 错误原因：SpringMVC将List看做是一个POJO对象来处理，将其创建一个对象并准备把前端的数据封装到对象中，但是List是一个接口无法创建对象，所以报错。
  • 解决方案是：使用@RequestParam注解

    1 2 3 4 5 6

    @RequestMapping("/listParam") @ResponseBody public String listParam(@RequestParam List hobbies) { System.out.println("集合参数传递user --> " + hobbies); return "{'module':'list param'}"; }

    控制台输出如下
    集合参数传递user –> [sing, jump, rap, basketball]

知识点：@RequestParam

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

JSON数据传输参数

现在比较流行的开发方式为异步调用。前后台以异步方式进行交换，传输的数据使用的是JSON，所以前端如果发送的是JSON数据，后端该如何接收?

对于JSON数据类型，我们常见的有三种:

• json普通数组（[“value1”,“value2”,“value3”,…]）
• json对象（{key1:value1,key2:value2,…}）
• json对象数组（[{key1:value1,…},{key2:value2,…}]）
  下面我们就来学习以上三种数据类型，前端如何发送，后端如何接收

JSON普通数组

• 步骤一：导入坐标

  1 2 3 4 5

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

• 步骤二：开启SpringMVC注解支持
  使用@EnableWebMvc，在SpringMVC的配置类中开启SpringMVC的注解支持，这里面就包含了将JSON转换成对象的功能。

1
2
3
4
5
6

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

• 步骤三：PostMan发送JSON数据
• 步骤四：后台接收参数，参数前添加@RequestBody
  使用@RequestBody注解将外部传递的json数组数据映射到形参的集合对象中作为数据

1
2
3
4
5
6

@RequestMapping("/jsonArrayParam")
@ResponseBody
public String jsonArrayParam(@RequestBody List<String> hobbies) {
    System.out.println("JSON数组参数传递hobbies --> " + hobbies);
    return "{'module':'json array param'}";
}

控制台输出如下

JSON数组参数传递hobbies –> [唱, 跳, Rap, 篮球]

JSON对象

• 请求和数据的发送:

  1 2 3 4 5 6 7 8

  { "name":"菲茨罗伊", "age":"27", "address":{ "city":"萨尔沃", "province":"外域" } }

• 接收请求和参数

  1 2 3 4 5 6

  @RequestMapping("/jsonPojoParam") @ResponseBody public String jsonPojoParam(@RequestBody User user) { System.out.println("JSON对象参数传递user --> " + user); return "{'module':'json pojo param'}"; }

控制台输出如下

JSON对象参数传递user –> User{name=‘菲茨罗伊’, age=27, address=Address{province=‘外域’, city=‘萨尔沃’}}

JSON对象数组

• 请求和数据的发送：

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

  [ { "name":"菲茨罗伊", "age":"27", "address":{ "city":"萨尔沃", "province":"外域" } }, { "name":"地平线", "age":"136", "address":{ "city":"奥林匹斯", "province":"外域" } } ]

• 接收请求和参数：

  1 2 3 4 5 6

  @RequestMapping("/jsonPojoListParam") @ResponseBody public String jsonPojoListParam(@RequestBody List<User> users) { System.out.println("JSON对象数组参数传递user --> " + users); return "{'module':'json pojo list param'}"; }

  控制台输出如下

JSON对象数组参数传递user –> [User{name=‘菲茨罗伊’, age=27, address=Address{province=‘外域’, city=‘萨尔沃’}}, User{name=‘地平线’, age=136, address=Address{province=‘外域’, city=‘奥林匹斯’}}]

小结

SpringMVC接收JSON数据的实现步骤为:

1. 导入jackson包
2. 开启SpringMVC注解驱动，在配置类上添加@EnableWebMvc注解
3. 使用PostMan发送JSON数据
4. Controller方法的参数前添加@RequestBody注解

知识点1：@EnableWebMvc

名称 @EnableWebMvc
类型 配置类注解
位置 SpringMVC配置类定义上方
作用 开启SpringMVC多项辅助功能
知识点2：@RequestBody

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

@RequestBody与@RequestParam区别

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

日期类型参数传递

日期类型比较特殊，因为对于日期的格式有N多中输入方式，比如

• 2088-08-18
• 2088/08/18
• 08/18/2088
• …

针对这么多日期格式，SpringMVC该如何接收呢？下面我们来开始学习

• 步骤一：编写方法接收日期数据

  1 2 3 4 5 6

  @RequestMapping("/dateParam") @ResponseBody public String dateParam(Date date) { System.out.println("参数传递date --> " + date); return "{'module':'date param'}"; }

• 步骤二：启动Tomcat服务器
• 步骤三：使用PostMan发送请求：localhost:8080/user/dateParam?date=2077/12/21
• 步骤四：查看控制台，输出如下

参数传递date –> Tue Dec 21 00:00:00 CST 2077

• 步骤五：更换日期格式
  为了能更好的看到程序运行的结果，我们在方法中多添加一个日期参数

1
2
3
4
5
6
7

@RequestMapping("/dateParam")
@ResponseBody
public String dateParam(Date date1,Date date2) {
    System.out.println("参数传递date1 --> " + date1);
    System.out.println("参数传递date2 --> " + date2);
    return "{'module':'date param'}";
}

使用PostMan发送请求，携带两个不同的日期格式，localhost:8080/user/dateParam?date1=2077/12/21&date2=1997-02-13
发送请求和数据后，页面会报400，The request sent by the client was syntactically incorrect.
错误的原因是将1997-02-13转换成日期类型的时候失败了，原因是SpringMVC默认支持的字符串转日期的格式为yyyy/MM/dd,而我们现在传递的不符合其默认格式，SpringMVC就无法进行格式转换，所以报错。
解决方案也比较简单，需要使用@DateTimeFormat注解

1
2
3
4
5
6
7

@RequestMapping("/dateParam")
@ResponseBody
public String dateParam(Date date1,@DateTimeFormat(pattern = "yyyy-MM-dd") Date date2) {
    System.out.println("参数传递date1 --> " + date1);
    System.out.println("参数传递date2 --> " + date2);
    return "{'module':'date param'}";
}

重新发送请求与数据，控制台输出如下，问题解决

参数传递date1 –> Tue Dec 21 00:00:00 CST 2077
参数传递date2 –> Thu Feb 13 00:00:00 CST 1997

• 步骤六：携带具体时间的日期
  接下来我们再来发送一个携带具体时间的日期，如localhost:8080/user/dateParam?date1=2077/12/21&date2=1997-02-13&date3=2022/09/09 16:34:07，那么SpringMVC该怎么处理呢？
  继续修改UserController类，添加第三个参数，同时使用@DateTimeFormat来设置日期格式

1
2
3
4
5
6
7
8
9
10

@RequestMapping("/dateParam")
@ResponseBody
public String dateParam(Date date1,
                        @DateTimeFormat(pattern = "yyyy-MM-dd") Date date2,
                        @DateTimeFormat(pattern ="yyyy/MM/dd HH:mm:ss") Date date3) {
    System.out.println("参数传递date1 --> " + date1);
    System.out.println("参数传递date2 --> " + date2);
    System.out.println("参数传递date3 --> " + date3);
    return "{'module':'date param'}";
}

控制台输出如下

参数传递date1 –> Tue Dec 21 00:00:00 CST 2077
参数传递date2 –> Thu Feb 13 00:00:00 CST 1997
参数传递date3 –> Fri Sep 09 16:34:07 CST 2022

知识点：@DateTimeFormat

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

内部实现原理

我们首先先来思考一个问题:

• 前端传递字符串，后端使用日期Date接收
• 前端传递JSON数据，后端使用对象接收
• 前端传递字符串，后端使用Integer接收
• 后台需要的数据类型有很多种
• 在数据的传递过程中存在很多类型的转换

问:谁来做这个类型转换?

答:SpringMVC
问:SpringMVC是如何实现类型转换的?

答:SpringMVC中提供了很多类型转换接口和实现类
在框架中，有一些类型转换接口，其中有:

1. Converter接口
   注意：Converter所属的包为org.springframework.core.convert.converter

1
2
3
4
5
6
7
8
9
10

/**
*    S: the source type
*    T: the target type
*/
@FunctionalInterface
public interface Converter<S, T> {
    @Nullable
    //该方法就是将从页面上接收的数据(S)转换成我们想要的数据类型(T)返回
    T convert(S source);
}

到了源码页面我们按Ctrl + H可以来看看Converter接口的层次结构
这里给我们提供了很多对应Converter接口的实现类，用来实现不同数据类型之间的转换

2. HttpMessageConverter接口
   该接口是实现对象与JSON之间的转换工作
   注意：需要在SpringMVC的配置类把@EnableWebMvc当做标配配置上去，不要省略

响应

SpringMVC接收到请求和数据后，进行一些了的处理，当然这个处理可以是转发给Service，Service层再调用Dao层完成的，不管怎样，处理完以后，都需要将结果告知给用户。

比如:根据用户ID查询用户信息、查询用户列表、新增用户等。

对于响应，主要就包含两部分内容：

• 响应页面
• 响应数据
  • 文本数据
  • json数据

因为异步调用是目前常用的主流方式，所以我们需要更关注的就是如何返回JSON数据，对于其他只需要认识了解即可。

环境准备

• 创建一个Web的Maven项目

• pom.xml添加Spring依赖

  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

  <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.itheima</groupId> <artifactId>springmvc_05_response</artifactId> <version>1.0-SNAPSHOT</version> <packaging>war</packaging> <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> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.0</version> </dependency> </dependencies> <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> </project>

• 创建对应的配置类

  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

  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}; } } @Configuration @ComponentScan("com.itheima.controller") //开启json数据类型自动转换 @EnableWebMvc public class SpringMvcConfig { }

• 编写模型类User

  1 2 3 4 5

  public class User { private String name; private int age; //getter...setter...toString省略 }

• webapp下创建page.jsp

  1 2 3 4 5

  <html> <body> <h2>Hello Spring MVC!</h2> </body> </html>

• 编写UserController

  1 2 3 4 5

  @Controller public class UserController { }

最终创建好的项目结构如下:

响应页面[了解]

步骤1:设置返回页面

1
2
3
4
5
6
7
8
9
10
11
12
13

@Controller
public class UserController {
    
    @RequestMapping("/toJumpPage")
    //注意
    //1.此处不能添加@ResponseBody,如果加了该注入，会直接将page.jsp当字符串返回前端
    //2.方法需要返回String
    public String toJumpPage(){
        System.out.println("跳转页面");
        return "page.jsp";
    }
    
}

步骤2:启动程序测试

此处涉及到页面跳转，所以不适合采用PostMan进行测试，直接打开浏览器，输入

http://localhost/toJumpPage

4.6.3 返回文本数据[了解]

步骤1:设置返回文本内容

1
2
3
4
5
6
7
8
9
10
11
12

@Controller
public class UserController {
    
   	@RequestMapping("/toText")
	//注意此处该注解就不能省略，如果省略了,会把response text当前页面名称去查找，如果没有回报404错误
    @ResponseBody
    public String toText(){
        System.out.println("返回纯文本数据");
        return "response text";
    }
    
}

步骤2:启动程序测试

此处不涉及到页面跳转，因为我们现在发送的是GET请求，可以使用浏览器也可以使用PostMan进行测试，输入地址http://localhost/toText访问

4.6.4 响应JSON数据

响应POJO对象

1
2
3
4
5
6
7
8
9
10
11
12
13
14

@Controller
public class UserController {
    
    @RequestMapping("/toJsonPOJO")
    @ResponseBody
    public User toJsonPOJO(){
        System.out.println("返回json对象数据");
        User user = new User();
        user.setName("itcast");
        user.setAge(15);
        return user;
    }
    
}

返回值为实体类对象，设置返回值为实体类类型，即可实现返回对应对象的json数据，需要依赖==@ResponseBody==注解和==@EnableWebMvc==注解

重新启动服务器，访问http://localhost/toJsonPOJO

响应POJO集合对象

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

@Controller
public class UserController {
    
    @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;
    }
    
}

重新启动服务器，访问http://localhost/toJsonList

知识点1：@ResponseBody

说明:

• 该注解可以写在类上或者方法上
• 写在类上就是该类下的所有方法都有@ReponseBody功能
• 当方法上有@ReponseBody注解后
  • 方法的返回值为字符串，会将其作为文本内容直接响应给前端
  • 方法的返回值为对象，会将对象转换成JSON响应给前端

此处又使用到了类型转换，内部还是通过Converter接口的实现类完成的，所以Converter除了前面所说的功能外，它还可以实现:

• 对象转Json数据(POJO -> json)
• 集合转Json数据(Collection -> json)

5，Rest风格

对于Rest风格，我们需要学习的内容包括:

• REST简介
• REST入门案例
• REST快速开发
• 案例:基于RESTful页面数据交互

5.1 REST简介

• ==REST==（Representational State Transfer），表现形式状态转换,它是一种软件架构==风格==

  当我们想表示一个网络资源的时候，可以使用两种方式:

  • 传统风格资源描述形式
    • http://localhost/user/getById?id=1 查询id为1的用户信息
    • http://localhost/user/saveUser 保存用户信息
  • REST风格描述形式
    • http://localhost/user/1
    • http://localhost/user

传统方式一般是一个请求url对应一种操作，这样做不仅麻烦，也不安全，因为会程序的人读取了你的请求url地址，就大概知道该url实现的是一个什么样的操作。

查看REST风格的描述，你会发现请求地址变的简单了，并且光看请求URL并不是很能猜出来该URL的具体功能

所以REST的优点有:

• 隐藏资源的访问行为，无法通过地址得知对资源是何种操作
• 书写简化

但是我们的问题也随之而来了，一个相同的url地址即可以是新增也可以是修改或者查询，那么到底我们该如何区分该请求到底是什么操作呢?

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

请求的方式比较多，但是比较常用的就4种，分别是GET,POST,PUT,DELETE。

按照不同的请求方式代表不同的操作类型。

• 发送GET请求是用来做查询
• 发送POST请求是用来做新增
• 发送PUT请求是用来做修改
• 发送DELETE请求是用来做删除

但是==注意==:

• 上述行为是约定方式，约定不是规范，可以打破，所以称REST风格，而不是REST规范
  • REST提供了对应的架构方式，按照这种架构设计项目可以降低开发的复杂性，提高系统的可伸缩性
  • REST中规定GET/POST/PUT/DELETE针对的是查询/新增/修改/删除，但是我们如果非要用GET请求做删除，这点在程序上运行是可以实现的
  • 但是如果绝大多数人都遵循这种风格，你写的代码让别人读起来就有点莫名其妙了。
• 描述模块的名称通常使用复数，也就是加s的格式描述，表示此类资源，而非单个资源，例如:users、books、accounts……

清楚了什么是REST风格后，我们后期会经常提到一个概念叫RESTful，那什么又是RESTful呢?

• 根据REST风格对资源进行访问称为==RESTful==。

后期我们在进行开发的过程中，大多是都是遵从REST风格来访问我们的后台服务，所以可以说咱们以后都是基于RESTful来进行开发的。

5.2 RESTful入门案例

5.2.1 环境准备

• 创建一个Web的Maven项目

• pom.xml添加Spring依赖

  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

  <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.itheima</groupId> <artifactId>springmvc_06_rest</artifactId> <version>1.0-SNAPSHOT</version> <packaging>war</packaging> <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> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.0</version> </dependency> </dependencies> <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> </project>

• 创建对应的配置类

  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

  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}; } } @Configuration @ComponentScan("com.itheima.controller") //开启json数据类型自动转换 @EnableWebMvc public class SpringMvcConfig { }

• 编写模型类User和Book

  1 2 3 4 5 6 7 8 9 10 11

  public class User { private String name; private int age; //getter...setter...toString省略 } public class Book { private String name; private double price; //getter...setter...toString省略 }

• 编写UserController和BookController

  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

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

最终创建好的项目结构如下:

5.2.2 思路分析

需求:将之前的增删改查替换成RESTful的开发方式。

1.之前不同的请求有不同的路径,现在要将其修改为统一的请求路径

修改前: 新增: /save ,修改: /update,删除 /delete…

修改后: 增删改查: /users

2.根据GET查询、POST新增、PUT修改、DELETE删除对方法的请求方式进行限定

3.发送请求的过程中如何设置请求参数?

5.2.3 修改RESTful风格

新增

1
2
3
4
5
6
7
8
9
10

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

• 将请求路径更改为/users

  • 访问该方法使用 POST: http://localhost/users

• 使用method属性限定该方法的访问方式为POST

  • 如果发送的不是POST请求，比如发送GET请求，则会报错

    

删除

1
2
3
4
5
6
7
8
9
10

@Controller
public class UserController {
    //设置当前请求方法为DELETE，表示REST风格中的删除操作
	@RequestMapping(value = "/users",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(Integer id) {
        System.out.println("user delete..." + id);
        return "{'module':'user delete'}";
    }
}

• 将请求路径更改为/users
  • 访问该方法使用 DELETE: http://localhost/users

访问成功，但是删除方法没有携带所要删除数据的id,所以针对RESTful的开发，如何携带数据参数?

传递路径参数

前端发送请求的时候使用:http://localhost/users/1,路径中的1就是我们想要传递的参数。

后端获取参数，需要做如下修改:

• 修改@RequestMapping的value属性，将其中修改为/users/{id}，目的是和路径匹配
• 在方法的形参前添加@PathVariable注解

1
2
3
4
5
6
7
8
9
10

@Controller
public class UserController {
    //设置当前请求方法为DELETE，表示REST风格中的删除操作
	@RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id) {
        System.out.println("user delete..." + id);
        return "{'module':'user delete'}";
    }
}

思考如下两个问题:

(1)如果方法形参的名称和路径{}中的值不一致，该怎么办?

(2)如果有多个参数需要传递该如何编写?

前端发送请求的时候使用:http://localhost/users/1/tom,路径中的1和tom就是我们想要传递的两个参数。

后端获取参数，需要做如下修改:

1
2
3
4
5
6
7
8
9
10

@Controller
public class UserController {
    //设置当前请求方法为DELETE，表示REST风格中的删除操作
	@RequestMapping(value = "/users/{id}/{name}",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id,@PathVariable String name) {
        System.out.println("user delete..." + id+","+name);
        return "{'module':'user delete'}";
    }
}

修改

1
2
3
4
5
6
7
8
9
10

@Controller
public class UserController {
    //设置当前请求方法为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'}";
    }
}

• 将请求路径更改为/users

  • 访问该方法使用 PUT: http://localhost/users

• 访问并携带参数:

  

根据ID查询

1
2
3
4
5
6
7
8
9
10

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

将请求路径更改为/users