SpringMVC详细介绍 zh（4）

川长思鸟来 2023-09-24 21:32 71阅读 0赞

# **内容** #

>  *  理解SpringMVC相关概念
>  *  完成SpringMVC的入门案例
>  *  学会使用`PostMan工具发送请求和数据`
>  *  掌握`SpringMVC如何接收请求、数据和响应结果`
>  *  掌握`RESTful风格及其使用`
>  *  完成基于RESTful的案例编写

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

`对于SpringMVC我们主要学习如下内容:`

*  SpringMVC简介
 *  请求与响应
 *  REST风格
 *  SSM整合(注解版)
 *  拦截器

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

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

SSM整合是把咱们所学习的SpringMVC+Spring+Mybatis整合在一起来完成业务开发，是对我们所学习这三个框架的一个综合应用。

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

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

# 1.SpringMVC概述 #

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

## 1)三层架构 ##

### Servlet-同步调用 ###

![在这里插入图片描述][42d8ac0c68e8408eb07e0b487a55ec56.png]

*  `浏览器`发送一个`请求给后端服务器`，后端服务器`现在是使用Servlet来接收请求和数据`
 *  如果`所有的处理都交给Servlet来处理`的话，所有的东西都耦合在一起，对`后期的维护和扩展极为不利`
 *  将后端服务器Servlet拆分成三层，分别是`web`、`service`和`dao`
    
     *  `web层`主要由`servlet来处理`，`负责页面请求和数据的收集以及响应结果`给前端
     *  `service层`主要`负责业务逻辑的处理`
     *  `dao层`主要`负责数据的增删改查操作`
 *  `servlet处理请求和数据`的时候，存在的问题是=一个servlet只能处理一个请求

## 2) MVC设计模式 ##

*  针对web层进行了优化，采用了MVC设计模式，将其设计为`controller`、`view`和`Model`
    
     *  `controller`负责请求和数据的接收，接收后将其转发给service进行`业务处理`
     *  `service`根据需要会`调用dao对数据进行增删改查`
     *  `dao`把数据处理完后将结果交给`service`,service再交给`controller`
     *  `controller`根据需求组`装成Model和View`,Model和View组合起来`生成页面转发给前端浏览器`
     *  这样做的好处就是`controller可以处理多个请求`，`并对请求进行分发`，执行不同的业务操作。

### SpringMVC-异步调用 ###

随着互联网的发展，上面的模式因为是同步调用，性能慢慢的跟不是需求，所以`异步调用`慢慢的走到了前台，是现在比较流行的一种处理方式。

![在这里插入图片描述][50afa705362f4a5fbb2986fbc7cbd2eb.png]

*  因为是`异步调用`，所以后端不需要返回view视图，将其去除
 *  前端如果通过异步调用的方式进行交互，后台就需要将返回的数据转换成json格式进行返回
 *  SpringMVC主要负责的就是
    
     *  `controller如何接收请求和数据`
     *  `如何将请求和数据转发给业务层`
     *  `如何将响应数据转换成json发回到前端`

介绍了这么多，对SpringMVC进行一个定义

*  `SpringMVC`是一种基于`Java实现MVC模型的轻量级Web框架`
 *  优点
    
     *  `使用简单、开发便捷(相比于Servlet)`
     *  `灵活性强`
    
    这里所说的优点，就需要我们在使用的过程中慢慢体会。

# 2.SpringMVC入门案例 #

因为`SpringMVC是一个Web框架，将来是要替换Servlet`

## 1) Servlet开发流程 ##

Servlet是如何进行开发的?

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

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

3.导入`坐标(Servlet)`

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

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

## 2) SpringMVC开发流程 ##

SpringMVC的制作过程和上述流程几乎是一致的，具体的实现流程是什么?

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

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

3.导入坐标(`SpringMVC`\+`Servlet`)

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

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

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

## 3)需求分析 ##

### 步骤1:创建Maven项目 ###

打开IDEA,创建一个新的web项目

![在这里插入图片描述][0cafffa2e55a420191f93d52a40071d0.png]

### 步骤2:补全目录结构 ###

因为使用骨架创建的项目结构不完整，需要手动补全

![在这里插入图片描述][4e1793d8190b4f81aa2f85d29cf0358d.png]

### 步骤3:导入jar包 ###

将pom.xml中多余的内容删除掉，再添加SpringMVC需要的依赖

<?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_01_quickstart</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>
      </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>

**说明:**  
servlet的坐标为什么需要添加`<scope>provided</scope>`?

*  scope是maven中jar包依赖作用范围的描述，
 *  如果不设置默认是`compile`在在编译、运行、测试时均有效
 *  如果运行有效的话就会和`tomcat中的servlet-api包发生冲突，导致启动报错`
 *  `provided代表的是该包只在编译和测试的时候用，运行的时候无效直接使用tomcat中的，就避免冲突`

### 步骤4:创建配置类 ###

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

### 步骤5:创建Controller类 ###

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

### 步骤6:使用配置类替换web.xml ###

将web.xml删除，换成ServletContainersInitConfig

public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
        
        //加载springmvc配置类
        protected WebApplicationContext createServletApplicationContext() {
        
            //初始化WebApplicationContext对象
            AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
            //加载指定配置类
            ctx.register(SpringMvcConfig.class);
            return ctx;
        }
    
        //设置由springmvc控制器处理的请求映射路径
        protected String[] getServletMappings() {
        
            return new String[]{
        "/"};
        }
    
        //加载spring配置类
        protected WebApplicationContext createRootApplicationContext() {
        
            return null;
        }
    }

### 步骤7:配置Tomcat环境 ###

![在这里插入图片描述][93b8ca5a3bc24509ba627dc20244aa4a.png]  
或者运行本地Tomcat  
![在这里插入图片描述][593d2ef799eb4241929369dab7819e2e.png]

### 步骤8:启动运行项目 ###

![在这里插入图片描述][cf2be03432fd419ba02f54ee8c59c9e6.png]

### 步骤9:浏览器访问 ###

浏览器输入`http://localhost/save`进行访问，会报如下错误:

![在这里插入图片描述][e8bcdbafa7364427b1b99133a7a3b205.png]

页面报错的原因是`后台没有指定返回的页面`，目前只需要关注控制台看`user save ...`有没有被执行即可。

### 步骤10:修改Controller返回值解决上述问题 ###

前面我们说过现在主要的是`前端发送异步请求，后台响应json数据`，所以接下来我们把Controller类的save方法进行修改

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

再次重启tomcat服务器，然后重新通过浏览器测试访问,会发现还是会报错，这次的错是404

![在这里插入图片描述][faf2c8e8a714491cbc1ca2ddef51fef4.png]

出错的原因是，如果方法直接返回字符串，springmvc会把字符串当成页面的名称在项目中进行查找返回，**因为不存在对应返回值名称的页面，所以会报404错误，找不到资源。**

而我们其实是想要直接返回的是json数据，具体如何修改呢?

### 步骤11:设置返回数据为json ###

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

再次重启tomcat服务器，然后重新通过浏览器测试访问，就能看到返回的结果数据

![在这里插入图片描述][1fee3a9332704d9aa74fd4e828803c6b.png]

至此SpringMVC的入门案例就已经完成。

**注意事项**

*  `SpringMVC是基于Spring`的，在pom.xml只导入了`spring-webmvc`jar包的原因是它会`自动依赖spring相关坐标`
 *  `AbstractDispatcherServletInitializer`类是`SpringMVC提供的快速初始化Web3.0容器的抽象类`
 *  AbstractDispatcherServletInitializer提供了三个接口方法供用户实现
    
     *  `createServletApplicationContext`方法，`创建Servlet容器时`，`加载SpringMVC对应的bean`并放入`WebApplicationContext`对象范围中，而WebApplicationContext的作用范围为`ServletContext`范围，即整个web容器范围
     *  `getServletMappings`方法，设定`SpringMVC对应的请求映射路径`，即`SpringMVC拦截哪些请求`
     *  `createRootApplicationContext`方法，如果创`建Servlet容器时需要加载非SpringMVC对应的bean`,使用当前方法进行，使用方式和createServletApplicationContext相同。
     *  `createServletApplicationContext`用来加载`SpringMVC环境`
     *  `createRootApplicationContext`用来加载`Spring环境`

### 知识点1：@Controller ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@Controller</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>类注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>SpringMVC控制器类定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td><code>设定SpringMVC的核心控制器bean</code></td> 
  </tr> 
 </tbody> 
</table>

### 知识点2：@RequestMapping ###

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

### 知识点3：@ResponseBody ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@ResponseBody</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>类注解或方法注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>SpringMVC控制器类或方法定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td><code>设置当前控制器方法响应内容为当前返回值，无需解析</code></td> 
  </tr> 
 </tbody> 
</table>

## 4) 入门案例总结 ##

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

## 5) 工作流程解析 ##

为了更好的使用SpringMVC,我们将SpringMVC的使用过程总共分两个阶段来分析，分别是`启动服务器初始化过程`和`单次请求过程`

![在这里插入图片描述][35b36e14ffbd4bd6bf445818257997b6.png]

### (1)启动服务器初始化过程 ###

1.  服务器启动，执行`ServletContainersInitConfig`类，`初始化web容器`
    
     *  功能类似于以前的`web.xml`
2.  执行`createServletApplicationContext`方法，创建了`WebApplicationContext`对象
    
     *  该方法加载SpringMVC的配置类`SpringMvcConfig`来初始化`SpringMVC的容器`
3.  加载SpringMvcConfig配置类

![在这里插入图片描述][f3f73541f4a4426481d4f6493da5d6fc.png]

1.  执行`@ComponentScan`加载对应的bean
    
     *  扫描指定包及其子包下所有类上的注解，如Controller类上的@Controller注解
2.  加载UserController，每个`@RequestMapping`的名称对应一个具体的方法

![在这里插入图片描述][b4c83693c00e4b9ea0c3c2362c90939c.png]

*  此时就建立了 `/save` 和 save方法的对应关系

1.  执行`getServletMappings`方法，`设定SpringMVC拦截请求的路径规则`

![在这里插入图片描述][040cc740ab8f47a9a4345db8299402bf.png]

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

### (2)单次请求过程 ###

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

## 6) bean加载控制 ##

### (1) 问题分析 ###

入门案例的内容已经做完了，在入门案例中我们创建过一个`SpringMvcConfig`的配置类，再回想前面咱们学习Spring的时候也创建过一个配置类`SpringConfig`。这两个配置类都需要加载资源，那么它们分别都需要加载哪些内容?

我们先来看下目前我们的项目目录结构:  
![在这里插入图片描述][771ef6adb02f432b8b62a0fc02c954c4.png]

*  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,SqlSessionFactoryBean,MapperScannerConfigurer等)

分析清楚谁该管哪些bean以后，接下来要`解决的问题是如何让Spring和SpringMVC分开加载各自的内容。`

在SpringMVC的配置类`SpringMvcConfig`中使用注解`@ComponentScan`，我们只需要将其扫描范围设置到`controller`即可，如

![在这里插入图片描述][13a639eca53b41f79dad4b93df99ad7c.png]

在Spring的配置类`SpringConfig`中使用注解`@ComponentScan`,当时扫描的范围中其实是已经包含了controller,如:

![在这里插入图片描述][1eb7518348a84c4ebf5304a8638428b8.png]

从包结构来看的话，Spring已经多把SpringMVC的controller类也给扫描到，所以针对这个问题该如何解决，就是咱们接下来要学习的内容。

概括的描述下咱们现在的问题就是因为功能不同，如何避免Spring错误加载到SpringMVC的bean?

### (2) 思路分析 ###

针对上面的问题，解决方案也比较简单，就是:

*  加载Spring控制的bean的时候排除掉SpringMVC控制的bean

具体该如何排除：

*  `方式一`:Spring加载的bean设定扫描范围为精准范围，例如service包、dao包等
 *  `方式二:`Spring加载的bean设定扫描范围为com.itheima,排除掉controller包中的bean
 *  `方式三`:不区分Spring与SpringMVC的环境，加载到同一个环境中\[了解即可\]

#### 1. 环境准备 ####

*  创建一个Web的Maven项目
 *  pom.xml添加Spring依赖
    
        <?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_02_bean_load</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.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.47</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>
          </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>
 *  创建对应的配置类
    
        public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
              
            protected WebApplicationContext createServletApplicationContext() {
              
                AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
                ctx.register(SpringMvcConfig.class);
                return ctx;
            }
            protected String[] getServletMappings() {
              
                return new String[]{
              "/"};
            }
            protected WebApplicationContext createRootApplicationContext() {
              
              return null;
            }
        }
        
        @Configuration
        @ComponentScan("com.itheima.controller")
        public class SpringMvcConfig {
              
        }
        
        @Configuration
        @ComponentScan("com.itheima")
        public class SpringConfig {
              
        }
 *  编写Controller，Service，Dao，Domain类
    
        @Controller
        public class UserController {
              
        
            @RequestMapping("/save")
            @ResponseBody
            public String save(){
              
                System.out.println("user save ...");
                return "{'info':'springmvc'}";
            }
        }
        
        public interface UserService {
              
            public void save(User user);
        }
        
        @Service
        public class UserServiceImpl implements UserService {
              
            public void save(User user) {
              
                System.out.println("user service ...");
            }
        }
        
        public interface UserDao {
              
            @Insert("insert into tbl_user(name,age)values(#{name},#{age})")
            public void save(User user);
        }
        public class User {
              
            private Integer id;
            private String name;
            private Integer age;
            //setter..getter..toString略
        }

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

#### 2 设置bean加载控制 ####

![9b1e57c1fcec44dda0cf1650b2e8b761.png][]  
方式一:修改Spring配置类，设定扫描范围为精准范围。

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

**说明:**

上述只是通过例子说明可以精确指定让Spring扫描对应的包结构，真正在做开发的时候，因为Dao最终是交给`MapperScannerConfigurer`对象来进行扫描处理的，我们只需要将其扫描到service包即可。

方式二:修改Spring配置类，设定扫描范围为com.itheima,排除掉controller包中的bean

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

*  `excludeFilters属性`：`设置扫描加载bean时，排除的过滤规则`
 *  `type属性`：`设置排除规则，当前使用按照bean定义时的注解类型进行排除`
    
     *  `ANNOTATION`：按照注解排除
     *  `ASSIGNABLE_TYPE`:按照指定的类型过滤
     *  `ASPECTJ:`按照Aspectj表达式排除，基本上不会用
     *  `REGEX`:按照正则表达式排除
     *  `CUSTOM`:按照自定义规则排除
    
    大家只需要知道第一种ANNOTATION即可
 *  `classes属性`：设置排除的具体注解类，当前设置`排除@Controller定义的bean`

如何测试controller类已经被排除掉了?

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

如果被排除了，该方法执行就会报bean未被定义的错误

![在这里插入图片描述][fbced15f5cd84674a42f6fbd83c7d5e4.png]

注意:测试的时候，需要把SpringMvcConfig配置类上的@ComponentScan注解注释掉，否则不会报错

出现问题的原因是，  
![在这里插入图片描述][a304a5d3616a4443be205f98a63312d6.png]

*  Spring配置类扫描的包是`com.itheima`
 *  SpringMVC的配置类，`SpringMvcConfig`上有一个@Configuration注解，也会被Spring扫描到
 *  SpringMvcConfig上又有一个`@ComponentScan`，把controller类又给扫描进来了
 *  所以如果不把`@ComponentScan注释掉`，`Spring配置类将Controller排除，但是因为扫描到SpringMVC的配置类，又将其加载回来`，演示的效果就出不来
 *  解决方案，也简单，`把SpringMVC的配置类移出Spring配置类的扫描范围即可。`

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

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

对于上述的配置方式，Spring还提供了一种更简单的配置方式，可以不用再去创建`AnnotationConfigWebApplicationContext`对象，不用手动`register`对应的配置类，如何实现?

/*
    
    public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
        protected WebApplicationContext createServletApplicationContext() {
            AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
            ctx.register(SpringMvcConfig.class);
            return ctx;
        }
        protected WebApplicationContext createRootApplicationContext() {
            AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
            ctx.register(SpringConfig.class);
            return ctx;
        }
        protected String[] getServletMappings() {
            return new String[]{"/"};
        }
    
    }
    */
    public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
        
    
        protected Class<?>[] getRootConfigClasses() {
        
            return new Class[]{
        SpringConfig.class};
        }
    
        protected Class<?>[] getServletConfigClasses() {
        
            return new Class[]{
        SpringMvcConfig.class};
        }
    
        protected String[] getServletMappings() {
        
            return new String[]{
        "/"};
        }
    }

### 知识点1：@ComponentScan ###

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

# 3.PostMan工具的使用 #

## 1)PostMan简介 ##

代码编写完后，我们要想测试，只需要打开浏览器直接输入地址发送请求即可。发送的是`GET`请求可以`直接使用浏览器`，但是如果要发送的是`POST`请求呢?

如果要求发送的是post请求，我们就得准备页面在页面上准备form表单，测试起来比较麻烦。所以我们就需要借助一些第三方工具，如PostMan.

*  `PostMan`是`一款功能强大的网页调试与发送网页HTTP请求的Chrome插件。`\[
 *  作用：常用于`进行接口测试`
 *  特征
    
     *  简单
     *  实用
     *  美观
     *  大方

## 2) PostMan安装 ##

安装完成后，如果需要注册，可以按照提示`进行注册`，如果底部有跳过测试的链接也可以点击跳过注册

看到如下界面，就说明已经安装成功。

![在这里插入图片描述][1114d43ccc8d46f8ac56b2adf15c9711.png]

## 3) PostMan使用 ##

### 1 创建WorkSpace工作空间 ###

![在这里插入图片描述][816a7fc675024648b63bfd9f98dcfc0d.png]

### 2 发送请求 ###

![在这里插入图片描述][63098ac2664140c1be4a26386cd78e1e.png]

### 3 保存当前请求 ###

![在这里插入图片描述][5cfb9d2bb8af420ea68e0a3c7d01f3da.png]

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

# 4.请求与响应 #

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

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

## 1) 设置请求映射路径 ##

### 1. 环境准备 ###

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

![在这里插入图片描述][2b24e9da60644f5dbbd31a3ccc9e4c60.png]

把环境准备好后，启动Tomcat服务器，后台会报错:

![在这里插入图片描述][9d330790d6824f1d8b7fc67f69e29fe4.png]

从错误信息可以看出:

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

### 2 问题分析 ###

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

解决思路:`为不同模块设置模块名作为请求路径前置`

对于Book模块的save,将其访问路径设置`http://localhost/book/save`

对于User模块的save,将其访问路径设置`http://localhost/user/save`

这样在同一个模块中出现命名冲突的情况就比较少了。

### 3 设置映射路径 ###

#### 步骤1:修改Controller ####

@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 save(){
        
            System.out.println("user delete ...");
            return "{'module':'user delete'}";
        }
    }
    
    @Controller
    public class BookController {
        
    
        @RequestMapping("/book/save")
        @ResponseBody
        public String save(){
        
            System.out.println("book save ...");
            return "{'module':'book save'}";
        }
    }

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

#### 步骤2:优化路径配置 ####

`优化方案:`

@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 save(){
        
            System.out.println("user delete ...");
            return "{'module':'user delete'}";
        }
    }
    
    @Controller
    @RequestMapping("/book")
    public class BookController {
        
    
        @RequestMapping("/save")
        @ResponseBody
        public String save(){
        
            System.out.println("book save ...");
            return "{'module':'book save'}";
        }
    }

**注意:**

*  当类上和方法上都添加了`@RequestMapping`注解，前端发送请求的时候，`要和两个注解的value值相加匹配才能访问到`。
 *  @RequestMapping注解value属性前面加不加`/`都可以

扩展小知识:

对于PostMan如何觉得字小不好看，可以使用`ctrl+=`调大，`ctrl+-`调小。

## 2) 请求参数 ##

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

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

*  GET
 *  POST

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

### 1.环境准备 ###

*  编写模型类，User和Address
    
        public class Address {
              
            private String province;
            private String city;
            //setter...getter...略
        }
        public class User {
              
            private String name;
            private int age;
            //setter...getter...略
        }

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

![在这里插入图片描述][269dd8b0fc1048d8961de4476afdd3b3.png]

### 2.参数传递 ###

发送请求与参数:

http://localhost/commonParam?name=it

![在这里插入图片描述][d06bf174987b473daf42d8c01b95378e.png]

接收参数：

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

#### GET发送多个参数 ####

发送请求与参数:

http://localhost/commonParam?name=itcast&age=15

![在这里插入图片描述][cc527eada27f4eea9ff8b83104e141b3.png]

接收参数：

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

#### GET请求中文乱码 ####

如果我们传递的参数中有中文，你会发现接收到的参数会出现中文乱码问题。

发送请求:`http://localhost/commonParam?name=张三&age=18`

控制台:

![在这里插入图片描述][38cf340aa0ee4db38ce6525d60bc9f70.png]

出现乱码的原因相信大家都清楚，`Tomcat8.5以后的版本已经处理了中文乱码的问题，但是IDEA中的Tomcat插件目前只到Tomcat7，所以需要修改pom.xml来解决GET请求中文乱码问题`

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

#### POST发送参数 ####

发送请求与参数:  
![在这里插入图片描述][bd988ad190f44ffd87bdfa62bc7e0ba9.png]

接收参数：

和GET一致，不用做任何修改

#### POST请求中文乱码 ####

发送请求与参数:

![在这里插入图片描述][bd38cca7ac1745f3bdf62e161a1f677d.png]

接收参数:

控制台打印，会发现有中文乱码问题。

![在这里插入图片描述][513f423d61f3438e9b57ace94e35bee6.png]

解决方案:配置过滤器

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

`CharacterEncodingFilter`是在`spring-web`包中，所以用之前需要导入对应的jar包。

## 3) 五种类型参数传递 ##

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

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

这些参数如何发送，后台改如何接收?我们一个个来学习。

### 1 普通参数 ###

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

![在这里插入图片描述][fc6bd8885b194cb5b100bb8e24080ddd.png]  
![在这里插入图片描述][abaa5adcf2ee4ccbbeb1cad757178ede.png]

如果形参与地址参数名不一致该如何解决?

发送请求与参数:

http://localhost/commonParamDifferentName?name=张三&age=15

后台接收参数:

@RequestMapping("/commonParamDifferentName")
    @ResponseBody
    public String commonParamDifferentName(String userName , int age){
        
        System.out.println("普通参数传递 userName ==> "+userName);
        System.out.println("普通参数传递 age ==> "+age);
        return "{'module':'common param different name'}";
    }

因为前端给的是`name`,后台接收使用的是`userName`,两个名称对不上，导致接收数据失败:  
![\`][bcb844b7cd06498c87cb8eb6c024e7ed.png]

解决方案:使用@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注解框架就不需要自己去解析注入，能提升框架处理性能**

### 2 POJO数据类型 ###

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

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

此时需要使用前面准备好的POJO类，先来看下`User`

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

发送请求和参数:

![在这里插入图片描述][c20f261cac964d44a10e2c332ccb0c3c.png]

后台接收参数:

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

**注意:**

*  POJO参数接收，前端GET和POST发送请求数据的方式不变。
 *  请求参数key的名称要和POJO中属性的名称一致，否则无法封装。

### 3 嵌套POJO类型参数 ###

如果POJO对象中嵌套了其他的POJO类，如

public class Address {
        
        private String province;
        private String city;
        //setter...getter...略
    }
    public class User {
        
        private String name;
        private int age;
        private Address address;
        //setter...getter...略
    }

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

发送请求和参数:

![在这里插入图片描述][ec43e995ac844c1d8861dd67067d33b3.png]

后台接收参数:

**注意:**

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

### 4 数组类型参数 ###

举个简单的例子，如果前端需要获取用户的爱好，爱好绝大多数情况下都是多个，如何发送请求数据和接收数据呢?

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

发送请求和参数:

![在这里插入图片描述][7b3c490363db4225b886eda08d97e5b8.png]

后台接收参数:

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

### 5 集合类型参数 ###

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

发送请求和参数:

![在这里插入图片描述][3361d2fe3f6143079ad8fb8fe8379def.png]

后台接收参数:

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

运行会报错，  
![在这里插入图片描述][78d99414765b4b3ab0001718f020da0c.png]

`错误的原因是`:SpringMVC将`List看做是一个POJO对象来处理`，将其创建一个对象并准备把前端的数据封装到对象中，但是`List是一个接口无法创建对象，所以报错。`

解决方案是:使用`@RequestParam`注解

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

*  `集合保存普通参数`：请求参数名与形参集合对象名相同且请求参数为多个，@RequestParam绑定参数关系
 *  对于简单数据类型使用数组会比集合更简单些。

### 知识点1：@RequestParam ###

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

## 4 )JSON数据传输参数 ##

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

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

*  json普通数组`（["value1","value2","value3",...]）`
 *  json对象`（{key1:value1,key2:value2,...}）`
 *  json对象数组`（[{key1:value1,...},{key2:value2,...}]）`

对于上述数据，前端如何发送，后端如何接收?

### 1.JSON普通数组 ###

#### 步骤1:pom.xml添加依赖 ####

SpringMVC默认使用的是jackson来处理json的转换，所以需要在pom.xml添加jackson依赖

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

#### 步骤2:PostMan发送JSON数据 ####

![在这里插入图片描述][e144b1d74a5b4c83a0a9f2f9ccf85e34.png]

#### 步骤3:开启SpringMVC注解支持 ####

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

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

#### 步骤4:参数前添加@RequestBody ####

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

#### 步骤5:启动运行程序 ####

![在这里插入图片描述][79a58d66eb63446ebad02ea828dde9ae.png]

JSON普通数组的数据就已经传递完成，下面针对JSON对象数据和JSON对象数组的数据该如何传递呢?

### 2. JSON对象数据 ###

我们会发现，只需要关注请求和数据如何发送?后端数据如何接收?

请求和数据的发送:

{
        
    	"name":"itcast",
    	"age":15
    }

![在这里插入图片描述][4953dd3989ed45a4a9aebc6ba366ca3c.png]

后端接收数据：

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

启动程序访问测试  
![在这里插入图片描述][e576b3f12b5e4761ae3d848158b28818.png]

**说明:**

`address`为`null的原因是前端没有传递数据给后端。`

如果想要address也有数据，我们`需求修改前端传递的数据内容:`

{
        
    	"name":"itcast",
    	"age":15,
        "address":{
        
            "province":"beijing",
            "city":"beijing"
        }
    }

再次发送请求，就能看到address中的数据

### 3.JSON对象数组 ###

集合中保存多个POJO该如何实现?

请求和数据的发送:

[
        {
        "name":"itcast","age":15},
        {
        "name":"itheima","age":12}
    ]

![在这里插入图片描述][f3bc36c08ccd495e84766118d557f62f.png]

后端接收数据:

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

启动程序访问测试

![在这里插入图片描述][c14ec744efb14ea78299fc3c92619b1c.png]

### **小结** ###

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

(1)导入`jackson包`

(2)使用PostMan发送`JSON数据`

(3)`开启SpringMVC注解驱动`，在配置类上添加`@EnableWebMvc`注解

(4)Controller方法的参数前添加`@RequestBody注解`

### 知识点1：@EnableWebMvc ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@EnableWebMvc</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>配置类注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td><code>SpringMVC配置类定义上方</code></td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>开启SpringMVC多项辅助功能</td> 
  </tr> 
 </tbody> 
</table>

### 知识点2：@RequestBody ###

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

### @RequestBody与@RequestParam区别 ###

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

### 5) 日期类型参数传递 ###

前面我们处理过简单数据类型、`POJO数据类型、数组和集合数据类型以及JSON数据类型`，接下来我们还得处理一种开发中比较常见的一种数据类型，`日期类型`

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

*  2088-08-18
 *  2088/08/18
 *  08/18/2088
 *  …

针对这么多日期格式，SpringMVC该如何接收，它能很好的处理日期类型数据么?

#### 步骤1:编写方法接收日期数据 ####

在UserController类中添加方法，把参数设置为日期类型

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

#### 步骤2:启动Tomcat服务器 ####

查看控制台是否报错，如果有错误，先解决错误。

#### 步骤3:使用PostMan发送请求 ####

使用PostMan发送GET请求，并设置date参数

`http://localhost/dataParam?date=2088/08/08`

![在这里插入图片描述][bef21a7287764d6faca05461b01de8e0.png]

#### 步骤4:查看控制台 ####

![在这里插入图片描述][7a1e8ffc14c34a35a8a980ea1981ba55.png]

通过打印，我们发现SpringMVC可以接收日期数据类型，并将其打印在控制台。

这个时候，我们就想如果把日期参数的格式改成其他的，SpringMVC还能处理么?

#### 步骤5:更换日期格式 ####

为了能更好的看到程序运行的结果，我们在方法中多添加一个日期参数

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

使用PostMan发送请求，携带两个不同的日期格式，

`http://localhost/dataParam?date=2088/08/08&date1=2088-08-08`

![在这里插入图片描述][51558edbf9464338a19fed758f881c24.png]

发送请求和数据后，页面会报400，控制台会报出一个错误

Resolved \[org.springframework.web.method.annotation.MethodArgumentTypeMismatchException: Failed to convert value of type ‘java.lang.String’ to required type ‘java.util.Date’; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type \[java.lang.String\] to type \[java.util.Date\] for value ‘2088-08-08’; nested exception is java.lang.IllegalArgumentException\]

从错误信息可以看出，错误的原因是在将`2088-08-08`转换成日期类型的时候失败了，原因是SpringMVC默认支持的字符串转日期的格式为`yyyy/MM/dd`,而`我们现在传递的不符合其默认格式，SpringMVC就无法进行格式转换，所以报错。`

解决方案也比较简单，需要使用`@DateTimeFormat`

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

重新启动服务器，重新发送请求测试，SpringMVC就可以正确的进行日期转换了

![在这里插入图片描述][36dd087d1afe4c17abc135e02ed2dc32.png]

#### 步骤6:携带时间的日期 ####

接下来我们再来发送一个携带时间的日期，看下SpringMVC该如何处理?

先修改UserController类，添加第三个参数

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

使用PostMan发送请求，携带两个不同的日期格式，

`http://localhost/dataParam?date=2088/08/08&date1=2088-08-08&date2=2088/08/08 8:08:08`

![在这里插入图片描述][ea1badbc9dc44c3c90e88b17e232a1d0.png]

重新启动服务器，重新发送请求测试，SpringMVC就可以将日期时间的数据进行转换

#### 知识点1：@DateTimeFormat ####

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

#### 内部实现原理 ####

讲解内部原理之前，我们需要先思考个问题:

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

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

答:SpringMVC

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

答:SpringMVC中提供了很多类型转换接口和实现类

在框架中，有一些类型转换接口，其中有:

*  (1) Converter接口

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

**注意:Converter所属的包为`org.springframework.core.convert.converter`**

Converter接口的实现类

![在这里插入图片描述][61090e49133b4267825519ddb00d9ec5.png]

框架中有提供很多对应`Converter接口`的实现类，用来实现不同数据类型之间的转换,如:

请求参数年龄数据（String→Integer）

日期格式转换（String → Date）

*  (2) `HttpMessageConverter`接口

该接口是`实现对象与JSON`之间的转换工作

**注意:SpringMVC的配置类把@EnableWebMvc当做标配配置上去，不要省略**

### 6) 响应 ###

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

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

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

*  响应页面
 *  响应数据
    
     *  `文本数据`
     *  `json数据`

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

#### (1) 环境准备 ####

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

![在这里插入图片描述][41e70c92d24f4cb5850201fea273f38b.png]

#### (2) 响应页面\[了解\] ####

##### 步骤1:设置返回页面 #####

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

![在这里插入图片描述][8facf30edea644918739cf6c0752d3d4.png]

#### (3) 返回文本数据\[了解\] ####

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

@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`访问

![在这里插入图片描述][5b152f6438f24d619a7638cbd0b434bb.png]

#### (4) 响应JSON数据 ####

##### 响应POJO对象 #####

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

![在这里插入图片描述][8eb14d6dd9b545179d6e23ec1597f7a4.png]

##### 响应POJO集合对象 #####

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

![在这里插入图片描述][e24558eda671495fa7c52bec1f394ce2.png]

#### 知识点1：@ResponseBody ####

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@ResponseBody</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>方法\类注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>SpringMVC控制器方法定义上方和控制类上</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td><code>设置当前控制器返回值作为响应体</code>,<br>写在类上，该类的所有方法都有该注解功能</td> 
  </tr> 
  <tr> 
   <td>相关属性</td> 
   <td>pattern：指定日期时间格式字符串</td> 
  </tr> 
 </tbody> 
</table>

@ResponseBody之前的请求和响应的区别：

![在这里插入图片描述][99a1838409e54ede9c206560e036def8.png]

**说明:**

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

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

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

Jackson在poml文件中导入的坐标，在http界面响应进行的转换接口  
![在这里插入图片描述][826cfe059e2b444c8a3f888bb96a662d.png]

## 5.Rest风格 ##

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

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

## 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来进行开发`的。

## 2) RESTful入门案例 ##

### 1 环境准备 ###

*  创建一个Web的Maven项目
 *  pom.xml添加Spring依赖
    
        <?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>
 *  创建对应的配置类
    
        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
    
        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
    
        @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'}";
            }
            
        }

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

![在这里插入图片描述][e2d3baf8d1f4479d92efa622533f0da4.png]

### 2 思路分析 ###

> 需求:`将之前的增删改查替换成RESTful的开发方式。`
> 
> 1.之前不同的请求有不同的路径,现在要将其修改为统一的请求路径
> 
> 修改前: 新增: /save ,修改: /update,删除 /delete…
> 
> 修改后: 增删改查: /users
> 
> 2.根据GET查询、POST新增、PUT修改、DELETE删除对方法的请求方式进行限定
> 
> 3.发送请求的过程中如何设置请求参数?

### 3 修改RESTful风格 ###

#### 新增 ####

@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请求，则会报错

![在这里插入图片描述][95eb3a386cfc4d2faa54806d961c3122.png]

#### 删除 ####

@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`注解

@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)如果方法形参的名称和路径`{}`中的值不一致，该怎么办?

![在这里插入图片描述][c797adc296d14ea9b2c7e8cb83ed4d6c.png]

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

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

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

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

#### 修改 ####

@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`
 *  访问并携带参数:

![在这里插入图片描述][0351bd13b4e24e4db5b53d9fce87cfd5.png]

#### 根据ID查询 ####

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

*  访问该方法使用 GET: `http://localhost/users/666`

#### 查询所有 ####

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

将请求路径更改为`/users`

*  访问该方法使用 GET: `http://localhost/users`

**小结**

RESTful入门案例，我们需要学习的内容如下:

(1)设定Http请求动作(动词)

`@RequestMapping`(value=“”,method = RequestMethod.POST|GET|PUT|DELETE)

(2)设定请求参数(路径变量)

`@RequestMapping`(value=“/users/\{id\}”,method = RequestMethod.DELETE)

`@ReponseBody`

public String delete(@PathVariable Integer id)\{

#### 知识点1：@PathVariable ####

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@PathVariable</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>形参注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>SpringMVC控制器方法形参定义前面</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td><code>绑定路径参数与处理器方法形参间的关系，要求路径参数名与形参名一一对应 </code></td> 
  </tr> 
 </tbody> 
</table>

关于接收参数，我们学过三个注解`@RequestBody`、`@RequestParam`、`@PathVariable`,这三个注解之间的区别和应用分别是什么?

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

## 3) RESTful快速开发 ##

做完了RESTful的开发，你会发现好麻烦，麻烦在哪?

问题1：每个方法的@RequestMapping注解中都定义了访问路径/books，重复性太高。

问题2：每个方法的@RequestMapping注解中都要使用method属性定义请求方式，重复性太高。

问题3：每个方法响应json都需要加上@ResponseBody注解，重复性太高。

对于上面所提的这三个问题，具体该如何解决?

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

对于刚才的问题，我们都有对应的解决方案：

问题1：每个方法的@RequestMapping注解中都定义了访问路径/books，重复性太高。

将@RequestMapping提到类上面，用来定义所有方法共同的访问路径。

问题2：每个方法的@RequestMapping注解中都要使用method属性定义请求方式，重复性太高。

使用@GetMapping  @PostMapping  @PutMapping  @DeleteMapping代替

问题3：每个方法响应json都需要加上@ResponseBody注解，重复性太高。

1.将ResponseBody提到类上面，让所有的方法都有@ResponseBody的功能
    2.使用@RestController注解替换@Controller与@ResponseBody注解，简化书写

#### 知识点1：@RestController ####

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@RestController</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>类注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td><code>基于SpringMVC的RESTful开发控制器类定义上方 </code></td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置当前控制器类为RESTful风格，<br>等同于@Controller与@ResponseBody两个注解组合功能</td> 
  </tr> 
 </tbody> 
</table>

#### 知识点2：@GetMapping @PostMapping @PutMapping @DeleteMapping ####

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

## 4)RESTful案例 ##

### 1 需求分析 ###

需求一:图片列表查询，从后台返回数据，将数据展示在页面上  
![在这里插入图片描述][276612b8c5524c539f3ff731a635b09c.png]

需求二:新增图片，将新增图书的数据传递到后台，并在控制台打印

![在这里插入图片描述][c0388290ede644e0b69ee255a8dfc4f0.png]

\*\*说明:\*\*此次案例的重点是在SpringMVC中如何使用RESTful实现前后台交互，所以本案例并没有和数据库进行交互，所有数据使用`假`数据来完成开发。

步骤分析:

> 1.搭建项目导入jar包
> 
> 2.编写Controller类，提供两个方法，一个用来做列表查询，一个用来做新增
> 
> 3.在方法上使用RESTful进行路径设置
> 
> 4.完成请求、参数的接收和结果的响应
> 
> 5.使用PostMan进行测试
> 
> 6.将前端页面拷贝到项目中
> 
> 7.页面发送ajax请求
> 
> 8.完成页面数据的展示

### 2 环境准备 ###

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

![在这里插入图片描述][7e1e73dbb6fd49949b3ba9ac8952a7e0.png]

#### 后台接口开发 ####

#### 步骤1:编写Controller类并使用RESTful进行配置 ####

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

#### 步骤2：使用PostMan进行测试 ####

测试新增

{
        
        "type":"计算机丛书",
        "name":"SpringMVC终极开发",
        "description":"这是一本好书"
    }

![在这里插入图片描述][635f76091cda46f0ac923cd509a9136d.png]

测试查询

![在这里插入图片描述][161f3a88cf804a0db3c843fc09b97da6.png]

### 3 页面访问处理 ###

#### 步骤1:拷贝静态页面 ####

将`资料\功能页面`下的所有内容拷贝到项目的`webapp`目录下

![在这里插入图片描述][a56a064ff11246d29880b0796298b482.png]

#### 步骤2:访问pages目录下的books.html ####

打开浏览器输入`http://localhost/pages/books.html`

![在这里插入图片描述][6bd3114365f84f5e98f01d02e9feb9d6.png]

(1)出现错误的原因?

![在这里插入图片描述][e31a9f7b7fe54e7ca01f151aadd38f1f.png]

`SpringMVC拦截了静态资源`，`根据/pages/books.html去controller找对应的方法，找不到所以会报404的错误`

(2)SpringMVC为什么会拦截静态资源呢?

![在这里插入图片描述][ffde20d425f847f0ac78557809982052.png]

(3)解决方案?

*  SpringMVC需要将`静态资源进行放行`。

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

*  该配置类是在config目录下，`SpringMVC扫描的是controller包，所以该配置类还未生效，要想生效需要将SpringMvcConfig配置类进行修改`

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

#### 步骤3:修改books.html页面 ####

<!DOCTYPE html>
    
    <html>
        <head>
            
            <meta charset="utf-8">
            <title>SpringMVC案例</title>
            
            <link rel="stylesheet" href="../plugins/elementui/index.css">
            <link rel="stylesheet" href="../plugins/font-awesome/css/font-awesome.min.css">
            <link rel="stylesheet" href="../css/style.css">
        </head>
    
        <body class="hold-transition">
    
            <div id="app">
    
                <div class="content-header">
                    <h1>图书管理</h1>
                </div>
    
                <div class="app-container">
                    <div class="box">
                        <div class="filter-container">
                            <el-input placeholder="图书名称" style="width: 200px;" class="filter-item"></el-input>
                            <el-button class="dalfBut">查询</el-button>
                            <el-button type="primary" class="butT" @click="openSave()">新建</el-button>
                        </div>
    
                        <el-table size="small" current-row-key="id" :data="dataList" stripe highlight-current-row>
                            <el-table-column type="index" align="center" label="序号"></el-table-column>
                            <el-table-column prop="type" label="图书类别" align="center"></el-table-column>
                            <el-table-column prop="name" label="图书名称" align="center"></el-table-column>
                            <el-table-column prop="description" label="描述" align="center"></el-table-column>
                            <el-table-column label="操作" align="center">
                                <template slot-scope="scope">
                                    <el-button type="primary" size="mini">编辑</el-button>
                                    <el-button size="mini" type="danger">删除</el-button>
                                </template>
                            </el-table-column>
                        </el-table>
    
                        <div class="pagination-container">
                            <el-pagination
                                class="pagiantion"
                                @current-change="handleCurrentChange"
                                :current-page="pagination.currentPage"
                                :page-size="pagination.pageSize"
                                layout="total, prev, pager, next, jumper"
                                :total="pagination.total">
                            </el-pagination>
                        </div>
    
                        
                        <div class="add-form">
                            <el-dialog title="新增图书" :visible.sync="dialogFormVisible">
                                <el-form ref="dataAddForm" :model="formData" :rules="rules" label-position="right" label-width="100px">
                                    <el-row>
                                        <el-col :span="12">
                                            <el-form-item label="图书类别" prop="type">
                                                <el-input v-model="formData.type"/>
                                            </el-form-item>
                                        </el-col>
                                        <el-col :span="12">
                                            <el-form-item label="图书名称" prop="name">
                                                <el-input v-model="formData.name"/>
                                            </el-form-item>
                                        </el-col>
                                    </el-row>
                                    <el-row>
                                        <el-col :span="24">
                                            <el-form-item label="描述">
                                                <el-input v-model="formData.description" type="textarea"></el-input>
                                            </el-form-item>
                                        </el-col>
                                    </el-row>
                                </el-form>
                                <div slot="footer" class="dialog-footer">
                                    <el-button @click="dialogFormVisible = false">取消</el-button>
                                    <el-button type="primary" @click="saveBook()">确定</el-button>
                                </div>
                            </el-dialog>
                        </div>
    
                    </div>
                </div>
            </div>
        </body>
    
        
        <script src="../js/vue.js"></script>
        <script src="../plugins/elementui/index.js"></script>
        <script type="text/javascript" src="../js/jquery.min.js"></script>
        <script src="../js/axios-0.18.0.js"></script>
    
        <script>
            var vue = new Vue({
          
    
                el: '#app',
    
                data:{
          
    				dataList: [],//当前页要展示的分页列表数据
                    formData: {
          },//表单数据
                    dialogFormVisible: false,//增加表单是否可见
                    dialogFormVisible4Edit:false,//编辑表单是否可见
                    pagination: {
          },//分页模型数据，暂时弃用
                },
    
                //钩子函数，VUE对象初始化完成后自动执行
                created() {
          
                    this.getAll();
                },
    
                methods: {
          
                    // 重置表单
                    resetForm() {
          
                        //清空输入框
                        this.formData = {
          };
                    },
    
                    // 弹出添加窗口
                    openSave() {
          
                        this.dialogFormVisible = true;
                        this.resetForm();
                    },
    
                    //添加
                    saveBook () {
          
                        axios.post("/books",this.formData).then((res)=>{
          
    
                        });
                    },
    
                    //主页列表查询
                    getAll() {
          
                        axios.get("/books").then((res)=>{
          
                            this.dataList = res.data;
                        });
                    },
    
                }
            })
        </script>
    </html>

[42d8ac0c68e8408eb07e0b487a55ec56.png]: https://img-blog.csdnimg.cn/42d8ac0c68e8408eb07e0b487a55ec56.png
[50afa705362f4a5fbb2986fbc7cbd2eb.png]: https://img-blog.csdnimg.cn/50afa705362f4a5fbb2986fbc7cbd2eb.png
[0cafffa2e55a420191f93d52a40071d0.png]: https://img-blog.csdnimg.cn/0cafffa2e55a420191f93d52a40071d0.png
[4e1793d8190b4f81aa2f85d29cf0358d.png]: https://img-blog.csdnimg.cn/4e1793d8190b4f81aa2f85d29cf0358d.png
[93b8ca5a3bc24509ba627dc20244aa4a.png]: https://img-blog.csdnimg.cn/93b8ca5a3bc24509ba627dc20244aa4a.png
[593d2ef799eb4241929369dab7819e2e.png]: https://img-blog.csdnimg.cn/593d2ef799eb4241929369dab7819e2e.png
[cf2be03432fd419ba02f54ee8c59c9e6.png]: https://img-blog.csdnimg.cn/cf2be03432fd419ba02f54ee8c59c9e6.png
[e8bcdbafa7364427b1b99133a7a3b205.png]: https://img-blog.csdnimg.cn/e8bcdbafa7364427b1b99133a7a3b205.png
[faf2c8e8a714491cbc1ca2ddef51fef4.png]: https://img-blog.csdnimg.cn/faf2c8e8a714491cbc1ca2ddef51fef4.png
[1fee3a9332704d9aa74fd4e828803c6b.png]: https://img-blog.csdnimg.cn/1fee3a9332704d9aa74fd4e828803c6b.png
[35b36e14ffbd4bd6bf445818257997b6.png]: https://img-blog.csdnimg.cn/35b36e14ffbd4bd6bf445818257997b6.png
[f3f73541f4a4426481d4f6493da5d6fc.png]: https://img-blog.csdnimg.cn/f3f73541f4a4426481d4f6493da5d6fc.png
[b4c83693c00e4b9ea0c3c2362c90939c.png]: https://img-blog.csdnimg.cn/b4c83693c00e4b9ea0c3c2362c90939c.png
[040cc740ab8f47a9a4345db8299402bf.png]: https://img-blog.csdnimg.cn/040cc740ab8f47a9a4345db8299402bf.png
[771ef6adb02f432b8b62a0fc02c954c4.png]: https://img-blog.csdnimg.cn/771ef6adb02f432b8b62a0fc02c954c4.png
[13a639eca53b41f79dad4b93df99ad7c.png]: https://img-blog.csdnimg.cn/13a639eca53b41f79dad4b93df99ad7c.png
[1eb7518348a84c4ebf5304a8638428b8.png]: https://img-blog.csdnimg.cn/1eb7518348a84c4ebf5304a8638428b8.png
[9b1e57c1fcec44dda0cf1650b2e8b761.png]: https://img-blog.csdnimg.cn/9b1e57c1fcec44dda0cf1650b2e8b761.png
[fbced15f5cd84674a42f6fbd83c7d5e4.png]: https://img-blog.csdnimg.cn/fbced15f5cd84674a42f6fbd83c7d5e4.png
[a304a5d3616a4443be205f98a63312d6.png]: https://img-blog.csdnimg.cn/a304a5d3616a4443be205f98a63312d6.png
[1114d43ccc8d46f8ac56b2adf15c9711.png]: https://img-blog.csdnimg.cn/1114d43ccc8d46f8ac56b2adf15c9711.png
[816a7fc675024648b63bfd9f98dcfc0d.png]: https://img-blog.csdnimg.cn/816a7fc675024648b63bfd9f98dcfc0d.png
[63098ac2664140c1be4a26386cd78e1e.png]: https://img-blog.csdnimg.cn/63098ac2664140c1be4a26386cd78e1e.png
[5cfb9d2bb8af420ea68e0a3c7d01f3da.png]: https://img-blog.csdnimg.cn/5cfb9d2bb8af420ea68e0a3c7d01f3da.png
[2b24e9da60644f5dbbd31a3ccc9e4c60.png]: https://img-blog.csdnimg.cn/2b24e9da60644f5dbbd31a3ccc9e4c60.png
[9d330790d6824f1d8b7fc67f69e29fe4.png]: https://img-blog.csdnimg.cn/9d330790d6824f1d8b7fc67f69e29fe4.png
[269dd8b0fc1048d8961de4476afdd3b3.png]: https://img-blog.csdnimg.cn/269dd8b0fc1048d8961de4476afdd3b3.png
[d06bf174987b473daf42d8c01b95378e.png]: https://img-blog.csdnimg.cn/d06bf174987b473daf42d8c01b95378e.png
[cc527eada27f4eea9ff8b83104e141b3.png]: https://img-blog.csdnimg.cn/cc527eada27f4eea9ff8b83104e141b3.png
[38cf340aa0ee4db38ce6525d60bc9f70.png]: https://img-blog.csdnimg.cn/38cf340aa0ee4db38ce6525d60bc9f70.png
[bd988ad190f44ffd87bdfa62bc7e0ba9.png]: https://img-blog.csdnimg.cn/bd988ad190f44ffd87bdfa62bc7e0ba9.png
[bd38cca7ac1745f3bdf62e161a1f677d.png]: https://img-blog.csdnimg.cn/bd38cca7ac1745f3bdf62e161a1f677d.png
[513f423d61f3438e9b57ace94e35bee6.png]: https://img-blog.csdnimg.cn/513f423d61f3438e9b57ace94e35bee6.png
[fc6bd8885b194cb5b100bb8e24080ddd.png]: https://img-blog.csdnimg.cn/fc6bd8885b194cb5b100bb8e24080ddd.png
[abaa5adcf2ee4ccbbeb1cad757178ede.png]: https://img-blog.csdnimg.cn/abaa5adcf2ee4ccbbeb1cad757178ede.png
[bcb844b7cd06498c87cb8eb6c024e7ed.png]: https://img-blog.csdnimg.cn/bcb844b7cd06498c87cb8eb6c024e7ed.png
[c20f261cac964d44a10e2c332ccb0c3c.png]: https://img-blog.csdnimg.cn/c20f261cac964d44a10e2c332ccb0c3c.png
[ec43e995ac844c1d8861dd67067d33b3.png]: https://img-blog.csdnimg.cn/ec43e995ac844c1d8861dd67067d33b3.png
[7b3c490363db4225b886eda08d97e5b8.png]: https://img-blog.csdnimg.cn/7b3c490363db4225b886eda08d97e5b8.png
[3361d2fe3f6143079ad8fb8fe8379def.png]: https://img-blog.csdnimg.cn/3361d2fe3f6143079ad8fb8fe8379def.png
[78d99414765b4b3ab0001718f020da0c.png]: https://img-blog.csdnimg.cn/78d99414765b4b3ab0001718f020da0c.png
[e144b1d74a5b4c83a0a9f2f9ccf85e34.png]: https://img-blog.csdnimg.cn/e144b1d74a5b4c83a0a9f2f9ccf85e34.png
[79a58d66eb63446ebad02ea828dde9ae.png]: https://img-blog.csdnimg.cn/79a58d66eb63446ebad02ea828dde9ae.png
[4953dd3989ed45a4a9aebc6ba366ca3c.png]: https://img-blog.csdnimg.cn/4953dd3989ed45a4a9aebc6ba366ca3c.png
[e576b3f12b5e4761ae3d848158b28818.png]: https://img-blog.csdnimg.cn/e576b3f12b5e4761ae3d848158b28818.png
[f3bc36c08ccd495e84766118d557f62f.png]: https://img-blog.csdnimg.cn/f3bc36c08ccd495e84766118d557f62f.png
[c14ec744efb14ea78299fc3c92619b1c.png]: https://img-blog.csdnimg.cn/c14ec744efb14ea78299fc3c92619b1c.png
[bef21a7287764d6faca05461b01de8e0.png]: https://img-blog.csdnimg.cn/bef21a7287764d6faca05461b01de8e0.png
[7a1e8ffc14c34a35a8a980ea1981ba55.png]: https://img-blog.csdnimg.cn/7a1e8ffc14c34a35a8a980ea1981ba55.png
[51558edbf9464338a19fed758f881c24.png]: https://img-blog.csdnimg.cn/51558edbf9464338a19fed758f881c24.png
[36dd087d1afe4c17abc135e02ed2dc32.png]: https://img-blog.csdnimg.cn/36dd087d1afe4c17abc135e02ed2dc32.png
[ea1badbc9dc44c3c90e88b17e232a1d0.png]: https://img-blog.csdnimg.cn/ea1badbc9dc44c3c90e88b17e232a1d0.png
[61090e49133b4267825519ddb00d9ec5.png]: https://img-blog.csdnimg.cn/61090e49133b4267825519ddb00d9ec5.png
[41e70c92d24f4cb5850201fea273f38b.png]: https://img-blog.csdnimg.cn/41e70c92d24f4cb5850201fea273f38b.png
[8facf30edea644918739cf6c0752d3d4.png]: https://img-blog.csdnimg.cn/8facf30edea644918739cf6c0752d3d4.png
[5b152f6438f24d619a7638cbd0b434bb.png]: https://img-blog.csdnimg.cn/5b152f6438f24d619a7638cbd0b434bb.png
[8eb14d6dd9b545179d6e23ec1597f7a4.png]: https://img-blog.csdnimg.cn/8eb14d6dd9b545179d6e23ec1597f7a4.png
[e24558eda671495fa7c52bec1f394ce2.png]: https://img-blog.csdnimg.cn/e24558eda671495fa7c52bec1f394ce2.png
[99a1838409e54ede9c206560e036def8.png]: https://img-blog.csdnimg.cn/99a1838409e54ede9c206560e036def8.png
[826cfe059e2b444c8a3f888bb96a662d.png]: https://img-blog.csdnimg.cn/826cfe059e2b444c8a3f888bb96a662d.png
[e2d3baf8d1f4479d92efa622533f0da4.png]: https://img-blog.csdnimg.cn/e2d3baf8d1f4479d92efa622533f0da4.png
[95eb3a386cfc4d2faa54806d961c3122.png]: https://img-blog.csdnimg.cn/95eb3a386cfc4d2faa54806d961c3122.png
[c797adc296d14ea9b2c7e8cb83ed4d6c.png]: https://img-blog.csdnimg.cn/c797adc296d14ea9b2c7e8cb83ed4d6c.png
[0351bd13b4e24e4db5b53d9fce87cfd5.png]: https://img-blog.csdnimg.cn/0351bd13b4e24e4db5b53d9fce87cfd5.png
[276612b8c5524c539f3ff731a635b09c.png]: https://img-blog.csdnimg.cn/276612b8c5524c539f3ff731a635b09c.png
[c0388290ede644e0b69ee255a8dfc4f0.png]: https://img-blog.csdnimg.cn/c0388290ede644e0b69ee255a8dfc4f0.png
[7e1e73dbb6fd49949b3ba9ac8952a7e0.png]: https://img-blog.csdnimg.cn/7e1e73dbb6fd49949b3ba9ac8952a7e0.png
[635f76091cda46f0ac923cd509a9136d.png]: https://img-blog.csdnimg.cn/635f76091cda46f0ac923cd509a9136d.png
[161f3a88cf804a0db3c843fc09b97da6.png]: https://img-blog.csdnimg.cn/161f3a88cf804a0db3c843fc09b97da6.png
[a56a064ff11246d29880b0796298b482.png]: https://img-blog.csdnimg.cn/a56a064ff11246d29880b0796298b482.png
[6bd3114365f84f5e98f01d02e9feb9d6.png]: https://img-blog.csdnimg.cn/6bd3114365f84f5e98f01d02e9feb9d6.png
[e31a9f7b7fe54e7ca01f151aadd38f1f.png]: https://img-blog.csdnimg.cn/e31a9f7b7fe54e7ca01f151aadd38f1f.png
[ffde20d425f847f0ac78557809982052.png]: https://img-blog.csdnimg.cn/ffde20d425f847f0ac78557809982052.png