文章目录
- 今日目标
- 一、SpringMVC简介
- 二、请求与响应
- 三、REST风格
今日目标
- 能够知道SpringMVC的优点
- 能够编写SpringMVC入门案例
- 能够使用PostMan发送请求
- 能够掌握普通类型参数传递
- 能够掌握POJO类型参数传递
- 能够掌握json数据参数传递
- 能够掌握响应json数据
- 能够掌握rest风格快速开发
- 能够完成基于restful页面数据交互案例
一、SpringMVC简介
1 SpringMVC概述
问题导入
SpringMVC框架有什么优点?
1.1 SpringMVC概述
- SpringMVC是一种基于Java实现MVC模型的轻量级Web框架
- 优点
- 使用简单,开发便捷(相比于Servlet)
- 灵活性强
2 入门案例【重点】
问题导入
在Controller中如何定义访问路径,如何响应数据?
2.1 实现步骤
1 创建web工程(Maven结构)
2 设置tomcat服务器,加载web工程(tomcat插件)
3 导入坐标(SpringMVC+Servlet)
4 定义处理请求的功能类(UserController)
5 编写SpringMVC配置类,加载处理请求的Bean。
6 加载SpringMVC配置,并设置SpringMVC请求拦截的路径
2.2 代码实现
【第一步】创建web工程(Maven结构)
创建的新工程的话可能得修改下maven(老版创建时就让你设置maven)
或者参考这里设置New Project的默认Maven: 4. new Project 默认maven配置
【第二步】设置tomcat服务器,加载web工程(tomcat插件)
<build>
<plugins>
<plugin>
<groupId>org.apache.tomcat.maven</groupId>
<artifactId>tomcat7-maven-plugin</artifactId>
<version>2.1</version>
<configuration>
<port>80</port>
<path>/</path>
</configuration>
</plugin>
</plugins>
</build>
【第三步】导入坐标(SpringMVC+Servlet)
<dependencies>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.2.10.RELEASE</version>
</dependency>
</dependencies>
注意事项:
- 课程版本基于Spring主版本5.2.10.RELEASE制作
- 导入spring-webmvc坐标自动依赖spring相关坐标 (就是说spring-webmvc包含了spring-context)
【第四步】定义处理请求的功能类(UserController)
//定义表现层控制器bean
@Controller
public class UserController {
//设置映射路径为/save,即外部访问路径
@RequestMapping("/save")
//设置当前操作返回结果为指定json数据(本质上是一个字符串信息)
@ResponseBody //设置返回值是数据不是页面
public String save(){
System.out.println("user save ...");
return "{'info':'springmvc'}";
}
}
注意事项:
对于SpringMVC而言,Controller方法返回值默认表示要跳转的页面,没有对应的页面就会报错。如果不想跳转页面而是响应数据,那么就需要在方法上使用@ResponseBody注解。
【第五步】编写SpringMVC配置类,加载处理请求的Bean。
//springmvc配置类,本质上还是一个spring配置类
@Configuration
@ComponentScan("com.itheima.controller")
public class SpringMvcConfig {
}
【第六步】加载SpringMVC配置,并设置SpringMVC请求拦截的路径
基于web3.0纯注解开发,可以删掉 WEB-INF下的web.xml配置文件
但是就需要ServletContainersInitConfig(名称无所谓) 配置类来加载springmvc了
//web容器配置类
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
//加载springmvc配置类,产生springmvc容器(本质还是spring容器)
protected WebApplicationContext createServletApplicationContext() {
//初始化WebApplicationContext对象
AnnotationConfigWebApplicationContext ioc= new AnnotationConfigWebApplicationContext();
//加载指定配置类 【SpringMVC核心配置类】
ioc.register(SpringMvcConfig.class);
return ioc;
}
//设置由springmvc控制器处理的请求映射路径
protected String[] getServletMappings() {
return new String[]{"/"}; //”/“表示 所有的请求 都归SpringMVC管理
}
//加载spring配置类
protected WebApplicationContext createRootApplicationContext() {
return null;
}
}
2.3 运行结果
2.4 案例注解和类解析
2.4.1 @Controller注解
- 名称:@Controller
- 类型:类注解
- 位置:SpringMVC控制器类定义上方
- 作用:设定SpringMVC的核心控制器bean
- 范例
@Controller
public class UserController {
}
2.4.2 @RequestMapping注解
- 名称:@RequestMapping
- 类型:方法注解
- 位置:SpringMVC控制器方法定义上方
- 作用:设置当前控制器方法请求访问路径
- 范例
@RequestMapping("/save")
public void save(){
System.out.println("user save ...");
}
注意:其实@RequestMapping注解还可以写到类上面,笔记后面会介绍到。
2.4.3 @ResponseBody注解
- 名称:@ResponseBody
- 类型:方法注解
- 位置:SpringMVC控制器方法定义上方
- 作用:设置当前控制器方法响应内容为当前返回值,无需解析 (不是返回页面)
- 范例
@RequestMapping("/save")
@ResponseBody
public String save(){
System.out.println("user save ...");
return "{'info':'springmvc'}";
}
2.4.4 AbstractDispatcherServletInitializer类
-
AbstractDispatcherServletInitializer类是SpringMVC提供的快速初始化Web3.0容器的抽象类
-
AbstractDispatcherServletInitializer提供三个接口方法供用户实现
- createServletApplicationContext()方法,创建Servlet容器时,加载SpringMVC对应的bean并放入WebApplicationContext对象范围中,而WebApplicationContext的作用范围为ServletContext范围,即整个web容器范围。
//加载springmvc配置类,产生springmvc容器(本质还是spring容器) protected WebApplicationContext createServletApplicationContext() { AnnotationConfigWebApplicationContext ioc= new AnnotationConfigWebApplicationContext(); // 加载容器 ioc.register(SpringMvcConfig.class); // springMVC的配置加载到容器中 // 上面两行就是加载SpringMVC核心配置文件或类,创建IOC容器 //上面2行类似Spring中的这一行: //AnnotationConfigApplicationContext ioc = new AnnotationConfigApplicationContext(SpringConfig.class); //也就是说当初写spring时也有这些代码,只不过是写在测试类中的 return ioc; }
- getServletMappings()方法,设定SpringMVC对应的请求映射路径,设置为/表示拦截所有请求,任意请求都将转入到SpringMVC进行处理。
//设置由springmvc控制器处理的请求映射路径 protected String[] getServletMappings() { return new String[]{"/"}; }
- createRootApplicationContext()方法,如果创建Servlet容器时需要加载非SpringMVC对应的bean,使用当前方法进行,使用方式同createServletApplicationContext()
//加载spring配置类 protected WebApplicationContext createRootApplicationContext() { return null; }
2.5 入门程序开发总结(1+N)
- 一次性工作
- 创建工程,设置服务器,加载工程
- 导入坐标
- 创建web容器启动类,加载SpringMVC配置,并设置SpringMVC请求拦截路径
- SpringMVC核心配置类(设置配置类,扫描controller包,加载Controller控制器bean)
- 多次工作
- 定义处理请求的控制器类
- 定义处理请求的控制器方法,并配置映射路径(@RequestMapping)与返回json数据(@ResponseBody)
3 入门案例工作流程分析【理解】
3.1 启动服务器初始化过程
- 服务器启动,执行ServletContainersInitConfig类,初始化web容器
- 执行createServletApplicationContext方法,创建了WebApplicationContext对象
- 加载SpringMvcConfig配置类
- 执行@ComponentScan加载对应的bean
- 加载UserController,每个@RequestMapping的名称对应一个具体的方法(扫描所有的@RequestMapping注解,注册所有的请求路径,这个时候就将路径和对应的方法绑定到一起了,而且是集中管理的)
- 执行getServletMappings方法,定义所有的请求都通过SpringMVC
3.2 单次请求过程
- 发送请求localhost/save
- web容器发现所有请求都经过SpringMVC,将请求交给SpringMVC处理
- 解析请求路径/save
- 由/save匹配执行对应的方法save()
- 执行save()
- 检测到有@ResponseBody直接将save()方法的返回值作为响应体返回给请求方
4 Controller加载控制
问题导入
因为功能不同,如何避免Spring错误的加载到SpringMVC的bean?
spring应该加载管理service和dao的bean
springMVC应该加载管理controller的bean
4.1 Controller加载控制与业务bean加载控制
-
SpringMVC相关bean(表现层bean)
-
Spring控制的bean
-
业务bean(Service)
-
功能bean(DataSource等)
-
-
SpringMVC相关bean加载控制
- SpringMVC加载的bean对应的包均在cn.whu.controller包内
-
Spring相关bean加载控制
- 方式一:Spring加载的bean设定扫描范围为cn.whu,排除掉controller包内的bean
- 方式二:Spring加载的bean设定扫描范围为精准范围,例如service包、dao包等 (最常用的方式)
- 方式三:不区分Spring与SpringMVC的环境,加载到同一个环境中
4.2 方式一代码实现
环境准备:
将上面的入门案例复制一份,稍作修改
pom.xml
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>cn.whu</groupId>
<artifactId>springmvc_02_bean_load</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<!-- 必须加,否则会打包到war里导致运行时和tomcat自带的servlet冲突 -->
<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>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.26</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>
USE spring_db;
CREATE TABLE tbl_user(
id INT PRIMARY KEY AUTO_INCREMENT,
name VARCHAR(255),
age INT
);
domain.User
@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class User {
private Integer id;
private String name;
private Integer age;
}
UserDao
public interface UserDao {
@Insert("insert into tbl_user(name, age) values(#{name},#{age})")
void save(User user);
}
UserService
public interface UserService {
public void save(User user);
}
UserServiceImpl
public class UserServiceImpl implements UserService {
public void save(User user) {
System.out.println("user service ...");
}
}
- 名称:@ComponentScan
- 类型:类注解
- 范例
方式1:
@Configuration
@ComponentScan({"cn.whu.service","cn.whu.dao"})
public class SpringConfig {
}
方式2:
@Configuration
@ComponentScan(value = "cn.whu", //我要扫描 cn.whu包下所有Bean
excludeFilters = @ComponentScan.Filter( // 但是我要排除一些
type = FilterType.ANNOTATION, // 我要按照注解排除
classes = Controller.class // 被 @Controller 注解标注的 我都排除
)
)
public class SpringConfig {
}
- 属性
- excludeFilters:排除扫描路径中加载的bean,需要指定类别(type)与具体项(classes)
- includeFilters:加载指定的bean,需要指定类别(type)与具体项(classes)
- 测试:
测试的时候需要注掉SpringMvcConfig上的@Configuration或者@ComponentScan(“cn.whu.controller”)任意一个,eg:
因为Spring配置的是cn.whu包下所有,仅仅排除controller, SpringMvcConfig也在cn.whu包下,万一成了配置类,下面的@ComponentScan(“cn.whu.controller”)会工作再次扫描从而又加上了controller。
public class App {
public static void main(String[] args) {
/*AnnotationConfigApplicationContext ioc = new AnnotationConfigApplicationContext();
ioc.register(SpringConfig.class);*/ //两行可以合并为下面一行
AnnotationConfigApplicationContext ioc = new AnnotationConfigApplicationContext(SpringConfig.class);
UserService service = ioc.getBean(UserService.class);
System.out.println(service);
UserController controller = ioc.getBean(UserController.class);
System.out.println(controller);
}
}
果然能拿到service但是拿不到controller
4.3 Bean的加载格式
方式三:不区分Spring与SpringMVC的环境,加载到同一个环境中
config.ServletContainersInitConfig
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
// 对应xml开发中: 加载springMVC核心配置文件
protected WebApplicationContext createServletApplicationContext() {
AnnotationConfigWebApplicationContext ioc= new AnnotationConfigWebApplicationContext();
ioc.register(SpringMvcConfig.class);//就是加载核心配置文件或者核心配置类 创建IOC容器
return ioc;
}
// 对应xml开发中: 加载spring核心配置文件
protected WebApplicationContext createRootApplicationContext() {
// 本来这里只有一行 return null.
// 现在这里是Spring环境 上面是SpringMVC环境
AnnotationConfigWebApplicationContext ioc= new AnnotationConfigWebApplicationContext();
ioc.register(SpringConfig.class);// 加载spring核心配置 也就是加载spring环境
return ioc;
}
protected String[] getServletMappings() {
return new String[]{"/"};
}
}
简化格式
继承成另一个子抽象类,功能更强大
// 这个类是tomcat自动加载的 应该是按照类型找的吧
// 对应成 web.xml即可 (找实现类)
public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
// 对应xml开发: 加载Spring核心配置文件
protected Class<?>[] getRootConfigClasses() {
return new Class[]{SpringConfig.class};
}
// 对应xml开发: 加载SpringMVC核心配置文件
protected Class<?>[] getServletConfigClasses() {
return new Class[]{SpringMvcConfig.class};
}
// 配置SpringMVC拦截所有路径
protected String[] getServletMappings() {
return new String[]{"/"};
}
}
5 PostMan【掌握】
PostMan:邮差
5.1 PostMan介绍
- Postman是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件
- 作用:常用于进行接口测试
- 特征
- 简单
- 实用
- 美观
- 大方
5.2 PostMan安装
双击资料中的“Postman-win64-8.3.1-Setup.exe”即可自动按照,打开之后需要注册,如果底部有如下链接,可以点击跳过注册
注册一下,好像要科学上网。注册和登录都跳转到浏览器端完成,登录完再切换回桌面程序即可。
5.3 PostMan的使用
5.3.1 创建WorkSpace工作空间
点击左上角的home进入主页,然后
5.3.2 发送请求获取json数据
5.3.3 保存当前请求
注意:第一次请求需要创建一个新的目录,后面就不需要创建新目录,直接保存到已经创建好的目录即可。
二、请求与响应
环境准备:
创建好缺失的目录结构:
pom.xml
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>cn.whu</groupId>
<artifactId>springmvc_03_request_mapping</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
<!-- springMVC和spring都有 -->
<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>
初始代码:
ServletContainersInitConfig
public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
// Spring核心配置文件 但是这里用不着Spring
protected Class<?>[] getRootConfigClasses() {
return new Class[0];
}
// SpringMVC核心配置文件(SpringMVC的Controller就是我们的Servlet嘛)
protected Class<?>[] getServletConfigClasses() {
return new Class[]{SpringMvcConfig.class};
}
//配置SpringMVC拦截所有路径
protected String[] getServletMappings() {
return new String[]{"/"};
}
}
SpringMvcConfig
@Configuration
@ComponentScan("cn.whu.controller")
public class SpringMvcConfig {
}
BookController
@Controller
public class BookController {
@RequestMapping("/save")
@ResponseBody
public String save(){
System.out.println("book save ...");
return "{'module':'book save'}";
}
}
UserController
@Controller
public class UserController {
@RequestMapping("/save")
@ResponseBody
public String save(){
System.out.println("user save ...");
return "{'module':'user save'}";
}
@RequestMapping("/delete")
@ResponseBody
public String delete(){
System.out.println("user delete ...");
return "{'module':'user delete'}";
}
}
很明显,有两个完全相同的"/save"路径,启动服务器报错实属正常
类上面肯定还要@RequestMapping(“/xxx”)来区分下的。看下面吧
1 请求映射路径【重点】
问题导入
@RequestMapping注解注解可以写在哪?有什么作用?
1.1 @RequestMapping注解
- 名称:@RequestMapping
- 类型:方法注解 类注解
- 位置:SpringMVC控制器方法定义上方
- 作用:设置当前控制器方法请求访问路径,如果设置在类上统一设置当前控制器方法请求访问路径前缀
- 范例
@Controller
//类上方配置的请求映射与方法上面配置的请求映射连接在一起,形成完整的请求映射路径
@RequestMapping("/user")
public class UserController {
//请求路径映射
@RequestMapping("/save") //此时save方法的访问路径是:/user/save
@ResponseBody
public String save(){
System.out.println("user save ...");
return "{'module':'user save'}";
}
}
PostMan发送请求: (Ctrl+‘+/=’ 可以调大界面字体)
2 请求参数
2.0 环境准备
将上面得springmvc_03_request_mapping直接复制一份改名为springmvc_04_request_param,注意pom.xml里也要改: <artifactId>springmvc_04_request_param</artifactId>
,然后稍作修改
(红框框出来的都是有修改的)
- pom.xml里加上lombok
- UserController
@Controller
// 只有一个Controller就先不写前缀啦
public class UserController {
@RequestMapping("/commonParam")
@ResponseBody
public String commonParam(){
return "{'module':'common param'}";
}
}
- Address
@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class Address {
private String province;
private String city;
}
- User
@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class User {
private String name;
private int age;
private Address address;
}
2.1 发送普通类型参数【重点】
问题导入
如何解决POST请求中文乱码问题?
2.1.1 请求方式
- GET请求
- POST请求
2.1.2 GET请求传递普通参数
- 普通参数:url地址传参,地址参数名与形参变量名相同,定义形参即可接收参数
普通参数直接写在方法的形参里即可获取,类型写自己想要的类型,springMVC会自动帮你进行String->其他各种类型的转换
//普通参数:请求参数与形参名称对应即可完成参数传递
@RequestMapping("/commonParam")
@ResponseBody
public String commonParam(String name,Integer age){//直接写在参数里,即可接收浏览器发送的参数
System.out.println(name);
System.out.println(age+" "+age.getClass());//甚至类型转换都帮你自动弄好了
return "{'module':'common param'}";
}
- 问题:如果同学们传递的参数是中文试试,你们会发现接收到的参数出现了中文乱码问题。
- 原因:tomcat 8.5版本之后GET请求就不再出现中文乱码问题,但是我们使用的是tomcat7插件,所以会出现GET请求中文乱码问题。
- 解决:在pom.xml添加tomcat7插件处配置UTF-8字符集,解决GET请求中文乱码问题。
<build>
<plugins>
<plugin>
<groupId>org.apache.tomcat.maven</groupId>
<artifactId>tomcat7-maven-plugin</artifactId>
<version>2.1</version>
<configuration>
<port>80</port><!--tomcat端口号-->
<path>/</path> <!--虚拟目录-->
<uriEncoding>UTF-8</uriEncoding><!--访问路径编解码字符集-->
</configuration>
</plugin>
</plugins>
</build>
2.1.3 POST请求传递普通参数
- 普通参数:form表单post请求传参,表单参数名与形参变量名相同,定义形参即可接收参数
后台代码没有任何变化
//普通参数:请求参数与形参名称对应即可完成参数传递
@RequestMapping("/commonParam")
@ResponseBody
public String commonParam(String name,Integer age){//直接写在参数里,即可接收浏览器发送的参数
System.out.println(name);
System.out.println(age+" "+age.getClass());//甚至类型转换都帮你自动弄好了
return "{'module':'common param'}";
}
问题:我们发现,POST请求传递的参数如果包含中文那么就会出现中文乱码问题,说明我们之前配置的tomcat插件uri路径编解码字符集无法解决POST请求中文乱码问题。那么如何解决呢?
2.1.4 POST请求中文乱码处理
在加载SpringMVC配置的配置类中指定字符过滤器。
public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
protected Class<?>[] getRootConfigClasses() {
return new Class[0];
}
protected Class<?>[] getServletConfigClasses() {
return new Class[]{SpringMvcConfig.class};
}
protected String[] getServletMappings() {
return new String[]{"/"};
}
//Post请求乱码处理
@Override //本质也是过滤器 (这里写新的方法,就相当于xml中写新的配置)
protected Filter[] getServletFilters() {
//可以自己写过滤器Filter,但是SpringMVC肯定有内置写好的
CharacterEncodingFilter filter = new CharacterEncodingFilter();
filter.setEncoding("utf-8");
return new Filter[]{filter};
}
}
2.2 五种类型参数传递
问题导入
当请求参数名与形参变量名不同,该如何接收请求参数?
2.2.1 五种类型参数介绍
- 普通参数
- POJO类型参数
- 嵌套POJO类型参数
- 数组类型参数
- 集合类型参数
2.2.2 普通参数【重点】
- 普通参数:当请求参数名与形参变量名不同,使用@RequestParam绑定参数关系
//普通参数:请求参数名与形参名不同时,
@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'}";
}
使用@RequestParam注解关联请求参数名称与形参名称之间的关系
// 普通参数:请求参数名与形参名不同时,使用@RequestParam注解关联请求参数名称与形参名称之间的关系
@RequestMapping("/commonParamDifferentName")
@ResponseBody
public String commonParamDifferentName(@RequestParam("name") String userName, int age){
System.out.println("普通参数传递 userName => "+ userName);
System.out.println("普通参数传递 age => "+age);
return "{'module':'common param different name'}";
}
- 名称:@RequestParam
- 类型:形参注解
- 位置:SpringMVC控制器方法形参定义前面
- 作用:绑定请求参数与处理器方法形参间的关系
- 参数:
- required:是否为必传参数
- defaultValue:参数默认值
2.2.3 POJO类型参数【重点】
- POJO参数:请求参数名与形参对象属性名相同,定义POJO类型形参即可接收参数
@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class User {
private String name;
private int age;
private Address address;
}
//POJO参数:请求参数与形参对象中的属性对应即可完成参数传递
@RequestMapping("/pojoParam")
@ResponseBody
public String pojoParam(User user){
System.out.println("pojo参数传递: user => "+user);
return "{'module':'pojo param'}";
}
注意事项:请求参数key的名称要和POJO中属性的名称一致,否则无法封装。
2.2.4 嵌套POJO类型参数
- POJO对象中包含POJO对象
@Data
@ToString
public class User {
private String name;
private int age;
private Address address;
}
@Data
@ToString
public class Address {
private String province;
private String city;
}
- 嵌套POJO参数:请求参数名与形参对象属性名相同,按照对象层次结构关系即可接收嵌套POJO属性参数
//嵌套POJO参数:嵌套属性按照层次结构设定名称即可完成参数传递
@RequestMapping("/pojoContainPojoParam")
@ResponseBody
public String pojoContainPojoParam(User user){
System.out.println("pojo嵌套pojo参数传递: "+user);
return "{'module':'pojo contain pojo param'}";
}
注意事项:请求参数key的名称要和POJO中属性的名称一致,否则无法封装。
2.2.5 数组类型参数
- 数组参数:请求参数名与形参对象属性名相同且请求参数为多个,定义数组类型即可接收参数
//数组参数:同名请求参数可以直接映射到对应名称的形参数组对象中
// 很简单: 写个对应名称的数组参数即可
@RequestMapping("/arraysParam")
@ResponseBody
public String arraysParam(String[] hobbies){
System.out.println(Arrays.toString(hobbies));
return "{'module':'arrays Param'}";
}
相同的名称以数组格式传递参数(不就是复选框嘛)
2.2.6 集合类型参数
- 集合保存普通参数:请求参数名与形参集合对象名相同且请求参数为多个,@RequestParam绑定参数关系
//集合参数:同名请求参数可以使用@RequestParam注解映射到对应名称的集合对象中作为数据
@RequestMapping("/listParam")
@ResponseBody
public String listParam(@RequestParam List<String> hobbies){
System.out.println("集合参数传递:" + hobbies);
return "{'module':'list Param'}";
}
注意必须在参数前写@RequestParam,否则一发现List是引用类型,框架会调用构造方法先创建对象,然后将参数都当做其属性set进去,也就是所有的引用类型默认按照pojo类型去干。很明显List参数不是这个意思
加上@RequestParam,就是告诉框架,参数一个个给我放到集合中就行了
- 小结:
正常名称对名称就OK了,名称对不上咋办?@RequestParam 绑定关系
2.3 json数据参数传递
问题导入
问题:@EnableWebMvc注解和@ResponseBody注解有什么用?
2.3.1 json数据参数介绍
- json普通数组([“”,“”,“”,…])
- json对象({key:value,key:value,…})
- json对象数组([{key:value,…},{key:value,…}])
2.3.2 传递json普通数组
2.3.2.1 代码演示
- 添加json数据转换相关坐标 pom.xml
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.0</version>
</dependency>
看名字就知道:json数据绑定。自动帮你调用fastjson,将json自动转换为pojo
- 开启自动转换json数据的支持
SpringMvcConfig 核心配置文件里加一行注解@EnableWebMvc
SpringMVC就会将前端传送过来的json自动转换成对应的类型了
tip: @EnableWebMvc 功能强大,远不止封装json这一个
@Configuration
@ComponentScan("cn.whu.controller")
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMvcConfig {
}
- 设置发送json数据(请求body中添加json数据)
注意事项:
@EnableWebMvc注解功能强大,该注解整合了多个功能,此处仅使用其中一部分功能,即json数据进行自动类型转换
- 在Controller中编写方法接收json参数
//集合参数:json格式
//1.开启json数据格式的自动转换,在配置类中开启@EnableWebMvc
//2.使用@RequestBody注解将外部传递的json数组数据映射到形参的集合对象中作为数据
@RequestMapping("/listParamForJson")
@ResponseBody //注意@RequestParam不行了,json数据在请求体中,得用@RequestBody
public String listParamForJson(@RequestBody List<String> hobbies){
System.out.println("list集合 json 参数传递:" +hobbies);
return "{'module':'list common for json Param'}";
}
2.3.2.2 @EnableWebMvc注解介绍
- 名称:@EnableWebMvc
- 类型:配置类注解
- 位置:SpringMVC配置类定义上方
- 作用:开启SpringMVC多项辅助功能
- 范例:
@Configuration
@ComponentScan("cn.whu.controller")
@EnableWebMvc
public class SpringMvcConfig {
}
2.3.2.3 @RequestBody注解介绍
- 名称:@RequestBody
- 类型:形参注解
- 位置:SpringMVC控制器方法形参定义前面
- 作用:将请求中请求体所包含的数据传递给请求参数,此注解一个处理器方法只能使用一次
- 范例:
@RequestMapping("/listParamForJson")
@ResponseBody
public String listParamForJson(@RequestBody List<String> likes){
System.out.println("list common(json)参数传递 list ==> "+likes);
return "{'module':'list common for json param'}";
}
2.3.3 传递json对象
- POJO参数:json数据与形参对象属性名相同,定义POJO类型形参即可接收参数
参数前还是得加@RequestBody 不然封装不上(没办法,json都在请求体中, 必须都注明一下)
//POJO参数:json格式
//1.开启json数据格式的自动转换,在配置类中开启@EnableWebMvc
//2.使用@RequestBody注解将外部传递的json数据映射到形参的实体类对象中,要求属性名称一一对应
//POJO参数: json格式
@RequestMapping("/pojoParamForJson")
@ResponseBody
public String pojoParamForJson(@RequestBody User user){//@RequestBody 还是得加
System.out.println("pojo json 参数传递: user => "+user);
return "{'module':'pojo json param'}";
}
不妨把address也加上,反正,json简单
2.3.4 传递json对象数组
- POJO集合参数:json数组数据与集合泛型属性名相同,定义List类型形参即可接收参数
//集合参数:json格式
//1.开启json数据格式的自动转换,在配置类中开启@EnableWebMvc
//2.使用@RequestBody注解将外部传递的json数组数据映射到形参的保存实体类对象的集合对象中,要求属性名称一一对应
//集合参数: json格式 元素为pojo
@RequestMapping("/listPojoParamForJson")
@ResponseBody
public String listPojoParamForJson(@RequestBody List<User> list){
System.out.println("pojo集合-json参数:" +list);
return "{'module':'list pojo json Param'}";
}
写多了就简单了,就是直接写类型,然后json格式要多加个注解@RequestBody (配置文件里先开注解)
2.3.5 @RequestBody与@RequestParam区别
- 区别
@RequestParam用于接收url地址传参,表单传参【application/x-www-form-urlencoded】
@RequestBody用于接收json数据【application/json】 - 应用
后期开发中,发送json格式数据为主,@RequestBody应用较广
如果发送非json格式数据,选用@RequestParam接收请求参数
3 日期类型参数传递【重点】
问题导入
@DateTimeFormat注解的作用是什么?
3.1 代码演示
- 日期类型数据基于系统不同格式也不尽相同
2088-08-18
2088/08/18
08/18/2088 - 接收形参时,根据不同的日期格式设置不同的接收方式
//日期参数 http://localhost:80/dataParam?date=2088/08/08&date1=2088-08-18&date2=2088/08/28 8:08:08
//使用@DateTimeFormat注解设置日期类型数据格式,默认格式yyyy/MM/dd
@RequestMapping("/dataParam")
@ResponseBody
public String dataParam(Date date,
@DateTimeFormat(pattern = "yyyy-MM-dd") Date date1,
@DateTimeFormat(pattern = "yyyy/MM/dd HH:mm:ss") Date date2){
System.out.println("日期参数传递 date: "+date);
System.out.println("日期参数传递 date1 (yyyy-MM-dd): "+date1);
System.out.println("日期参数传递 date2 (yyyy/MM/dd HH:mm:ss): "+date2);
return "{'module':'data Param'}";
}
3.2 @DateTimeFormat注解介绍
-
名称:@DateTimeFormat
-
类型:形参注解
-
位置:SpringMVC控制器方法形参前面
-
作用:设定日期时间型数据格式
-
属性:pattern:指定日期时间格式字符串
3.3 工作原理
- 其内部依赖Converter接口
public interface Converter<S, T> {
@Nullable
T convert(S var1);
}
- 请求参数年龄数据(String→Integer)
- json数据转对象(json → POJO)
- 日期格式转换(String → Date)
3.4 注意事项
传递日期类型参数必须在配置类上使用@EnableWebMvc注解。其功能之一:根据类型匹配对应的类型转换器。
4 响应
注意:需要添加jackson-databind依赖以及在SpringMvcConfig配置类上添加@EnableWebMvc注解
问题导入
如何响应json数据?
4.0 环境准备
新环境了,将上面的springmvc_04_request_param复制一份改名springmvc_05_response
删掉domain下的Address,只留下User就行了
index.jsp改成page.jsp
<html>
<body>
<h2>Hello Spring MVC!</h2>
</body>
</html>
然后UserController里处理器方法全部删掉,待会儿写全新的
4.1响应页面【了解】
@Controller
public class UserController {
//响应页面/跳转页面
//返回值为String类型,设置返回值为页面名称,即可实现页面跳转
@RequestMapping("/toJumpPage")
public String toJumpPage(){
System.out.println("跳转页面");
return "page.jsp";
}
}
4.2 文本数据【了解】
//响应文本数据
//返回值为String类型,设置返回值为任意字符串信息,即可实现返回指定字符串信息,需要依赖@ResponseBody注解
@RequestMapping("/toText")
@ResponseBody
public String toTest(){
System.out.println("返回(响应)纯文本数据");
return "response text";
}
4.3 json数据【重点】
4.3.1 pojo json数据
@ResponseBody注解后,直接返回User对象即可。(牛)
//响应POJO对象
//返回值为实体类对象,设置返回值为实体类类型,即可实现返回对应对象的json数据,需要依赖@ResponseBody注解和@EnableWebMvc注解
@RequestMapping("/toJsonPOJO")
@ResponseBody //返回数据不是页面
public User toJsonPOJO(){
User user = new User();
user.setName("whu");
user.setAge(130);
return user; //直接返回pojo即可 自动转json串给前端
}
POJO转json不算SpringMVC做的,而是jackson-databind做的
4.3.1 List<Pojo> json数据
没什么特别的 直接返回即可 (注解还是@ResponseBody)
//响应POJO集合对象
//返回值为集合对象,设置返回值为集合类型,即可实现返回对应集合的json数组数据,需要依赖@ResponseBody注解和@EnableWebMvc注解
@RequestMapping("/toJsonList")
@ResponseBody
public List<User> toJsonList(){
System.out.println("返回json集合数据");
User user1 = new User();
user1.setName("传智播客");
user1.setAge(15);
User user2 = new User();
user2.setName("黑马程序员");
user2.setAge(12);
List<User> userList = new ArrayList<User>();
userList.add(user1);
userList.add(user2);
return userList;
}
注意:需要添加jackson-databind依赖以及在SpringMvcConfig配置类上添加@EnableWebMvc注解
三、REST风格
1 REST简介
问题导入
Rest风格使用了几种请求方式定义访问行为?
1.1 REST介绍
- REST(Representational State Transfer),表现形式状态转换
(简单理解就是访问网络资源的格式)- 传统风格资源描述形式
http://localhost/user/getById?id=1
http://localhost/user/saveUser - REST风格描述形式
http://localhost/user/1 (= http://localhost/user/getById?id=1)
http://localhost/user ( = http://localhost/user/saveUser)
- 传统风格资源描述形式
- 优点:
- 隐藏资源的访问行为,无法通过地址得知对资源是何种操作
- 书写简化
1.2 RESTful介绍
- 按照REST风格访问资源时使用行为动作区分对资源进行了何种操作
http://localhost/users 查询全部用户信息 (查询)
http://localhost/users/1 查询指定用户信息(查询)
http://localhost/users 添加用户信息(新增/保存)
http://localhost/users 修改用户信息(修改/更新)
http://localhost/users/1 删除用户信息(删除) - 根据REST风格对资源进行访问称为RESTful
请求Method不止有GET和POST,还有好多,这里出现了另外两个常用的:PUT、DELETE
SpringMVC共支持8种提交方式:
1.3 注意事项
- 上述行为是约定方式,约定不是规范,可以打破,所以称REST风格,而不是REST规范
- 描述模块的名称通常使用复数,也就是加s的格式描述,表示此类资源,而非单个资源,例如:users、books、accounts……
2 RESTful入门案例
问题导入
Rest风格如何通过路径传递参数?
2.0 环境准备
上面的module:springmvc_05_response复制一份为springmvc_06_rest
其中 Book
@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class Book {
private String name;
private double price;
}
UserController 初始为这样:也就是非RESTful风格
@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 update'}";
}
@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 update'}";
}
@RequestMapping("/getAll")
@ResponseBody
public String getAll(){
System.out.println("user getAll...");
return "{'module':'user getAll'}";
}
}
下面的学习任务就是将上面那些方法改成RESTful风格
2.1 快速入门
做法:在Controller中定义方法时设定"http请求动作(请求方式)“和"设定请求参数(路径变量)”
@Controller
public class UserController {
//设置当前请求方法为POST,表示REST风格中的添加操作
@RequestMapping(value = "/users",method = RequestMethod.POST)
@ResponseBody
public String save(){
System.out.println("user save...");
return "{'module':'user save'}";
}
//设置当前请求方法为DELETE,表示REST风格中的删除操作
//@PathVariable注解用于设置路径变量(路径参数),要求路径上设置对应的占位符,并且占位符名称与方法形参名称相同
@RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
@ResponseBody
public String delete(@PathVariable Integer id){
System.out.println("user delete..." + id);
return "{'module':'user delete'}";
}
//设置当前请求方法为PUT,表示REST风格中的修改操作
@RequestMapping(value = "/users",method = RequestMethod.PUT)
@ResponseBody
public String update(@RequestBody User user){
System.out.println("user update..."+user);
return "{'module':'user update'}";
}
//设置当前请求方法为GET,表示REST风格中的查询操作
//@PathVariable注解用于设置路径变量(路径参数),要求路径上设置对应的占位符,并且占位符名称与方法形参名称相同
@RequestMapping(value = "/users/{id}" ,method = RequestMethod.GET)
@ResponseBody
public String getById(@PathVariable Integer id){
System.out.println("user getById..."+id);
return "{'module':'user getById'}";
}
//设置当前请求方法为GET,表示REST风格中的查询操作
@RequestMapping(value = "/users",method = RequestMethod.GET)
@ResponseBody
public String getAll(){
System.out.println("user getAll...");
return "{'module':'user getAll'}";
}
}
-
save
//设置当前请求方法为POST,表示REST风格中的添加操作 @RequestMapping(value = "/users",method = RequestMethod.POST) @ResponseBody public String save(){ System.out.println("user save..."); return "{'module':'user save'}"; }
-
delete
//设置当前请求方法为DELETE,表示REST风格中的删除操作 //@PathVariable注解用于设置路径变量(路径参数),要求路径上设置对应的占位符,并且占位符名称与方法形参名称相同 @RequestMapping(value = "/users/{id}", method = RequestMethod.DELETE) @ResponseBody // 路径变量 二者得配合着用 public String delete(@PathVariable Integer id) { // /users/1的形式给出id值 System.out.println("user delete... " + id); return "{'module':'user delete'}"; }
-
update
//设置当前请求方法为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'}"; }
-
getById
//设置当前请求方法为GET,表示REST风格中的查询操作 //@PathVariable注解用于设置路径变量(路径参数),要求路径上设置对应的占位符,并且占位符名称与方法形参名称相同 @RequestMapping(value = "/users/{id}" ,method = RequestMethod.GET) @ResponseBody public String getById(@PathVariable Integer id){ System.out.println("user getById..."+id); return "{'module':'user getById'}"; }
-
getAll
//设置当前请求方法为GET,表示REST风格中的查询操作 @RequestMapping(value = "/users",method = RequestMethod.GET) @ResponseBody public String getAll(){ System.out.println("user getAll..."); return "{'module':'user getAll'}"; }
2.2 @PathVariable介绍
- 名称:@PathVariable
- 类型:形参注解
- 位置:SpringMVC控制器方法形参定义前面
- 作用:绑定路径参数与处理器方法形参间的关系,要求路径参数名与形参名一一对应
2.3 @RequestBody、@RequestParam、@PathVariable区别和应用
- 区别
@RequestParam用于接收url地址传参或表单传参
@RequestBody用于接收json数据
@PathVariable用于接收路径参数,使用{参数名称}描述路径参数 - 应用
后期开发中,发送请求参数超过1个时,以json格式为主,@RequestBody应用较广
如果发送非json格式数据,选用@RequestParam接收请求参数
采用RESTful进行开发,当参数数量较少时,例如1个,可以采用@PathVariable接收请求路径变量,通常用于传递id值
3 REST快速开发【重点】
3.0 初始环境
还是上面那个module,不过这次在BookController里面写了
BookController 初始这样 (学习任务就是在此基础上进行简化)
@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 deleteById, id = " + 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 = "+ id);
return "{'module':'book getById'}";
}
@RequestMapping(value = "/books",method = RequestMethod.GET)
@ResponseBody
public String getAll(){
System.out.println("book getAll ");
return "{'module':'book getAll'}";
}
}
3.1 代码中的问题
以上截图中的代码和我们之前写的UserController中的方法类似,其中图中两个方法都有三处是有问题的,可以进行优化。存在的问题如下:
问题1:每个方法的@RequestMapping注解中都定义了访问路径/books,重复性太高。
问题2:每个方法的@RequestMapping注解中都要使用method属性定义请求方式,重复性太高。
问题3:每个方法响应json都需要加上@ResponseBody注解,重复性太高。
3.2 Rest快速开发
解决以上三个问题
解决问题1:在Controller类上使用@RequestMapping定义共同的访问路径。
类上写注解
@RequestMapping("/books")
下面所有的value="/books"
value属性都可以省略了
但是value="/books/{id}"
还得写成value="/{id}"
value属性暂时省不掉
@Controller
@RequestMapping("/books")
public class BookController1 {
@RequestMapping(method = RequestMethod.POST)
@ResponseBody
public String save(@RequestBody Book book){
System.out.println("book save ... " + book);
return "{'module':'book save'}";
}
@RequestMapping(value = "/{id}",method = RequestMethod.DELETE)
@ResponseBody
public String delete(@PathVariable Integer id){
System.out.println("book deleteById, id = " + id);
return "{'module':'book delete'}";
}
@RequestMapping(method = RequestMethod.PUT)
@ResponseBody
public String update(@RequestBody Book book){
System.out.println("book update ... " + book);
return "{'module':'book update'}";
}
@RequestMapping(value = "/{id}",method = RequestMethod.GET)
@ResponseBody
public String getById(@PathVariable Integer id){
System.out.println("book getById id = "+ id);
return "{'module':'book getById'}";
}
@RequestMapping(method = RequestMethod.GET)
@ResponseBody
public String getAll(){
System.out.println("book getAll ");
return "{'module':'book getAll'}";
}
}
解决问题2:每个方法都有@ResponseBody
,直接写到类上,然后合二为一: @RestController
@ResponseBody
每个都有,直接写类上,下面方法就都不用写了
这样类上面有了两个注解@Controller
和@ResponseBody
,他们两又可以合二为一:@RestController
简言之:@RestController
=@Controller
+@ResponseBody
+ “一些无关紧要的”
@RestController
@RequestMapping("/books")
public class BookController {
@RequestMapping(method = RequestMethod.POST)
public String save(@RequestBody Book book){
System.out.println("book save ... " + book);
return "{'module':'book save'}";
}
@RequestMapping(value = "/{id}",method = RequestMethod.DELETE)
public String delete(@PathVariable Integer id){
System.out.println("book deleteById, id = " + id);
return "{'module':'book delete'}";
}
@RequestMapping(method = RequestMethod.PUT)
public String update(@RequestBody Book book){
System.out.println("book update ... " + book);
return "{'module':'book update'}";
}
@RequestMapping(value = "/{id}",method = RequestMethod.GET)
public String getById(@PathVariable Integer id){
System.out.println("book getById id = "+ id);
return "{'module':'book getById'}";
}
@RequestMapping(method = RequestMethod.GET)
public String getAll(){
System.out.println("book getAll ");
return "{'module':'book getAll'}";
}
}
解决问题3:使用@GetMapping @PostMapping @PutMapping @DeleteMapping代替@RequestMapping(method=RequestMethod.XXX)
@RestController
@RequestMapping("/books")
public class BookController4 {
//@RequestMapping(method = RequestMethod.POST)
@PostMapping //和上面写法等价 [使用@PostMapping简化Post请求方法对应的映射配置]
public String save(@RequestBody Book book){
System.out.println("book save ... " + book);
return "{'module':'book save'}";
}
//@RequestMapping(value = "/{id}",method = RequestMethod.DELETE)
@DeleteMapping("/{id}")
public String delete(@PathVariable Integer id){
System.out.println("book deleteById, id = " + 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 = "+ id);
return "{'module':'book getById'}";
}
//@RequestMapping(method = RequestMethod.GET)
@GetMapping
public String getAll(){
System.out.println("book getAll ");
return "{'module':'book getAll'}";
}
}
- 名称:@GetMapping @PostMapping @PutMapping @DeleteMapping
- 类型:方法注解
- 位置:基于SpringMVC的RESTful开发控制器方法定义上方
- 作用:设置当前控制器方法请求访问路径与请求动作,每种对应一个请求动作,例如@GetMapping对应GET请求
- 属性:
value(默认):请求访问路径
重新一一访问:
都能正常访问,真不错
(重复了 但是舍不得删)
注:在Controller类上使用@RestController注解,等同于@Controller与@ResponseBody两个注解组合功能
@RestController //使用@RestController注解替换@Controller与@ResponseBody注解,简化书写
@RequestMapping("/books")
public class BookController {
//方法省略了没写
}
- 名称:@RestController
- 类型:类注解
- 位置:基于SpringMVC的RESTful开发控制器类定义上方
- 作用:设置当前控制器类为RESTful风格,等同于@Controller与@ResponseBody两个注解组合功能
4案例:基于RESTful页面数据交互
4.1 案例效果和环境准备
4.1.1 案例效果
4.1.2 环境准备
新建module
创建好初始目录环境,以及一些java文件
再将静态页面复制到webapp目录下
链接:https://pan.baidu.com/s/14we41oJ3c8-HmX2JcaQLPw
提取码:w0i2
pom.xml
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>cn.whu</groupId>
<artifactId>springmvc_07_rest_case</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
<!-- springMVC和spring都有 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.2.10.RELEASE</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.26</version>
</dependency>
<!-- json数据绑定 依赖 (自动帮你将json封装好到pojo) -->
<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>
<uriEncoding>UTF-8</uriEncoding><!--访问路径编解码字符集-->
</configuration>
</plugin>
</plugins>
</build>
</project>
//POJO实体类
@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class Book {
private Integer id;
private String type;
private String name;
private String description;
}
//SpringMVC容器初始化类
public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
// Spring核心配置文件 但是这里用不着Spring
protected Class<?>[] getRootConfigClasses() {
return new Class[0];
}
// SpringMVC核心配置文件(SpringMVC的Controller就是我们的Servlet嘛)
protected Class<?>[] getServletConfigClasses() {
return new Class[]{SpringMvcConfig.class};
}
//配置SpringMVC拦截所有路径
protected String[] getServletMappings() {
return new String[]{"/"};
}
//Post请求乱码处理
@Override //本质也是过滤器 (这里写新的方法,就相当于xml中写新的配置)
protected Filter[] getServletFilters() {
//可以自己写过滤器Filter,但是SpringMVC肯定有内置写好的
CharacterEncodingFilter filter = new CharacterEncodingFilter();
filter.setEncoding("utf-8");
return new Filter[]{filter};
}
}
//SpringMVC配置类
@Configuration
@ComponentScan("cn.whu.controller")
@EnableWebMvc
public class SpringMvcConfig {
}
4.2 代码实现
4.2.1 制作SpringMVC控制器,并通过PostMan测试接口功能
@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(){
Book book1 = new Book(1,"计算机","SpringMVC入门教程","小试牛刀");
Book book2 = new Book(2,"计算机","SpringMVC实战教程","一代宗师");
List<Book> bookList = new ArrayList<Book>();
bookList.add(book1);
bookList.add(book2);
return bookList;
}
}
- 测试1:
- 测试2
问题引入:
接下来直接访问http://localhost/pages/books.html,访问不到
静态资源也被SpringMVC拦截了,他认为你应该有一个@RequestMapping配置叫 GET /pages/books.html
所以必然得对静态资源进行放行了~
4.2.2 设置对静态资源的访问放行
config包下新建SpringMvcSupport(SpringMVC支持类)继承自WebMvcConfigurationSupport
@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
// 设置静态资源访问过滤,当前类需要设置为配置类,并被扫描加载
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
//当访问/pages/xxx的时候,走/pages目录下的内容
registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
// 其他静态资源依次类推 逐一 放行
registry.addResourceHandler("/css/**").addResourceLocations("/css/");
registry.addResourceHandler("/js/**").addResourceLocations("/js/");
registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
}
}
有了新的配置类,SpringMvcConfig核心配置类的扫描范围也要扩大一点了:
静态资源可以被正常访问到了:
4.2.3 前端页面通过异步提交访问后台控制器
- 标准写法
//添加
saveBook () {
axios({
method: "post",
url: "/books",
data:this.formData
}).then(resp=>{
console.log(resp.data)
if(resp.data=="{'module':'book save success'}"){
this.dialogFormVisible = false
}
})
},
//主页列表查询
getAll() {
axios({
method: "get",
url: "/books"
}).then(resp=>{
this.dataList = resp.data
})
},
- 简单需求简化写法
//添加
saveBook () {
axios.post("/books",this.formData).then(resp=>{
if(resp.data=="{'module':'book save success'}"){
this.dialogFormVisible = false
}
})
},
//主页列表查询所有
getAll() {
axios.get("/books").then(resp=>{
this.dataList = resp.data;
})
},
就这么简单,VUE好强大啊
- 运行结果
- 完整页面代码:
<!DOCTYPE html>
<html>
<head>
<!-- 页面meta -->
<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>
<!-- 新增标签弹窗 -->
<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>
<!--表格-->
<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>
</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(resp=>{
if(resp.data=="{'module':'book save success'}"){
this.dialogFormVisible = false
}
})
},
//主页列表查询所有
getAll() {
axios.get("/books").then(resp=>{
this.dataList = resp.data;
})
},
/*//添加
saveBook () {
axios({
method: "post",
url: "/books",
data:this.formData
}).then(resp=>{
console.log(resp.data)
if(resp.data=="{'module':'book save success'}"){
this.dialogFormVisible = false
}
})
},
//主页列表查询
getAll() {
axios({
method: "get",
url: "/books"
}).then(resp=>{
this.dataList = resp.data
})
},
*/
}
})
</script>
</html>