SpringMVC
感谢黑马程序员的SpringMVC课程
SpringMVC
SpringMVC是隶属于Spring框架的一部分,主要是用来进行Web开发,是对Servlet进行了封装。
对于SpringMVC我们主要学习如下内容:
- SpringMVC简介
- 请求与响应
- REST风格
- SSM整合(注解版)
- 拦截器
SpringMVC是处于Web层的框架,所以其主要的作用就是用来接收前端发过来的请求和数据然后经过处理并将处理的结果响应给前端,所以如何处理请求和响应是SpringMVC中非常重要的一块内容。
REST是一种软件架构风格,可以降低开发的复杂性,提高系统的可伸缩性,后期的应用也是非常广泛。
SSM整合是把咱们所学习的SpringMVC+Spring+Mybatis整合在一起来完成业务开发,是对我们所学习这三个框架的一个综合应用。
SpringMVC概述
学习SpringMVC我们先来回顾下现在web程序是如何做的,咱们现在web程序大都基于三层架构来实现。
-
浏览器发送一个请求给后端服务器,后端服务器现在是使用Servlet来接收请求和数据
-
如果所有的处理都交给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的定义
-
SpringMVC是一种基于Java实现MVC模型的轻量级Web框架
-
优点
- 使用简单、开发便捷(相比于Servlet)
- 灵活性强
SpringMVC入门案例
- 因为SpringMVC是一个Web框架,将来是要替换Servlet,所以先来回顾下以前Servlet是如何进行开发的?
1.创建web工程(Maven结构)
2.设置tomcat服务器,加载web工程(tomcat插件)
3.导入坐标(Servlet)
4.定义处理请求的功能类(UserServlet)
5.设置请求映射(配置映射关系)
- SpringMVC的制作过程和上述流程几乎是一致的,具体的实现流程是什么?
1.创建web工程(Maven结构)
2.设置tomcat服务器,加载web工程(tomcat插件)
3.导入坐标(SpringMVC+Servlet)
4.定义处理请求的功能类(UserController)
5.设置请求映射(配置映射关系)
6.将SpringMVC设定加载到Tomcat容器中
需求分析
案例制作
-
步骤一:
创建Maven项目步骤二:
导入所需坐标(SpringMVC+Servlet)
在pom.xml
中导入下面两个坐标
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
public class UserController {
//设置当前访问路径,使用@RequestMapping
//设置当前对象的返回值类型
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
//
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/save
页面上成功出现{'info':'springmvc'}
,至此我们的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
名称 | @Controller |
---|---|
类型 | 类注解 |
位置 | SpringMVC控制器类定义上方 |
作用 | 设定SpringMVC的核心控制器bean |
知识点2:@RequestMapping
名称 | @RequestMapping |
---|---|
类型 | 类注解或方法注解 |
位置 | SpringMVC控制器类或方法定义上方 |
作用 | 设置当前控制器方法请求访问路径 |
相关属性 | value(默认),请求访问路径 |
知识点3:@ResponseBody
名称 | @ResponseBody |
---|---|
类型 | 类注解或方法注解 |
位置 | SpringMVC控制器类或方法定义上方 |
作用 | 设置当前控制器方法响应内容为当前返回值,无需解析 |
入门案例总结
- 一次性工作
- 创建工程,设置服务器,加载工程
- 导入坐标
- 创建web容器启动类,加载SpringMVC配置,并设置SpringMVC请求拦截路径
- SpringMVC核心配置类(设置配置类,扫描controller包,加载Controller控制器bean)
- 多次工作
- 定义处理请求的控制器类
- 定义处理请求的控制器方法,并配置映射路径(@RequestMapping)与返回json数据(@ResponseBody)
工作流程解析
为了更好的使用SpringMVC,我们将SpringMVC的使用过程总共分两个阶段来分析,分别是启动服务器初始化过程
和单次请求过程
启动服务器初始化过程
-
服务器启动,执行ServletContainersInitConfig类,初始化web容器
- 功能类似于以前的web.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17public 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;
}
} -
执行createServletApplicationContext方法,创建了WebApplicationContext对象
- 该方法加载SpringMVC的配置类SpringMvcConfig来初始化SpringMVC的容器
1
2
3
4
5protected WebApplicationContext createServletApplicationContext() {
AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
context.register(SpringMvcConfig.class);
return context;
} -
加载SpringMvcConfig配置类
1
2
3
4
5
public class SpringMvcConfig {
} -
执行@ComponentScan加载对应的bean
- 扫描指定包及其子包下所有类上的注解,如Controller类上的@Controller注解
-
加载UserController,每个@RequestMapping的名称对应一个具体的方法
1
2
3
4
5
6
7
8
9
public class UserController {
public String save(){
System.out.println("user save ...");
return "{'module':'SpringMVC'}";
}
}- 此时就建立了
/save
和 save方法的对应关系
- 此时就建立了
-
执行getServletMappings方法,设定SpringMVC拦截请求的路径规则
1
2
3protected String[] getServletMappings() {
return new String[]{"/"};
}/
代表所拦截请求的路径规则,只有被拦截后才能交给SpringMVC来处理请求
单次请求过程
- 发送请求
http://localhost/save
- web容器发现该请求满足SpringMVC拦截规则,将请求交给SpringMVC处理
- 解析请求路径/save
- 由/save匹配执行对应的方法save()
- 上面的第五步已经将请求路径和方法建立了对应关系,通过/save就能找到对应的save方法
- 执行save()
- 检测到有@ResponseBody直接将save()方法的返回值作为响应体返回给请求方
bean加载控制
问题分析
入门案例的内容已经做完了,在入门案例中我们创建过一个SpringMvcConfig
的配置类,再回想前面咱们学习Spring的时候也创建过一个配置类SpringConfig
。这两个配置类都需要加载资源,那么它们分别都需要加载哪些内容?
我们先来看下目前我们的项目目录结构:
com.itmema
下有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,SqlSessionFactoryBean,MapperScannerConfigurer等)
分析清楚谁该管哪些bean以后,接下来要解决的问题是如何让Spring和SpringMVC分开加载各自的内容。
在SpringMVC的配置类SpringMvcConfig
中使用注解@ComponentScan
,我们只需要将其扫描范围设置到controller即可,如
1 |
|
在Spring的配置类SpringConfig
中使用注解@ComponentScan
,当时扫描的范围中其实是已经包含了controller,如:
1 |
|
从包结构来看的话,Spring已经多把SpringMVC的controller类也给扫描到,所以针对这个问题该如何解决,就是咱们接下来要学习的内容。
概括的描述下咱们现在的问题就是因为功能不同,如何避免Spring错误加载到SpringMVC的bean?
思路分析
针对上面的问题,解决方案也比较简单,就是:
- 加载Spring控制的bean的时候排除掉SpringMVC控制的bean
具体该如何排除:
- 方式一:Spring加载的bean设定扫描范围为精准范围,例如service包、dao包等
- 方式二:Spring加载的bean设定扫描范围为com.itheima,排除掉controller包中的bean
- 方式三:不区分Spring与SpringMVC的环境,加载到同一个环境中[了解即可]
环境准备
-
创建一个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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<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> -
创建对应的配置类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24public 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;
}
}
public class SpringMvcConfig {
}
public class SpringConfig {
} -
编写Controller,Service,Dao,Domain类
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
public class UserController {
public String save(){
System.out.println("user save ...");
return "{'info':'springmvc'}";
}
}
public interface UserService {
public void save(User user);
}
public class UserServiceImpl implements UserService {
public void save(User user) {
System.out.println("user service ...");
}
}
public interface UserDao {
public void save(User user);
}
public class User {
private Integer id;
private String name;
private Integer age;
//setter..getter..toString略
}
设置bean加载控制
方式一:修改Spring配置类,设定扫描范围为精准范围。
1 |
|
说明:
上述只是通过例子说明可以精确指定让Spring扫描对应的包结构,真正在做开发的时候,因为Dao最终是交给MapperScannerConfigurer
对象来进行扫描处理的,我们只需要将其扫描到service包即可。
方式二:修改Spring配置类,设定扫描范围为com.itheima,排除掉controller包中的bean
1 |
|
-
excludeFilters属性:设置扫描加载bean时,排除的过滤规则
-
type属性:设置排除规则,当前使用按照bean定义时的注解类型进行排除
- ANNOTATION:按照注解排除
- ASSIGNABLE_TYPE:按照指定的类型过滤
- ASPECTJ:按照Aspectj表达式排除,基本上不会用
- REGEX:按照正则表达式排除
- CUSTOM:按照自定义规则排除
大家只需要知道第一种ANNOTATION即可
-
classes属性:设置排除的具体注解类,当前设置排除@Controller定义的bean
如何测试controller类已经被排除掉了?
1 | public class App{ |
如果被排除了,该方法执行就会报bean未被定义的错误NoSuchBeanDefinitionException
注意:测试的时候,需要把SpringMvcConfig配置类上的@ComponentScan注解注释掉,否则不会报错
出现问题的原因是,
- Spring配置类扫描的包是
com.itheima
- SpringMVC的配置类,
SpringMvcConfig
上有一个@Configuration注解,也会被Spring扫描到 - SpringMvcConfig上又有一个@ComponentScan,把controller类又给扫描进来了
- 所以如果不把@ComponentScan注释掉,Spring配置类将Controller排除,但是因为扫描到SpringMVC的配置类,又将其加载回来,演示的效果就出不来
- 解决方案,也简单,把SpringMVC的配置类移出Spring配置类的扫描范围即可。
最后一个问题,有了Spring的配置类,要想在tomcat服务器启动将其加载,我们需要修改ServletContainersInitConfig
1 | public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer { |
对于上述的配置方式,Spring还提供了一种更简单的配置方式,可以不用再去创建AnnotationConfigWebApplicationContext
对象,不用手动register
对应的配置类,如何实现?
1 | public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer { |
知识点1:@ComponentScan
名称 | @ComponentScan |
---|---|
类型 | 类注解 |
位置 | 类定义上方 |
作用 | 设置spring配置类扫描路径,用于加载使用注解格式定义的bean |
相关属性 | excludeFilters:排除扫描路径中加载的bean,需要指定类别(type)和具体项(classes) includeFilters:加载指定的bean,需要指定类别(type)和具体项(classes) |
PostMan工具的使用
PostMan简介
代码编写完后,我们要想测试,只需要打开浏览器直接输入地址发送请求即可。发送的是GET
请求可以直接使用浏览器,但是如果要发送的是POST
请求呢?
如果要求发送的是post请求,我们就得准备页面在页面上准备form表单,测试起来比较麻烦。所以我们就需要借助一些第三方工具,如PostMan.
-
PostMan是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件。
-
作用:常用于进行接口测试
-
特征 简单 实用 美观 大方
PostMan安装
-
傻瓜式安装即可,出现注册可以不管.
PostMan使用
创建WorkSpace工作空间
发送请求
保存当前请求
**注意:**第一次请求需要创建一个新的目录,后面就不需要创建新目录,直接保存到已经创建好的目录即可。
请求与响应
前面我们已经完成了入门案例相关的知识学习,接来了我们就需要针对SpringMVC相关的知识点进行系统的学习,之前我们提到过,SpringMVC是web层的框架,主要的作用是接收请求、接收数据、响应结果,所以这一章节是学习SpringMVC的重点内容,我们主要会讲解四部分内容:
- 请求映射路径
- 请求参数
- 日期类型参数传递
- 响应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
<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_03_request_mapping</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> -
创建对应的配置类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
protected Class<?>[] getServletConfigClasses() {
return new Class[]{SpringMvcConfig.class};
}
protected String[] getServletMappings() {
return new String[]{"/"};
}
protected Class<?>[] getRootConfigClasses() {
return new Class[0];
}
}
public class SpringMvcConfig {
} -
编写BookController和UserController
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
public class UserController {
public String save(){
System.out.println("user save ...");
return "{'module':'user save'}";
}
public String save(){
System.out.println("user delete ...");
return "{'module':'user delete'}";
}
}
public class BookController {
public String save(){
System.out.println("book save ...");
return "{'module':'book save'}";
}
}
把环境准备好后,启动Tomcat服务器,后台会报错:
1 | com.itheima.controller.UserController#save() |
从错误信息可以看出:
- UserController有一个save方法,访问路径为
http://localhost/save
- BookController也有一个save方法,访问路径为
http://localhost/save
- 当访问
http://localhost/saved
的时候,到底是访问UserController还是BookController?
问题分析
团队多人开发,每人设置不同的请求路径,冲突问题该如何解决?
解决思路:为不同模块设置模块名作为请求路径前置
对于Book模块的save,将其访问路径设置http://localhost/book/save
对于User模块的save,将其访问路径设置http://localhost/user/save
这样在同一个模块中出现命名冲突的情况就比较少了。
设置映射路径
步骤1:修改Controller
1 |
|
问题是解决了,但是每个方法前面都需要进行修改,写起来比较麻烦而且还有很多重复代码,如果/user后期发生变化,所有的方法都需要改,耦合度太高。
步骤2:优化路径配置
优化方案:
1 |
|
注意:
- 当类上和方法上都添加了
@RequestMapping
注解,前端发送请求的时候,要和两个注解的value值相加匹配才能访问到。- @RequestMapping注解value属性前面加不加
/
都可以
扩展小知识: 对于PostMan如何觉得字小不好看,可以使用ctrl+=
调大,ctrl+-
调小。
请求参数
请求路径设置好后,只要确保页面发送请求地址和后台Controller类中配置的路径一致,就可以接收到前端的请求,接收到请求后,如何接收页面传递的参数?
关于请求参数的传递与接收是和请求方式有关系的,目前比较常见的两种请求方式为:
- GET
- POST
针对于不同的请求前端如何发送,后端如何接收?
环境准备
-
使用上面用到的环境即可
-
编写UserController
1
2
3
4
5
6
7
8
9
public class UserController {
public String commonParam(){
return "{'module':'commonParam'}";
}
}
-
编写模型类,User和Address
1
2
3
4
5
6
7
8
9
10public class Address {
private String province;
private String city;
//setter...getter...略
}
public class User {
private String name;
private int age;
//setter...getter...略
}
参数传递
GET发送单个参数
启动Tomcat服务器,发送请求与参数:http://localhost/commonParam?name=itcast
接收参数:
1 |
|
GET发送多个参数
发送请求与参数:http://localhost/commonParam?name=itcast&age=15
接收参数:
1 |
|
POST发送参数
发送请求与参数:
接收参数:
和GET一致,不用做任何修改
1 |
|
- POST请求中文乱码
如果我们在发送post请求的时候,使用了中文,则会出现乱码 - 解决方案:配置过滤器
1 | public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer { |
五种类型参数传递
前面我们已经能够使用GET或POST来发送请求和数据,所携带的数据都是比较简单的数据,接下来在这个基础上,我们来研究一些比较复杂的参数传递,常见的参数种类有:
- 普通参数
- POJO类型参数
- 嵌套POJO类型参数
- 数组类型参数
- 集合类型参数
普通参数
- 发送请求与参数:
localhost/user/commonParam?name=ZHANGSAN&age=1024
- 后台接收参数
1 |
|
- 控制台输出
1 | 普通参数传递name --> ZHANGSAN |
如果形参与地址参数名不一致该如何解决?例如地址参数名为username
,而形参变量名为name
,因为前端给的是username
,后台接收使用的是name
,两个名称对不上,会导致接收数据失败
- 控制台输出
1 | 普通参数传递name --> NULL |
- 解决方案:使用
@RequestParam
注解- 发送请求与参数:
localhost/user/commonParam?name=ZHANGSAN&age=1024
- 后台接收参数
- 发送请求与参数:
1 |
|
注意:写上@RequestParam注解框架就不需要自己去解析注入,能提升框架处理性能
POJO数据类型
简单数据类型一般处理的是参数个数比较少的请求,如果参数比较多,那么后台接收参数的时候就比较复杂,这个时候我们可以考虑使用POJO数据类型。
- POJO参数:请求参数名与形参对象属性名相同,定义POJO类型形参即可接收参数
此时需要使用前面准备好的POJO类,先来看下User
1 | public class User { |
发送请求和参数:localhost/user/pojoParam?name=ZHANGSAN&age=1024
后台接收参数:
1 | //POJO参数:请求参数与形参对象中的属性对应即可完成参数传递 |
- 控制台输出如下
1 | POJO参数传递user --> User{name=‘ZHANGSAN’, age=1024} |
注意:
- POJO参数接收,前端GET和POST发送请求数据的方式不变。
- 请求参数key的名称要和POJO中属性的名称一致,否则无法封装。
嵌套POJO类型参数
如果POJO对象中嵌套了其他的POJO类,如
1 | public class Address { |
- 嵌套POJO参数:请求参数名与形参对象属性名相同,按照对象层次结构关系即可接收嵌套POJO属性参数
发送请求和参数:localhost/user/pojoParam?name=ZHANGSAN&age=1024&address.province=Beijing&address.city=Beijing
后台接收参数:
1 |
|
- 控制台输出如下
1 | POJO参数传递user --> User{name=‘ZHANGSAN’, age=1024, address=Address{province=‘Beijing’, city=‘Beijing’}} |
注意: 请求参数key的名称要和POJO中属性的名称一致,否则无法封装
数组类型参数
举个简单的例子,如果前端需要获取用户的爱好,爱好绝大多数情况下都是多个,如何发送请求数据和接收数据呢?
- 数组参数:请求参数名与形参对象属性名相同且请求参数为多个,定义数组类型即可接收参数
发送请求和参数:localhost/user/arrayParam?hobbies=sing&hobbies=jump&hobbies=rap&hobbies=basketball
后台接收参数:
1 |
|
- 控制台输出如下
1 | 数组参数传递user --> [sing, jump, rap, basketball] |
集合类型参数
数组能接收多个值,那么集合是否也可以实现这个功能呢?
发送请求和参数:localhost/user/listParam?hobbies=sing&hobbies=jump&hobbies=rap&hobbies=basketball
后台接收参数:
1 | //集合参数:同名请求参数可以使用@RequestParam注解映射到对应名称的集合对象中作为数据 |
-
运行程序,报错
1
java.lang.IllegalArgumentException: Cannot generate variable name for non-typed Collection parameter type
- 错误原因:SpringMVC将List看做是一个POJO对象来处理,将其创建一个对象并准备把前端的数据封装到对象中,但是List是一个接口无法创建对象,所以报错。
-
解决方案是:使用
@RequestParam
注解
1 |
|
- 控制台输出如下
1 | 集合参数传递user --> [sing, jump, rap, basketball] |
- 集合保存普通参数:请求参数名与形参集合对象名相同且请求参数为多个,@RequestParam绑定参数关系
- 对于简单数据类型使用数组会比集合更简单些。
知识点1:@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:pom.xml添加依赖
SpringMVC默认使用的是jackson来处理json的转换,所以需要在pom.xml添加jackson依赖
1 | <dependency> |
步骤2:PostMan发送JSON数据
步骤3:开启SpringMVC注解支持
在SpringMVC的配置类中开启SpringMVC的注解支持,这里面就包含了将JSON转换成对象的功能。
1 |
|
步骤4:参数前添加@RequestBody
1 | //使用@RequestBody注解将外部传递的json数组数据映射到形参的集合对象中作为数据 |
步骤5:启动运行程序
1 | //控制台输出 |
JSON对象数据
我们会发现,只需要关注请求和数据如何发送?后端数据如何接收?
请求和数据的发送:
1 | { |
后端接收数据:
1 |
|
启动程序访问测试输出
1 | pojo(json)参数传递user==>User{name='itcast',age=15,address=nul1} |
说明:
address为null的原因是前端没有传递数据给后端。
如果想要address也有数据,我们需求修改前端传递的数据内容:
1 | { |
再次发送请求,就能看到address中的数据
1 | pojo(json)参数传递user==>User{name='itcast',age=15,address=Address{province=‘beijing’, city=‘beijing’}} |
JSON对象数组
集合中保存多个POJO该如何实现?
请求和数据的发送:
1 | [ |
后端接收数据:
1 |
|
启动程序访问测试
1 | list pojo(json)参数传递 list ==>[User{name='itcast',age=15,address=null},User{name='itheima',age=12,address=null}] |
小结
SpringMVC接收JSON数据的实现步骤为:
(1)导入jackson包
(2)使用PostMan发送JSON数据
(3)开启SpringMVC注解驱动,在配置类上添加@EnableWebMvc注解
(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接收请求参数
日期类型参数传递
前面我们处理过简单数据类型、POJO数据类型、数组和集合数据类型以及JSON数据类型,接下来我们还得处理一种开发中比较常见的一种数据类型,日期类型
日期类型比较特殊,因为对于日期的格式有N多中输入方式,比如:
- 2088-08-18
- 2088/08/18
- 08/18/2088
- …
针对这么多日期格式,SpringMVC该如何接收,它能很好的处理日期类型数据么?
- 步骤1:编写方法接收日期数据
在UserController类中添加方法,把参数设置为日期类型
1 |
|
-
步骤2:启动Tomcat服务器
-
步骤3:使用PostMan发送请求
使用PostMan发送GET请求,并设置date参数
http://localhost/dataParam?date=2088/08/08
-
步骤4:查看控制台
1
参数传递 date ==> Sun Aug 08 00:00:00 CST 2088
通过打印,我们发现SpringMVC可以接收日期数据类型,并将其打印在控制台。
- 步骤5:更换日期格式
为了能更好的看到程序运行的结果,我们在方法中多添加一个日期参数
1 |
|
使用PostMan发送请求,携带两个不同的日期格式,
http://localhost/dataParam?date=2088/08/08&date1=2088-08-08
发送请求和数据后,页面会报400,控制台会报出一个错误
1 | 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
1 |
|
重新启动服务器,重新发送请求测试,SpringMVC就可以正确的进行日期转换了
1 | 参数传递 date ==> Sun Aug 08 00:00:00 CST 2088 |
- 步骤6:携带时间的日期
接下来我们再来发送一个携带时间的日期,看下SpringMVC该如何处理?
先修改UserController类,添加第三个参数
1 |
|
使用PostMan发送请求,携带两个不同的日期格式,
http://localhost/dataParam?date=2088/08/08&date1=2088-08-08&date2=2088/08/08 8:08:08
重新启动服务器,重新发送请求测试,SpringMVC就可以将日期时间的数据进行转换
1 | 参数传递 date ==> Sun Aug 08 00:00:00 CST 2088 |
知识点1:@DateTimeFormat
名称 | @DateTimeFormat |
---|---|
类型 | 形参注解 |
位置 | SpringMVC控制器方法形参前面 |
作用 | 设定日期时间型数据格式 |
相关属性 | pattern:指定日期时间格式字符串 |
内部实现原理
讲解内部原理之前,我们需要先思考个问题:
- 前端传递字符串,后端使用日期Date接收
- 前端传递JSON数据,后端使用对象接收
- 前端传递字符串,后端使用Integer接收
- 后台需要的数据类型有很多中
- 在数据的传递过程中存在很多类型的转换
问
:谁来做这个类型转换?
答
:SpringMVC
问
:SpringMVC是如何实现类型转换的?
答
:SpringMVC中提供了很多类型转换接口和实现类
在框架中,有一些类型转换接口,其中有:
Converter
接口
注意:Converter所属的包为org.springframework.core.convert.converter
1 | /** |
到了源码页面我们按Ctrl + H可以来看看Converter
接口的层次结构
这里给我们提供了很多对应Converter
接口的实现类,用来实现不同数据类型之间的转换
HttpMessageConverter
接口
该接口是实现对象与JSON之间的转换工作
注意:需要在SpringMVC的配置类把@EnableWebMvc
当做标配配置上去,不要省略
响应
SpringMVC接收到请求和数据后,进行一些了的处理,当然这个处理可以是转发给Service,Service层再调用Dao层完成的,不管怎样,处理完以后,都需要将结果告知给用户。
比如:根据用户ID查询用户信息、查询用户列表、新增用户等。
对于响应,主要就包含两部分内容:
- 响应页面
- 响应数据
- 文本数据
- json数据
因为异步调用是目前常用的主流方式,所以我们需要更关注的就是如何返回JSON数据,对于其他只需要认识了解即可。
环境准备
-
还是用之前的那套环境即可,添加一些新的页面
-
webapp下创建page.jsp
1
2
3
4
5<html>
<body>
<h2>Hello Spring MVC!</h2>
</body>
</html> -
编写UserController
1
2
3
4
public class UserController {
}
响应页面[了解]
步骤1:设置返回页面
1 |
|
步骤2:启动程序测试
打开浏览器,访问http://localhost/toJumpPage
将跳转到page.jsp
页面,并展示page.jsp
页面的内容
返回文本数据[了解]
步骤1:设置返回文本内容
1 |
|
步骤2:启动程序测试
浏览器访问http://localhost/toText
页面上出现response text
文本数据
响应JSON数据
响应POJO对象
1 |
|
返回值为实体类对象,设置返回值为实体类类型,即可实现返回对应对象的json数据,需要依赖**@ResponseBody** 注解和**@EnableWebMvc **注解
重新启动服务器,访问http://localhost/toJsonPOJO
1 | {“name”:“itcast”,“age”:15,“address”:null} |
响应POJO集合对象
1 |
|
重新启动服务器,访问http://localhost/toJsonList
1 | [{“name”:“传智播客”,“age”:15,“address”:null},{“name”:“黑马程序员”,“age”:12,“address”:null}] |
知识点1:@ResponseBody
名称 | @ResponseBody |
---|---|
类型 | 方法\类注解 |
位置 | SpringMVC控制器方法定义上方和控制类上 |
作用 | 设置当前控制器返回值作为响应体, 写在类上,该类的所有方法都有该注解功能 |
相关属性 | pattern:指定日期时间格式字符串 |
说明:
- 该注解可以写在类上或者方法上
- 写在类上就是该类下的所有方法都有@ReponseBody功能
- 当方法上有@ReponseBody注解后
- 方法的返回值为字符串,会将其作为文本内容直接响应给前端
- 方法的返回值为对象,会将对象转换成JSON响应给前端
此处又使用到了类型转换,内部还是通过Converter接口的实现类完成的,所以Converter除了前面所说的功能外,它还可以实现:
- 对象转Json数据(POJO -> json)
- 集合转Json数据(Collection -> json)
Rest风格
对于Rest风格,我们需要学习的内容包括:
- REST简介
- REST入门案例
- REST快速开发
- 案例:基于RESTful页面数据交互
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来进行开发的。
RESTful入门案例
环境准备
-
创建一个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
<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
30public 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[]{"/"};
}
//乱码处理
protected Filter[] getServletFilters() {
CharacterEncodingFilter filter = new CharacterEncodingFilter();
filter.setEncoding("UTF-8");
return new Filter[]{filter};
}
}
//开启json数据类型自动转换
public class SpringMvcConfig {
} -
编写模型类User和Book
1
2
3
4
5
6
7
8
9
10
11public 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
public class UserController {
public String save( { User user)
System.out.println("user save..."+user);
return "{'module':'user save'}";
}
public String delete(Integer id) {
System.out.println("user delete..." + id);
return "{'module':'user delete'}";
}
public String update( { User user)
System.out.println("user update..." + user);
return "{'module':'user update'}";
}
public String getById(Integer id) {
System.out.println("user getById..." + id);
return "{'module':'user getById'}";
}
public String getAll() {
System.out.println("user getAll...");
return "{'module':'user getAll'}";
}
}
public class BookController {
public String save({ Book book)
System.out.println("book save..." + book);
return "{'module':'book save'}";
}
public String delete({ Integer id)
System.out.println("book delete..." + id);
return "{'module':'book delete'}";
}
public String update({ Book book)
System.out.println("book update..." + book);
return "{'module':'book update'}";
}
public String getById({ Integer id)
System.out.println("book getById..." + id);
return "{'module':'book getById'}";
}
public String getAll(){
System.out.println("book getAll...");
return "{'module':'book getAll'}";
}
}
思路分析
需求:将之前的增删改查替换成RESTful的开发方式。
1.之前不同的请求有不同的路径,现在要将其修改为统一的请求路径
修改前: 新增: /save ,修改: /update,删除 /delete…
修改后: 增删改查: /users
2.根据GET查询、POST新增、PUT修改、DELETE删除对方法的请求方式进行限定
3.发送请求的过程中如何设置请求参数?
修改RESTful风格
新增
1 |
|
-
将请求路径更改为
/users
- 访问该方法使用 POST:
http://localhost/users
- 访问该方法使用 POST:
-
使用method属性限定该方法的访问方式为
POST
- 如果发送的不是POST请求,比如发送GET请求,则会报错
删除
1 |
|
- 将请求路径更改为
/users
- 访问该方法使用 DELETE:
http://localhost/users
- 访问该方法使用 DELETE:
访问成功,但是删除方法没有携带所要删除数据的id,所以针对RESTful的开发,如何携带数据参数?
传递路径参数
前端发送请求的时候使用:http://localhost/users/1
,路径中的1
就是我们想要传递的参数。
后端获取参数,需要做如下修改:
- 修改@RequestMapping的value属性,将其中修改为
/users/{id}
,目的是和路径匹配 - 在方法的形参前添加@PathVariable注解
1 |
|
思考如下两个问题:
(1)如果方法形参的名称和路径{}
中的值不一致,该怎么办?
(2)如果有多个参数需要传递该如何编写?
前端发送请求的时候使用:http://localhost/users/1/tom
,路径中的1
和tom
就是我们想要传递的两个参数。
后端获取参数,需要做如下修改:
1 |
|
修改
1 |
|
-
将请求路径更改为
/users
- 访问该方法使用 PUT:
http://localhost/users
- 访问该方法使用 PUT:
-
访问并携带参数:
1
2
3
4{
"name":"itcast",
"age":"27"
}
根据ID查询
1 |
|
将请求路径更改为/users
- 访问该方法使用 GET:
http://localhost/users/666
查询所有
1 |
|
将请求路径更改为/users
- 访问该方法使用 GET:
http://localhost/users
小结
RESTful入门案例,我们需要学习的内容如下:
(1)设定Http请求动作(动词)
1 |
(2)设定请求参数(路径变量)
1 |
|
知识点1:@PathVariable
名称 | @PathVariable |
---|---|
类型 | 形参注解 |
位置 | SpringMVC控制器方法形参定义前面 |
作用 | 绑定路径参数与处理器方法形参间的关系,要求路径参数名与形参名一一对应 |
关于接收参数,我们学过三个注解@RequestBody
、@RequestParam
、@PathVariable
,这三个注解之间的区别和应用分别是什么?
- 区别
- @RequestParam用于接收url地址传参或表单传参
- @RequestBody用于接收json数据
- @PathVariable用于接收路径参数,使用{参数名称}描述路径参数
- 应用
- 后期开发中,发送请求参数超过1个时,以json格式为主,@RequestBody应用较广
- 如果发送非json格式数据,选用@RequestParam接收请求参数
- 采用RESTful进行开发,当参数数量较少时,例如1个,可以采用@PathVariable接收请求路径变量,通常用于传递id值
RESTful快速开发
做完了RESTful的开发,你会发现好麻烦,麻烦在哪?
问题1:每个方法的@RequestMapping注解中都定义了访问路径/books,重复性太高。
问题2:每个方法的@RequestMapping注解中都要使用method属性定义请求方式,重复性太高。
问题3:每个方法响应json都需要加上@ResponseBody注解,重复性太高。
对于上面所提的这三个问题,具体该如何解决?
1 | //@Controller + ReponseBody |
对于刚才的问题,我们都有对应的解决方案:
问题1:每个方法的@RequestMapping注解中都定义了访问路径/books,重复性太高。
答:将@RequestMapping提到类上面,用来定义所有方法共同的访问路径。
问题2:每个方法的@RequestMapping注解中都要使用method属性定义请求方式,重复性太高。
答:使用@GetMapping @PostMapping @PutMapping @DeleteMapping代替
问题3:每个方法响应json都需要加上@ResponseBody注解,重复性太高。
答:1.将ResponseBody提到类上面,让所有的方法都有@ResponseBody的功能
2.使用@RestController注解替换@Controller与@ResponseBody注解,简化书写
知识点1:@RestController
名称 | @RestController |
---|---|
类型 | 类注解 |
位置 | 基于SpringMVC的RESTful开发控制器类定义上方 |
作用 | 设置当前控制器类为RESTful风格, 等同于@Controller与@ResponseBody两个注解组合功能 |
知识点2:@GetMapping @PostMapping @PutMapping @DeleteMapping
名称 | @GetMapping @PostMapping @PutMapping @DeleteMapping |
---|---|
类型 | 方法注解 |
位置 | 基于SpringMVC的RESTful开发控制器方法定义上方 |
作用 | 设置当前控制器方法请求访问路径与请求动作,每种对应一个请求动作, 例如@GetMapping对应GET请求 |
相关属性 | value(默认):请求访问路径 |
RESTful案例
需求分析
需求一:图片列表查询,从后台返回数据,将数据展示在页面上
需求二:新增图片,将新增图书的数据传递到后台,并在控制台打印
**说明:**此次案例的重点是在SpringMVC中如何使用RESTful实现前后台交互,所以本案例并没有和数据库进行交互,所有数据使用假
数据来完成开发。
步骤分析:
1.搭建项目导入jar包
2.编写Controller类,提供两个方法,一个用来做列表查询,一个用来做新增
3.在方法上使用RESTful进行路径设置
4.完成请求、参数的接收和结果的响应
5.使用PostMan进行测试
6.将前端页面拷贝到项目中
7.页面发送ajax请求
8.完成页面数据的展示
环境准备
-
创建一个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
<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_07_rest_case</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
30public 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[]{"/"};
}
//乱码处理
protected Filter[] getServletFilters() {
CharacterEncodingFilter filter = new CharacterEncodingFilter();
filter.setEncoding("UTF-8");
return new Filter[]{filter};
}
}
//开启json数据类型自动转换
public class SpringMvcConfig {
} -
编写模型类Book
1
2
3
4
5
6
7public class Book {
private Integer id;
private String type;
private String name;
private String description;
//setter...getter...toString略
} -
编写BookController
1
2
3
4
5
public class BookController {
}
后台接口开发
步骤1:编写Controller类并使用RESTful进行配置
1 |
|
使用PostMan进行测试
测试新增
1 | { |
回到控制台查看输出
1 | book save --> Book{id=null, type=‘计算机丛书’, name=‘SpringMVC终极开发’, description=‘这是一本好书’} |
测试查询
1 | [ |
回到控制台查看输出
1 | book getAll running … |
页面访问处理
步骤1:导入准备好的静态页面
步骤2:访问pages目录下的books.html
打开浏览器输入http://localhost/pages/books.html
报404,为什么呢?
- SpringMVC拦截了静态资源,根据/pages/books.html去controller找对应的方法,找不到所以会报404的错误。
- SpringMvcConfig拦截了所有资源路径
1 | protected String[] getServletMappings() { |
- 解决方案 : SpringMVC需要将静态资源进行放行。
1 |
|
- 该配置类是在config目录下,SpringMVC扫描的是controller包,所以该配置类还未生效,要想生效需要将SpringMvcConfig配置类进行修改
1 |
|
步骤3:修改books.html页面
1 |
|
由于按钮的事件都绑定好了,所以我们重点只关注saveBook()
和getAll()
这两个函数就行
- 当调用
getAll()
函数时,我们需要将响应的JSON数据赋给dataList即可,而响应JSON数据我们在上一小节已经完成了 - 当调用
saveBook()
函数时,发送POST请求,并将formData的数据响应给后台,我们这里的操作只是在控制台输出了一下