今日内容
- 理解SpringMVC相关概念
- 完成SpringMVC的入门案例
- 学会使用PostMan工具发送请求和数据
- 掌握SpringMVC如何接收请求、数据和响应结果
- 掌握RESTful风格及其使用
- 完成基于RESTful的案例编写
SpringMVC是隶属于Spring框架的一部分,主要是用来进行Web开发,是对Servlet进行了封装。
对于SpringMVC我们主要学习如下内容:
- SpringMVC简介
- 请求与响应
- REST风格
- SSM整合(注解版)
- 拦截器
SpringMVC是处于Web层的框架,所以其主要的作用就是用来接收前端发过来的请求和数据然后经过处理并将处理的结果响应给前端,所以如何处理请求和响应是SpringMVC中非常重要的一块内容。
REST是一种软件架构风格,可以降低开发的复杂性,提高系统的可伸缩性,后期的应用也是非常广泛。
SSM整合是把咱们所学习的SpringMVC+Spring+Mybatis整合在一起来完成业务开发,是对我们所学习这三个框架的一个综合应用。
对于SpringMVC的学习,最终要达成的目标:
- 掌握基于SpringMVC获取请求参数和响应json数据操作
- 熟练应用基于REST风格的请求路径设置与参数传递
- 能够根据实际业务建立前后端开发通信协议并进行实现
- 基于SSM整合技术开发任意业务模块功能
1,SpringMVC概述
学习SpringMVC我们先来回顾下现在web程序是如何做的,咱们现在web程序大都基于三层架构来实现。
三层架构
-
浏览器发送一个请求给后端服务器,后端服务器现在是使用Servlet来接收请求和数据
-
如果所有的处理都交给Servlet来处理的话,所有的东西都耦合在一起,对后期的维护和扩展极为不利
-
将后端服务器Servlet拆分成三层,分别是
web
、service
和dao
- web层主要由servlet来处理,负责页面请求和数据的收集以及响应结果给前端
- service层主要负责业务逻辑的处理
- dao层主要负责数据的增删改查操作
-
servlet处理请求和数据的时候,存在的问题是一个servlet只能处理一个请求
-
针对web层进行了优化,采用了MVC设计模式,将其设计为
controller
、view
和Model
controller负责请求和数据的接收,接收后将其转发给service进行业务处理 这里也就是我们SpringMVC要干的活
- service根据需要会调用dao对数据进行增删改查
- dao把数据处理完后将结果交给service,service再交给controller
- controller根据需求组装成Model和View,Model和View组合起来生成页面转发给前端浏览器
- 这样做的好处就是controller可以处理多个请求,并对请求进行分发,执行不同的业务操作。
随着互联网的发展,上面的模式因为是同步调用,性能慢慢的跟不是需求,所以异步调用慢慢的走到了前台,是现在比较流行的一种处理方式。
- 因为是异步调用,所以后端不需要返回view视图,将其去除
- 前端如果通过异步调用的方式进行交互,后台就需要将返回的数据转换成json格式进行返回
- SpringMVC主要负责的就是
- controller如何接收请求和数据
- 如何将请求和数据转发给业务层
- 如何将响应数据转换成json发回到前端
介绍了这么多,对SpringMVC进行一个定义
-
SpringMVC是一种基于Java实现MVC模型的轻量级Web框架
-
优点
- 使用简单、开发便捷(相比于Servlet)
- 灵活性强
这里所说的优点,就需要我们在使用的过程中慢慢体会。
前言:我们需要复习的知识点
javaweb之Servlet 我个人觉得原理是类似的
2,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容器中
2.1 需求分析
2.2 案例制作
步骤1:导入坐标
步骤2 :类似javawebh的servlet 也就是写bean对象 不过得用@Controller来定义bean对象
//2.定controller
//2.1使用@Controller定义bean
@Controller
public class UserController {//我们提供给外部一个方法,它就可以用来处理我们的请求了//这里我们完成了处理请求的方法 但是用户发哪个请求可以调用到该方法呢?//2.2设置当前操作的访问路径@RequestMapping("/save")//2.3设置当前操作的返回值类型@ResponseBody //就是你呀把你返回的东西整体作为响应的内容给到外边public String save(){System.out.println("user save ...");return "{'info':'springmvc'}";}@RequestMapping("/delete")@ResponseBodypublic String delete(){System.out.println("user delete ...");return "{'info':'springmvc'}";}
}
步骤3 .创建springmvc的配置文件,加截controller对应的bean对象
//3.创建springmvc的配置文件,加截controller对应的bean
@Configuration
@ComponentScan("com.itheima.controller")
public class SpringMvcConfig {
}
//tomcat容器启动配置 用来加载spring容器的
//4.定义一个servlet容器启动的配置类,在里面加载spring的配置
对于web容器这里相当于main方法了
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {//加载springmvc配置类protected WebApplicationContext createServletApplicationContext() {//初始化WebApplicationContext对象AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();/*AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();这段代码初始化的是Spring容器,具体来说是一个基于注解配置的Web应用程序上下文容器。在这里,AnnotationConfigWebApplicationContext类是Spring Framework提供的一种基于Java配置的容器实现,它可以用来加载基于注解的Spring配置类,从而实现Spring IOC容器的初始化和管理。它是Spring容器的一种实现方式,用于构建和管理Spring应用程序的Bean以及提供其他Spring功能,例如事务管理、AOP等。相比之下,Tomcat容器是一个Web服务器容器,它用于部署和运行Web应用程序,而不是创建和管理Spring应用程序的Bean。Tomcat容器使用的是Servlet规范,它提供了一种Servlet容器,用于部署和运行基于Servlet规范的Web应用程序。*///加载指定配置类ctx.register(SpringMvcConfig.class);/*ctx.register(SpringMvcConfig.class); 这里是创建了Spring MVC容器这段代码是在将一个Spring MVC配置类(SpringMvcConfig)注册到上下文容器(ctx)中。具体来说,register()方法是AnnotationConfigWebApplicationContext类提供的一种注册方法,它可以将一个或多个基于Java配置的Spring配置类注册到容器中,以供容器初始化和管理。在这里,SpringMvcConfig类是一个基于注解配置的Spring MVC配置类,它包含了Spring MVC框架所需的相关配置,例如视图解析器、拦截器、处理器映射等等。通过将SpringMvcConfig类注册到容器中,可以使得Spring MVC框架能够正确地初始化和配置,从而实现Web应用程序的处理和响应。*/return ctx;}//设置由springmvc控制器处理的请求映射路径protected String[] getServletMappings() {return new String[]{"/"};}//加载spring配置类protected WebApplicationContext createRootApplicationContext() {return null;}/*核心思想:问:tomcat如何读取这个servlet容器初始化类的。是因为它继承了AbstractDispatcherServletInitializer ??chatgpt:是的,Tomcat可以读取Servlet容器初始化类是因为该类继承了Spring Framework提供的AbstractDispatcherServletInitializer抽象类。在Web应用程序启动时,Servlet容器会扫描web.xml文件,加载并初始化所有配置的Servlet和Filter,同时会调用onStartup()方法来启动Spring应用程序上下文。在这个过程中,如果发现有继承了AbstractDispatcherServletInitializer抽象类的Servlet容器初始化类,就会自动调用其中的方法,进行自定义的Servlet容器初始化和配置,包括创建Spring应用程序上下文容器、注册Servlet和Filter、设置请求映射路径等等。最终,Servlet容器会将这些配置应用到Web应用程序中,使得Web应用程序能够正确地处理和响应请求。因此,继承AbstractDispatcherServletInitializer抽象类是实现SpringMVC集成的一种常用方式,它可以自动化配置Servlet和Filter,并使用Spring应用程序上下文容器来管理和加载SpringMVC的配置类和组件。同时,它也支持自定义配置,例如设置请求映射路径、添加拦截器、注册其他Servlet和Filter等等。*/
}
问
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {//加载springmvc配置类protected WebApplicationContext createServletApplicationContext() {//初始化WebApplicationContext对象 创建化了一个空的容器AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();//加载指定配置类 加载spring mvc配置创建了spring MVC容器ctx.register(SpringMvcConfig.class);return ctx;}
答
//设置由springmvc控制器处理的请求映射路径protected String[] getServletMappings() {return new String[]{"/"};}//加载spring配置类protected WebApplicationContext createRootApplicationContext() {return null;}
}
该类是一个Servlet容器的初始化配置类,继承了AbstractDispatcherServletInitializer类。其中,createServletApplicationContext()方法用于创建一个WebApplicationContext对象,并加载指定的Spring MVC配置类,创建了一个Spring MVC容器;getServletMappings()方法用于设置由Spring MVC控制器处理的请求映射路径;createRootApplicationContext()方法用于加载Spring配置类,但在该方法中返回了null,表示不需要加载Spring配置类,因为已经在createServletApplicationContext()方法中加载了Spring MVC配置类。
问
//设置由springmvc控制器处理的请求映射路径
protected String[] getServletMappings() {return new String[]{"/"};}
这段代码也就是相当于控制层control包完全交给springmvc 因为网页的访问路径全是springmvc的。spring只负责其他包bean对象的创建 比如service包config包啥的?
答
是的,getServletMappings()方法设置了由Spring MVC控制器处理的请求映射路径,这意味着所有网页的访问路径都是由Spring MVC控制器处理的,而Spring只负责其他包(如service包、config包等)中的bean对象的创建和管理。这种架构模式称为MVC(Model-View-Controller)模式,其中控制器(Controller)负责处理请求和响应,模型(Model)负责业务逻辑处理,视图(View)负责呈现数据。Spring MVC框架就是基于MVC模式设计的。
疑问解答
步骤7:配置Tomcat环境
步骤8:启动运行项目
步骤9:浏览器访问
浏览器输入http://localhost/save
进行访问
同时控制台输出
至此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控制器类或方法定义上方 |
作用 | 设置当前控制器方法响应内容为当前返回值,无需解析 |
疑问解答
@Controller
public class UserController {@RequestMapping("/save")@ResponseBodypublic String save(){System.out.println("user save ...");return "{'info':'springmvc'}";}
}
问:
我想问的是这个bean对象在springmvc容器扫描就已经被创建了,而不是用户在浏览器访问地址的时候对象创建?
chatgpt:
是的,你的理解是正确的。在Spring MVC中,控制器(Controller)是一个特殊的Bean,它在容器启动时就已经被创建了,并注册到Spring容器中。当用户在浏览器中访问对应的请求路径时,Spring MVC框架会找到对应的控制器,并调用对应的方法来处理请求。也就是说,控制器实例在请求到来时并不会被创建,而是在容器启动时就已经被创建好了。
问
也就说当用户在浏览器中访问对应的请求路径时 springmvc容器就会找到对应的对象调用它的方法?
chatgpt:
是的,当用户在浏览器中访问对应的请求路径时,Spring MVC 的 DispatcherServlet 会根据请求的 URL 找到对应的 HandlerMapping,再根据 HandlerMapping 找到对应的 Controller,然后调用对应的方法来处理请求。这个 Controller 对象在 Spring MVC 初始化的时候就已经被创建并放入 Spring 容器中,当有请求来的时候就直接拿出来使用。
2.3 入门案例总结
- 一次性工作
- 创建工程,设置服务器,加载工程
- 导入坐标
- 创建web容器启动类,加载SpringMVC配置,并设置SpringMVC请求拦截路径
- SpringMVC核心配置类(设置配置类,扫描controller包,加载Controller控制器bean)
- 多次工作
- 定义处理请求的控制器类
- 定义处理请求的控制器方法,并配置映射路径(@RequestMapping)与返回json数据(@ResponseBody)
2.4 工作流程解析
为了更好的使用SpringMVC,我们将SpringMVC的使用过程总共分两个阶段来分析,分别是启动服务器初始化过程
和单次请求过程
疑问解答
问
AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
//加载指定配置类 加载spring mvc配置创建了spring MVC容器
ctx.register(SpringMvcConfig.class); new AnnotationConfigWebApplicationContext(); 是创建了spring中的servlet容器 然后在这个spirng容器里面套入srpingmvc容器还是其他什么的?
答
是的,AnnotationConfigWebApplicationContext
是Spring的一个容器,用于加载基于注解的配置类。在上面的代码中,创建了一个新的AnnotationConfigWebApplicationContext
实例,并将SpringMvcConfig
类注册到容器中,以便在容器中创建和管理Spring MVC组件。
问
AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
//加载指定配置类 加载spring mvc配置创建了spring MVC容器
ctx.register(SpringMvcConfig.class); new AnnotationConfigWebApplicationContext(); 是创建了spring中的servlet容器 然后在这个spirng容器里面套入srpingmvc容器还是其他什么的?
答
AnnotationConfigWebApplicationContext
创建的是Spring的ApplicationContext容器,它是Spring的核心容器,用于管理应用程序中的所有Bean。而在Spring MVC中,需要创建一个Servlet容器来处理Web请求,这个Servlet容器通常是由Tomcat、Jetty等Web容器提供的。因此,AnnotationConfigWebApplicationContext
并不是创建Servlet容器的,而是在Servlet容器中创建了一个Spring MVC容器,用于管理Spring MVC相关的Bean。这个Spring MVC容器是嵌套在ApplicationContext容器中的,两者是独立的容器,但是可以共享ApplicationContext容器中的Bean。
问
也就是springmvc容器的最外层是servlet容器 这个servlet容器属于spring容器的一部分?
答
是的,Spring MVC容器是嵌套在Servlet容器中的,而Servlet容器又是嵌套在ApplicationContext容器中的。在一个Web应用程序中,通常会有一个Servlet容器来处理Web请求,例如Tomcat、Jetty等Web容器。在Servlet容器中,会创建一个Servlet上下文,用于管理Servlet相关的Bean。而在Spring MVC中,会在Servlet上下文中创建一个Spring MVC上下文,用于管理Spring MVC相关的Bean。Spring MVC上下文和Servlet上下文是独立的,但是它们之间可以共享ApplicationContext容器中的Bean。因此,可以把Servlet容器看作是ApplicationContext容器的一部分,而Spring MVC容器则是嵌套在Servlet容器中的。
问
Spring MVC上下文和Servlet上下文是独立的 上下文为什么独立 servlet容器包含springmvc容器啊
答
虽然Servlet容器包含了Spring MVC容器,但是它们实际上是两个独立的上下文。Servlet容器是由Web服务器创建的,它负责处理HTTP请求和响应。而Spring MVC容器是由Spring框架创建的,它负责管理Spring MVC应用程序中的Bean,例如控制器、视图解析器等等。Servlet容器和Spring MVC容器之间的关系可以类比为两个相邻的盒子,一个盒子包含了另一个盒子。在这个模型中,Servlet容器是外层的盒子,而Spring MVC容器是内层的盒子。
在实际应用中,Servlet容器和Spring MVC容器之间的通信是通过Servlet API和Spring MVC API实现的。Servlet容器会将HTTP请求转发给Spring MVC容器,Spring MVC容器会根据请求的URL和HTTP方法,选择合适的控制器来处理请求,并生成响应返回给Servlet容器,最终由Servlet容器将响应发送给客户端。在这个过程中,Servlet容器和Spring MVC容器之间并没有直接的联系,它们是通过API进行通信的。因此,我们可以认为Servlet容器和Spring MVC容器是独立的上下文。
2.4.1 启动服务器初始化过程
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {//加载springmvc配置类protected WebApplicationContext createServletApplicationContext() {//初始化WebApplicationContext对象 创建化了一个空的容器AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();//加载指定配置类 加载spring mvc配置创建了spring MVC容器ctx.register(SpringMvcConfig.class);return ctx;}//设置由springmvc控制器处理的请求映射路径protected String[] getServletMappings() {return new String[]{"/"};}//加载spring配置类protected WebApplicationContext createRootApplicationContext() {return null;}
}
chatgpt : 您提供的代码是一个Java类,它扩展了AbstractDispatcherServletInitializer类,该类是Spring MVC框架的一部分。该类负责配置和初始化运行Spring MVC应用程序的servlet容器。 当servlet容器启动时,它会扫描应用程序中的所有ServletContainersInitConfig子类,并调用其createServletApplicationContext()和getServletMappings()方法来初始化Spring MVC应用程序的WebApplicationContext对象和处理请求的映射路径。 createServletApplicationContext()方法创建一个新的AnnotationConfigWebApplicationContext对象,并将SpringMvcConfig类注册为配置类。SpringMvcConfig类包含了应用程序的Spring MVC配置,例如视图解析器、拦截器、处理器映射等等。当该方法被调用时,Spring会扫描SpringMvcConfig类并将其注册为应用程序的Bean,以便在处理请求时使用。 getServletMappings()方法返回一个字符串数组,其中包含应用程序的根路径映射。在此例中,该数组只包含一个字符串"/",这表示所有的请求都将由Spring MVC的控制器来处理。 createRootApplicationContext()方法返回一个WebApplicationContext对象,但在此例中返回null,表示该应用程序没有任何根配置。这种情况通常在单个Spring应用程序中使用,而不是在使用Spring MVC框架的应用程序中使用。 总之,当servlet容器启动时,它将扫描并初始化所有ServletContainersInitConfig子类,并使用这些类中的方法配置和初始化Spring MVC应用程序。这些配置包括创建WebApplicationContext对象、注册应用程序的Bean和处理请求的映射路径。
-
服务器启动,执行ServletContainersInitConfig类,初始化web容器
- 功能类似于以前的web.xml
//初始化WebApplicationContext对象 创建化了一个空的容器
AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
- 功能类似于以前的web.xml
-
执行createServletApplicationContext方法,创建了WebApplicationContext对象
- 该方法加载SpringMVC的配置类SpringMvcConfig来初始化SpringMVC的容器
-
加载SpringMvcConfig配置类 然后开始扫描读取配置类的东西
new AnnotationConfigWebApplicationContext(); ctx.register(SpringMvcConfig.class);两行都在创建Spring MVC容器
4. 执行@ComponentScan 加载对应的bean
- spring MVC容器扫描指定包及其子包下所有类上的注解,如Controller类上的@Controller注解
-
加载UserController,每个@RequestMapping的名称对应一个具体的方法
此时就建立了/save
和 save方法的对应关系这一组信息并不是放在UserController这个类定义的 所有springmvc是放在一起统一管理的 并不是放在每一个bean下
-
当浏览器访问对应的url中也就是对应的javewebservelet路径执行getServletMappings方法,设定SpringMVC拦截请求的路径规则
/
代表所拦截请求的路径规则,只有被拦截后才能交给SpringMVC来处理请求
总结 (个人总结)
首先 ServletContainersInitConfig类由tomcat创建对象然后调用其中的方法。。方法中 AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();创建spring容器。ctx.register(SpringMvcConfig.class);配置springMVC容器,springmvc最终体现为webapplicationcontext对象所以springMVC容器执行SpringMvcConfig.java文件的内容,然后读取到SpringMvcConfig.java中的注解@ComponentScan(“com.itheima.controller”)然后去controller目录下的类进行对象实例化 这个过程是Spring MVC容器 而不是spring容器干的
问
联系这几段代码,我想问的问题是程序运行从 ServletContainersInitConfig 类的createServletApplicationContext()方法运行 但我想问的是,我们创建了springmvc容器,但是如何去SpringMvcConfig配置类读取注解的呢。。我们明明只是创建了它的容器啊
chatgpt
好的,让我来解释一下。
当调用 createServletApplicationContext() 方法时,它会返回一个 WebApplicationContext 对象,该对象实际上是一个 AnnotationConfigWebApplicationContext 实例,它会加载配置类 SpringMvcConfig,而 SpringMvcConfig 中通过 @ComponentScan 注解扫描了 com.itheima.controller 包下的所有类,包括 UserController。
在扫描 UserController 类时,它会发现 @Controller 注解,因此会将 UserController 类的实例化对象添加到 Spring MVC 容器中。然后,在扫描到 @RequestMapping 注解时,会将该注解中指定的请求路径和 UserController 中的方法建立起映射关系。
所以,当浏览器请求 localhost:8080/save 时,它实际上是访问 Spring MVC 容器中已经创建的 UserController 的 save() 方法,返回的结果就是该方法的返回值。
总之,通过 @ComponentScan 注解扫描指定的包时,Spring 会自动将包下所有的类实例化为对象,并加入到 Spring 容器中。同时,对于有特定注解的类,比如 @Controller、@Service、@Repository 等,Spring 会特殊处理,以便进行更好的区分和管理。
问
Sherlok
WebApplicationContext 对象会去扫描springmvcConfig类的意思?
chatgpt
是的,当你调用AnnotationConfigWebApplicationContext的register方法并传入一个配置类时,该配置类会被扫描,容器会自动识别并加载该配置类中使用@Bean注解声明的Bean,也会扫描其中使用@ComponentScan注解声明的包,加载其中使用@Component或其派生注解声明的Bean。因此,在上述代码中,SpringMvcConfig配置类会被扫描并加载其中声明的UserController控制器类的Bean对象。
问
Sherlok
那我还有个问题。为什么感觉你程序运行的时候先读取的是类上的注解
比如这个类文件
@Configuration
@ComponentScan(“com.itheima.controller”)
public class SpringMvcConfig {
}的@Configuration而不是class SpringMvcConfig {
}里面的内容???
chatgpt
实际上,在程序运行时,Java虚拟机会首先加载类的字节码,然后才会执行类中的代码。因此,程序会先读取类上的注解,然后才会执行类中的代码。
对于Spring框架而言,@Configuration注解是用来标记配置类的,告诉Spring容器这个类是用来配置bean的,需要被特殊处理。在运行时,Spring容器会扫描这个类中的所有bean的注解信息,然后根据这些注解来创建bean实例并装配依赖。因此,@Configuration注解的作用比普通类中的代码更为重要,是配置bean的入口。
问
Sherlok
也就是说java虚拟机优先读取注解翻译的类的字节码,再读取java类中的普通字节码,也就是读取类文件的时候类上方注解或方法商法注解编译后的字节码优先级比普通java代码高
chatgpt
是的,Java虚拟机在加载类时,会首先读取类文件中的注解信息,这些注解信息会被解析并生成相应的Java类或对象。因此,注解所标注的信息具有更高的优先级,比普通Java代码更容易被解析和执行。在Spring框架中,注解被广泛应用于各个组件中,如@Service、@Controller、@Autowired等,这些注解会在Spring容器启动时被解析并生成相应的组件对象,以实现自动装配、请求处理等功能。
2.4.2 单次请求过程
- 发送请求
http://localhost/save
- web容器发现该请求满足SpringMVC拦截规则,将请求交给SpringMVC处理
- 解析请求路径/save
- 由/save匹配执行对应的方法save()
- 上面的第五步已经将请求路径和方法建立了对应关系,通过/save就能找到对应的save方法
- 执行save()
- 检测到有@ResponseBody直接将save()方法的返回值作为响应体返回给请求方
2.5 bean加载控制
2.5.1 问题分析
入门案例的内容已经做完了,在入门案例中我们创建过一个SpringMvcConfig
的配置类,再回想前面咱们学习Spring的时候也创建过一个配置类SpringConfig
。这两个配置类都需要加载资源,那么它们分别都需要加载哪些内容?
我们先来看下目前我们的项目目录结构:
-
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即可,如
在Spring的配置类SpringConfig
中使用注解@ComponentScan
,当时扫描的范围中其实是已经包含了controller,如:
从包结构来看的话,Spring已经多把SpringMVC的controller类也给扫描到,所以针对这个问题该如何解决,就是咱们接下来要学习的内容。
概括的描述下咱们现在的问题就是因为功能不同,如何避免Spring错误加载到SpringMVC的bean?
2.5.2 思路分析
针对上面的问题,解决方案也比较简单,就是:
- 加载Spring控制的bean的时候排除掉SpringMVC控制的bean
具体该如何排除:
- 方式一:Spring加载的bean设定扫描范围为精准范围,例如service包、dao包等
- 方式二:Spring加载的bean设定扫描范围为com.itheima,排除掉controller包中的bean
- 方式三:不区分Spring与SpringMVC的环境,加载到同一个环境中[了解即可]
2.5.4 环境准备
创建对应的配置类
- 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")@ResponseBodypublic 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.5.5 设置bean加载控制
方式一:修改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未被定义的错误
注意:测试的时候,需要把SpringMvcConfig配置类上的@ComponentScan注解注释掉,否则不会报错==
出现问题的原因是,
- 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 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
名称 | @ComponentScan |
---|---|
类型 | 类注解 |
位置 | 类定义上方 |
作用 | 设置spring配置类扫描路径,用于加载使用注解格式定义的bean |
相关属性 | excludeFilters:排除扫描路径中加载的bean,需要指定类别(type)和具体项(classes) includeFilters:加载指定的bean,需要指定类别(type)和具体项(classes) |
4,请求与响应
前面我们已经完成了入门案例相关的知识学习,接来了我们就需要针对SpringMVC相关的知识点进行系统的学习,之前我们提到过,SpringMVC是web层的框架,主要的作用是接收请求、接收数据、响应结果,所以这一章节是学习SpringMVC的重点内容,我们主要会讲解四部分内容:
- 请求映射路径
- 请求参数
- 日期类型参数传递
- 响应json数据
3,PostMan工具的使用
4.1 设置请求映射路径
4.1.1 环境准备
- 创建一个Web的Maven项目
创建对应的配置类
public 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];}
}@Configuration
@ComponentScan("com.itheima.controller")
public class SpringMvcConfig {
}
编写BookController和UserController
@Controller
@RequestMapping("/user")
public class UserController {@RequestMapping("/save")@ResponseBodypublic String save(){System.out.println("user save ...");return "{'module':'user save'}";}@RequestMapping("/delete")@ResponseBodypublic String delete(){System.out.println("user delete ...");return "{'module':'user delete'}";}
}
@Controller
@RequestMapping("/book")
public class BookController {@RequestMapping("/save")@ResponseBodypublic String save(){System.out.println("book save ...");return "{'module':'book save'}";}
}
从错误信息可以看出:
- UserController有一个save方法,访问路径为
http://localhost/save
- BookController也有一个save方法,访问路径为
http://localhost/save
- 当访问
http://localhost/saved
的时候,到底是访问UserController还是BookController?
最终创建好的项目结构如下:
4.1.2 问题分析
团队多人开发,每人设置不同的请求路径,冲突问题该如何解决?
解决思路:为不同模块设置模块名作为请求路径前置
对于Book模块的save,将其访问路径设置http://localhost/book/save
对于User模块的save,将其访问路径设置http://localhost/user/save
这样在同一个模块中出现命名冲突的情况就比较少了。
4.1.3 设置映射路径
步骤1:修改Controller
@Controller
public class UserController {@RequestMapping("/user/save")@ResponseBodypublic String save(){System.out.println("user save ...");return "{'module':'user save'}";}@RequestMapping("/user/delete")@ResponseBodypublic String save(){System.out.println("user delete ...");return "{'module':'user delete'}";}
}@Controller
public class BookController {@RequestMapping("/book/save")@ResponseBodypublic String save(){System.out.println("book save ...");return "{'module':'book save'}";}
}
问题是解决了,但是每个方法前面都需要进行修改,写起来比较麻烦而且还有很多重复代码,如果/user后期发生变化,所有的方法都需要改,耦合度太高。
步骤2:优化路径配置
优化方案:
@Controller
@RequestMapping("/user")
public class UserController {@RequestMapping("/save")@ResponseBodypublic String save(){System.out.println("user save ...");return "{'module':'user save'}";}@RequestMapping("/delete")@ResponseBodypublic String save(){System.out.println("user delete ...");return "{'module':'user delete'}";}
}@Controller
@RequestMapping("/book")
public class BookController {@RequestMapping("/save")@ResponseBodypublic String save(){System.out.println("book save ...");return "{'module':'book save'}";}
}
注意:
- 当类上和方法上都添加了
@RequestMapping
注解,前端发送请求的时候,要和两个注解的value值相加匹配才能访问到。 - @RequestMapping注解value属性前面加不加
/
都可以
扩展小知识:
对于PostMan如何觉得字小不好看,可以使用ctrl+=
调大,ctrl+-
调小。
4.2 请求参数
请求路径设置好后,只要确保页面发送请求地址和后台Controller类中配置的路径一致,就可以接收到前端的请求,接收到请求后,如何接收页面传递的参数?
关于请求参数的传递与接收是和请求方式有关系的,目前比较常见的两种请求方式为:
- GET
- POST
针对于不同的请求前端如何发送,后端如何接收?
4.2.1 环境准备
- 创建一个Web的Maven项目
创建对应的配置类
public 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];}
}@Configuration
@ComponentScan("com.itheima.controller")
public class SpringMvcConfig {
}
编写UserController
@Controller
public class UserController {@RequestMapping("/commonParam")@ResponseBodypublic String commonParam(){return "{'module':'commonParam'}";}
}
编写模型类,User和Address
public class Address {private String province;private String city;//setter...getter...略
}
public class User {private String name;private int age;//setter...getter...略
}
最终创建好的项目结构如下:
4.2.2 参数传递
GET发送单个参数
发送请求与参数
http://localhost/commonParam?name=itcast
接收参数:
@Controller
public class UserController {@RequestMapping("/commonParam")@ResponseBodypublic String commonParam(String name){System.out.println("普通参数传递 name ==> "+name);return "{'module':'commonParam'}";}
}
GET发送多个参数
发送请求与参数:
http://localhost/commonParam?name=itcast&age=15
接收参数:
@Controller
public class UserController {@RequestMapping("/commonParam")@ResponseBodypublic 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
控制台:
出现乱码的原因相信大家都清楚,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><!--tomcat端口号--><path>/</path> <!--虚拟目录--><uriEncoding>UTF-8</uriEncoding><!--访问路径编解码字符集--></configuration></plugin></plugins></build>
POST发送参数
发送请求与参数:
接收参数:
和GET一致,不用做任何修改
@Controller
public class UserController {@RequestMapping("/commonParam")@ResponseBodypublic String commonParam(String name,int age){System.out.println("普通参数传递 name ==> "+name);System.out.println("普通参数传递 age ==> "+age);return "{'module':'commonParam'}";}
}
POST请求中文乱码
发送请求与参数:
接收参数:
控制台打印,会发现有中文乱码问题。
解决方案:配置过滤器
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[]{"/"};}//乱码处理@Overrideprotected Filter[] getServletFilters() {CharacterEncodingFilter filter = new CharacterEncodingFilter();filter.setEncoding("UTF-8");return new Filter[]{filter};}
}
CharacterEncodingFilter是在spring-web包中,所以用之前需要导入对应的jar包。
4.3 五种类型参数传递
前面我们已经能够使用GET或POST来发送请求和数据,所携带的数据都是比较简单的数据,接下来在这个基础上,我们来研究一些比较复杂的参数传递,常见的参数种类有:
- 普通参数
- POJO类型参数
- 嵌套POJO类型参数
- 数组类型参数
- 集合类型参数
这些参数如何发送,后台改如何接收?我们一个个来学习。
4.3.1 普通参数
- 普通参数:url地址传参,地址参数名与形参变量名相同,定义形参即可接收参数。
如果形参与地址参数名不一致该如何解决?
发送请求与参数:
http://localhost/commonParamDifferentName?name=张三&age=18
后台接收参数:
@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
,两个名称对不上,导致接收数据失败:
解决方案:使用@RequestParam注解 把url请求的参数name给到username 绑定请求参数和形参之间的关系
@RequestMapping("/commonParamDifferentName")@ResponseBodypublic String commonParamDifferentName(@RequestPaam("name") String userName , int age){System.out.println("普通参数传递 userName ==> "+userName);System.out.println("普通参数传递 age ==> "+age);return "{'module':'common param different name'}";}
注意:写上@RequestParam注解框架就不需要自己去解析注入,能提升框架处理性能
4.3.2 POJO数据类型
简单数据类型一般处理的是参数个数比较少的请求,如果参数比较多,那么后台接收参数的时候就比较复杂,这个时候我们可以考虑使用POJO数据类型。
- POJO参数:请求参数名与形参对象属性名相同,定义POJO类型形参即可接收参数
此时需要使用前面准备好的POJO类,先来看下User
public class User {private String name;private int age;//setter...getter...略
}
这里有一点得知道 由于springmvc框架的原因 所以可以自动将url中name参数和age参数 传入
发送请求和参数:
4.3.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属性参数
发送请求和参数:
后台接收参数:
//POJO参数:请求参数与形参对象中的属性对应即可完成参数传递
@RequestMapping("/pojoParam")
@ResponseBody
public String pojoParam(User user){System.out.println("pojo参数传递 user ==> "+user);return "{'module':'pojo param'}";
}
注意:
请求参数key的名称要和POJO中属性的名称一致,否则无法封装
4.3.4 数组类型参数
举个简单的例子,如果前端需要获取用户的爱好,爱好绝大多数情况下都是多个,如何发送请求数据和接收数据呢?
- 数组参数:请求参数名与形参对象属性名相同且请求参数为多个,定义数组类型即可接收参数
发送请求和参数:
后台接收参数:
//数组参数:同名请求参数可以直接映射到对应名称的形参数组对象中@RequestMapping("/arrayParam")@ResponseBodypublic String arrayParam(String[] likes){System.out.println("数组参数传递 likes ==> "+ Arrays.toString(likes));return "{'module':'array param'}";}
4.3.5 集合类型参数
数组能接收多个值,那么集合是否也可以实现这个功能呢?
发送请求和参数:
后台接收参数:
//集合参数:同名请求参数可以使用@RequestParam注解映射到对应名称的集合对象中作为数据
@RequestMapping("/listParam")
@ResponseBody
public String listParam(List<String> likes){System.out.println("集合参数传递 likes ==> "+ likes);return "{'module':'list param'}";
}
运行会报错,
错误的原因是: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
名称 | @RequestParam |
---|---|
类型 | 形参注解 |
位置 | SpringMVC控制器方法形参定义前面 |
作用 | 绑定请求参数与处理器方法形参间的关系 |
相关参数 | required:是否为必传参数 defaultValue:参数默认值 |
4.4 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依赖
<dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.9.0</version>
</dependency>
步骤2:PostMan发送JSON数据
步骤3:开启SpringMVC注解支持
在SpringMVC的配置类中开启SpringMVC的注解支持,这里面就包含了将JSON转换成对象的功能。
@Configuration
@ComponentScan("com.itheima.controller")
// 让springmvc容器开启由将请求过来的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:启动运行程序
JSON普通数组的数据就已经传递完成,下面针对JSON对象数据和JSON对象数组的数据该如何传递呢?
JSON对象数据
我们会发现,只需要关注请求和数据如何发送?后端数据如何接收?
请求和数据的发送:
{"name":"itcast","age":15
}
后端接收数据:
@RequestMapping("/pojoParamForJson")
@ResponseBody
public String pojoParamForJson(@RequestBody User user){System.out.println("pojo(json)参数传递 user ==> "+user);return "{'module':'pojo for json param'}";
}
启动程序访问测试
说明:
address为null的原因是前端没有传递数据给后端。
如果想要address也有数据,我们需求修改前端传递的数据内容:
{"name":"itcast","age":15,"address":{"province":"beijing","city":"beijing"}
}
再次发送请求,就能看到address中的数据
JSON对象数组
集合中保存多个POJO该如何实现?
请求和数据的发送:
[{"name":"itcast","age":15},{"name":"itheima","age":12}
]
后端接收数据:
@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'}";
}
启动程序访问测试
说明:
address为null的原因是前端没有传递数据给后端。
如果想要address也有数据,我们需求修改前端传递的数据内容:
{"name":"itcast","age":15,"address":{"province":"beijing","city":"beijing"}
}
再次发送请求,就能看到address中的数据
JSON对象数组
集合中保存多个POJO该如何实现?
请求和数据的发送:
[{"name":"itcast","age":15},{"name":"itheima","age":12}
]
后端接收数据:
@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'}";
}
小结
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接收请求参数
4.5 日期类型参数传递
前面我们处理过简单数据类型、POJO数据类型、数组和集合数据类型以及JSON数据类型,接下来我们还得处理一种开发中比较常见的一种数据类型,日期类型
日期类型比较特殊,因为对于日期的格式有N多中输入方式,比如:
- 2088-08-18
- 2088/08/18
- 08/18/2088
- …
针对这么多日期格式,SpringMVC该如何接收,它能很好的处理日期类型数据么?
步骤1:编写方法接收日期数据
在UserController类中添加方法,把参数设置为日期类型
@RequestMapping("/toJsonList")@ResponseBodypublic 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;}
步骤2:启动Tomcat服务器
查看控制台是否报错,如果有错误,先解决错误。
步骤3:使用PostMan发送请求
使用PostMan发送GET请求,并设置date参数
http://localhost/dataParam?date=2088/08/08
步骤4:查看控制台
通过打印,我们发现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
发送请求和数据后,页面会报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就可以正确的进行日期转换了
步骤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
重新启动服务器,重新发送请求测试,SpringMVC就可以将日期时间的数据进行转换
知识点1:@DateTimeFormat
名称 | @DateTimeFormat |
---|---|
类型 | 形参注解 |
位置 | SpringMVC控制器方法形参前面 |
作用 | 设定日期时间型数据格式 |
相关属性 | pattern:指定日期时间格式字符串 |
内部实现原理
讲解内部原理之前,我们需要先思考个问题:
- 前端传递字符串,后端使用日期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接口的实现类
框架中有提供很多对应Converter接口的实现类,用来实现不同数据类型之间的转换,如:
请求参数年龄数据(String→Integer)
日期格式转换(String → Date)
- (2) HttpMessageConverter接口
该接口是实现对象与JSON之间的转换工作
注意:SpringMVC的配置类把@EnableWebMvc当做标配配置上去,不要省略
4.6 响应
SpringMVC接收到请求和数据后,进行一些了的处理,当然这个处理可以是转发给Service,Service层再调用Dao层完成的,不管怎样,处理完以后,都需要将结果告知给用户。
比如:根据用户ID查询用户信息、查询用户列表、新增用户等。
对于响应,主要就包含两部分内容:
- 响应页面
- 响应数据
- 文本数据
- json数据
因为异步调用是目前常用的主流方式,所以我们需要更关注的就是如何返回JSON数据,对于其他只需要认识了解即可。
4.6.1 环境准备
- 创建对应的配置类
- 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[]{"/"};}//乱码处理@Overrideprotected 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
public class User {private String name;private int age;//getter...setter...toString省略
}
webapp下创建page.jsp
<html>
<body>
<h2>Hello Spring MVC!</h2>
</body>
</html>
编写UserController
@Controller
public class UserController {}
最终创建好的项目结构如下:
4.6.2 响应页面[了解]
步骤1:设置返回页面
@Controller
public class UserController {@RequestMapping("/toJumpPage")//注意//1.此处不能添加@ResponseBody,如果加了该注入,会直接将page.jsp当字符串返回前端//2.方法需要返回Stringpublic String toJumpPage(){System.out.println("跳转页面");return "page.jsp";}}
步骤2:启动程序测试
此处涉及到页面跳转,所以不适合采用PostMan进行测试,直接打开浏览器,输入
http://localhost/toJumpPage
4.6.3 返回文本数据[了解]
步骤1:设置返回文本内容
@Controller
public class UserController {@RequestMapping("/toText")//注意此处该注解就不能省略,如果省略了,会把response text当前页面名称去查找,如果没有回报404错误@ResponseBodypublic String toText(){System.out.println("返回纯文本数据");return "response text";}}
步骤2:启动程序测试
此处不涉及到页面跳转,因为我们现在发送的是GET请求,可以使用浏览器也可以使用PostMan进行测试,输入地址http://localhost/toText
访问
4.6.4 响应JSON数据
响应POJO对象
@Controller
public class UserController {@RequestMapping("/toJsonPOJO")@ResponseBodypublic User toJsonPOJO(){System.out.println("返回json对象数据");User user = new User();user.setName("itcast");user.setAge(15);return user;}}
返回值为实体类对象,设置返回值为实体类类型,即可实现返回对应对象的json数据,需要依赖==@ResponseBody注解和@EnableWebMvc==注解
重新启动服务器,访问http://localhost/toJsonPOJO
响应POJO集合对象
@Controller
public class UserController {@RequestMapping("/toJsonList")@ResponseBodypublic List<User> toJsonList(){System.out.println("返回json集合数据");User user1 = new User();user1.setName("传智播客");user1.setAge(15);User user2 = new User();user2.setName("黑马程序员");user2.setAge(12);List<User> userList = new ArrayList<User>();userList.add(user1);userList.add(user2);return userList;}}
重新启动服务器,访问http://localhost/toJsonList
知识点1:@ResponseBody
名称 | @ResponseBody |
---|---|
类型 | 方法\类注解 |
位置 | SpringMVC控制器方法定义上方和控制类上 |
作用 | 设置当前控制器返回值作为响应体, 写在类上,该类的所有方法都有该注解功能 |
相关属性 | pattern:指定日期时间格式字符串 |
说明:
- 该注解可以写在类上或者方法上
- 写在类上就是该类下的所有方法都有@ReponseBody功能
- 当方法上有@ReponseBody注解后
- 方法的返回值为字符串,会将其作为文本内容直接响应给前端
- 方法的返回值为对象,会将对象转换成JSON响应给前端
此处又使用到了类型转换,内部还是通过Converter接口的实现类完成的,所以Converter除了前面所说的功能外,它还可以实现:
- 对象转Json数据(POJO -> json)
- 集合转Json数据(Collection -> json)
5,Rest风格
对于Rest风格,我们需要学习的内容包括:
- REST简介
- REST入门案例
- REST快速开发
- 案例:基于RESTful页面数据交互
5.1 REST简介
-
REST(Representational State Transfer),表现形式状态转换,它是一种软件架构风格
当我们想表示一个网络资源的时候,可以使用两种方式:
- 传统风格资源描述形式
http://localhost/user/getById?id=1
查询id为1的用户信息http://localhost/user/saveUser
保存用户信息
- REST风格描述形式
http://localhost/user/1
http://localhost/user
- 传统风格资源描述形式
传统方式一般是一个请求url对应一种操作,这样做不仅麻烦,也不安全,因为会程序的人读取了你的请求url地址,就大概知道该url实现的是一个什么样的操作。
查看REST风格的描述,你会发现请求地址变的简单了,并且光看请求URL并不是很能猜出来该URL的具体功能
所以REST的优点有:
- 隐藏资源的访问行为,无法通过地址得知对资源是何种操作
- 书写简化
但是我们的问题也随之而来了,一个相同的url地址即可以是新增也可以是修改或者查询,那么到底我们该如何区分该请求到底是什么操作呢?
- 按照REST风格访问资源时使用行为动作区分对资源进行了何种操作
http://localhost/users
查询全部用户信息 GET(查询)http://localhost/users/1
查询指定用户信息 GET(查询)http://localhost/users
添加用户信息 POST(新增/保存)http://localhost/users
修改用户信息 PUT(修改/更新)http://localhost/users/1
删除用户信息 DELETE(删除)
请求的方式比较多,但是比较常用的就4种,分别是GET
,POST
,PUT
,DELETE
。
按照不同的请求方式代表不同的操作类型。
- 发送GET请求是用来做查询
- 发送POST请求是用来做新增
- 发送PUT请求是用来做修改
- 发送DELETE请求是用来做删除
但是注意:
- 上述行为是约定方式,约定不是规范,可以打破,所以称REST风格,而不是REST规范
- REST提供了对应的架构方式,按照这种架构设计项目可以降低开发的复杂性,提高系统的可伸缩性
- REST中规定GET/POST/PUT/DELETE针对的是查询/新增/修改/删除,但是我们如果非要用GET请求做删除,这点在程序上运行是可以实现的
- 但是如果绝大多数人都遵循这种风格,你写的代码让别人读起来就有点莫名其妙了。
- 描述模块的名称通常使用复数,也就是加s的格式描述,表示此类资源,而非单个资源,例如:users、books、accounts…
清楚了什么是REST风格后,我们后期会经常提到一个概念叫RESTful
,那什么又是RESTful呢?
- 根据REST风格对资源进行访问称为RESTful。
后期我们在进行开发的过程中,大多是都是遵从REST风格来访问我们的后台服务,所以可以说咱们以后都是基于RESTful来进行开发的。
5.2 RESTful入门案例
创建对应的配置类
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[]{"/"};}//乱码处理@Overrideprotected Filter[] getServletFilters() {CharacterEncodingFilter filter = new CharacterEncodingFilter();filter.setEncoding("UTF-8");return new Filter[]{filter};}
}@Configuration
@ComponentScan({"com.itheima.controller"})
@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")@ResponseBodypublic String save(@RequestBody User user) {System.out.println("user save..."+user);return "{'module':'user save'}";}@RequestMapping("/delete")@ResponseBodypublic String delete(Integer id) {System.out.println("user delete..." + id);return "{'module':'user delete'}";}@RequestMapping("/update")@ResponseBodypublic String update(@RequestBody User user) {System.out.println("user update..." + user);return "{'module':'user update'}";}@RequestMapping("/getById")@ResponseBodypublic String getById(Integer id) {System.out.println("user getById..." + id);return "{'module':'user getById'}";}@RequestMapping("/findAll")@ResponseBodypublic String getAll() {System.out.println("user getAll...");return "{'module':'user getAll'}";}
}@Controller
public class BookController {@RequestMapping(value = "/books",method = RequestMethod.POST)@ResponseBodypublic String save(@RequestBody Book book){System.out.println("book save..." + book);return "{'module':'book save'}";}@RequestMapping(value = "/books/{id}",method = RequestMethod.DELETE)@ResponseBodypublic String delete(@PathVariable Integer id){System.out.println("book delete..." + id);return "{'module':'book delete'}";}@RequestMapping(value = "/books",method = RequestMethod.PUT)@ResponseBodypublic String update(@RequestBody Book book){System.out.println("book update..." + book);return "{'module':'book update'}";}@RequestMapping(value = "/books/{id}",method = RequestMethod.GET)@ResponseBodypublic String getById(@PathVariable Integer id){System.out.println("book getById..." + id);return "{'module':'book getById'}";}@RequestMapping(value = "/books",method = RequestMethod.GET)@ResponseBodypublic String getAll(){System.out.println("book getAll...");return "{'module':'book getAll'}";}}
最终创建好的项目结构如下:
运行流程的问答和解析
这段代码可以看作是一个基于Spring MVC框架的RESTful风格的Web应用程序。程序的运行流程一般如下:
- 用户在浏览器中输入访问地址,例如 http://localhost:8080/books/1 。
- Tomcat服务器接收到该请求,并将其转发给DispatcherServlet。
- DispatcherServlet根据@RequestMapping注解中的映射路径/books,找到对应的BookController类。
- 根据请求方法的不同,DispatcherServlet根据@RequestMapping注解中的请求方法类型(如@GetMapping、@PostMapping等)找到对应的方法(如getById、save等)。
- 如果方法需要传递参数,则会从请求中获取参数并将其注入到方法中。例如@GetMapping(“/{id}”)中的{id}就会获取请求路径/books/1中的1作为参数传递给方法。
- 方法执行完成后,返回一个字符串类型的响应内容,例如"{‘module’:‘book getById’}"。
- DispatcherServlet将响应内容封装成HTTP响应返回给Tomcat服务器。
- Tomcat服务器将响应内容返回给用户的浏览器。
在这个过程中,Spring MVC框架会自动完成许多工作,例如参数的自动注入、请求数据的转换等。同时,我们也可以通过注解来定制各个阶段的行为,以满足不同的需求。
Sherlok
那你能和我说说spring和spirngmvc的创建过程而不是访问的过程吗
chatGPT
当Spring MVC应用程序启动时,会经历以下几个主要的创建过程:
- 启动Web服务器(如Tomcat),Web服务器会加载并初始化Web应用程序的上下文。
- 加载Spring的配置文件,例如applicationContext.xml,创建Spring的应用程序上下文ApplicationContext。
- 扫描指定的包路径,加载所有带有@Component注
Sherlok
联系上下的代码进行讲解,就是之前我发的代码
chatgpt:
好的,接下来我将结合之前您提供的代码,进行Spring和Spring MVC的创建过程的讲解:
-
Spring的创建过程:
首先,Spring的配置文件SpringMvcConfig中使用了@Configuration注解来标识它是一个Java配置类,Spring会在启动时自动扫描该类,并加载其中的Bean定义。在该配置类中,我们使用了@ComponentScan注解来指定Spring扫描的包路径,从而加载所有带有@Component注解的Java类。在本例中,我们指定了com.itheima.controller包路径,因此Spring会自动扫描该路径下的BookController类,并将其作为Spring Bean进行注册。 -
Spring MVC的创建过程:
在Spring MVC的应用程序上下文中,DispatcherServlet是Spring MVC的核心组件。在本例中,我们使用了AbstractAnnotationConfigDispatcherServletInitializer类来代替web.xml配置文件,从而初始化DispatcherServlet。在ServletContainersInitConfig类中,我们覆盖了该类中的getServletConfigClasses()方法,指定了Spring MVC的配置类SpringMvcConfig,以此告诉DispatcherServlet要使用该配置类来初始化Spring MVC的应用程序上下文。在SpringMvcConfig配置类中,我们使用了@EnableWebMvc注解来开启Spring MVC的默认配置。此外,我们还使用了@RestController和@RequestMapping注解来标识BookController类是一个RESTful风格的Web控制器,同时指定了/books路径用于映射到该控制器。
综上所述,当Web服务器启动后,Spring会加载Spring配置文件,并扫描指定的包路径,加载所有带有@Component注解的Java类,并将其作为Spring Bean进行注册。在此过程中,DispatcherServlet也被初始化,并根据指定的Spring MVC配置类来创建Spring MVC的应用程序上下文。随后,DispatcherServlet会根据@RequestMapping注解中的映射路径,找到对应的控制器方法,并执行它们。最后,DispatcherServlet将响应内容封装成HTTP响应返回给Web服务器,最终返回给用户的浏览器。
Sherlok
也就是tomcat程序会先执行ServletContainersInitConfig 的所有方法?。。我的想法是先运行getRootConfigClasses和getServletConfigClasses加载spring和springmvc容器,创建其中的bean对象 之后调用getServletMappings和getServletFilters 创建 sprimvc拦截路径和过滤器,?当用户访问时候/book,Bookcontroller实例化对象才调用对应的方法??
chatgpt :
您的理解基本正确。具体来说,Tomcat在启动时会先加载Spring MVC的DispatcherServlet,然后再调用ServletContainersInitConfig类的相关方法来初始化DispatcherServlet的应用程序上下文。
在这个过程中,首先会调用getRootConfigClasses()方法来加载Spring的配置文件,这里的配置文件主要用于配置一些与Web请求无关的Bean。在本例中,getRootConfigClasses()方法返回一个空数组,表示没有这样的配置文件。接着,Tomcat会调用getServletConfigClasses()方法来加载Spring MVC的配置文件,该文件主要用于配置Web请求相关的Bean,例如控制器和视图解析器等。在本例中,getServletConfigClasses()方法返回了一个SpringMvcConfig类,该类被用来初始化Spring MVC的应用程序上下文。
在Spring MVC的应用程序上下文被初始化之后,Tomcat会调用getServletMappings()方法来配置DispatcherServlet的URL映射,即指定DispatcherServlet监听哪些URL请求。在本例中,getServletMappings()方法返回了一个包含"/"路径的字符串数组,表示DispatcherServlet将监听所有URL请求。最后,Tomcat会调用getServletFilters()方法来配置DispatcherServlet的过滤器,例如乱码过滤器等。在本例中,我们添加了一个CharacterEncodingFilter过滤器,用于处理请求和响应的乱码问题。
当用户访问/books路径时,DispatcherServlet会根据@RequestMapping注解中的映射路径找到对应的BookController类和方法,并执行它们。在执行方法的过程中,Spring会自动将请求中的参数和请求体映射成Java对象,并将结果自动转换为JSON格式的字符串。最后,DispatcherServlet将该JSON字符串封装成HTTP响应返回给用户的浏览器。
Sherlok:
getServletConfigClasses方法 会到springmvc类中创建BookController的实例化bean对象吗?我的想法是运行在ServletContainersInitConfig 类的getServletConfigClasses 方法会到扫描到control包下的BookController类创建实例化对象的。。创建玩springmvc的实例化contro包下对象 才会 继续调用接下来ServletContainersInitConfig 类的getServletMappings()和getServletFilters()
chatgpt:
是的,您的想法是正确的。在执行getServletConfigClasses()方法时,会扫描Spring MVC配置类SpringMvcConfig.class中所指定的包路径(即com.itheima.controller),并创建包路径下所有的控制器类(如BookController)的实例化对象。这些对象将成为Spring MVC的处理器对象,并用于接收和处理来自客户端的请求。
在这之后,getServletMappings()方法会设置Spring MVC的前置控制器(DispatcherServlet)所监听的请求路径,即/,这意味着所有的请求都将交由Spring MVC的前置控制器处理。
最后,在getServletFilters()方法中可以配置一些过滤器,以对请求进行一些预处理(如乱码处理等)。
当客户端发起请求时,请求将首先到达前置控制器,前置控制器将根据请求的路径和请求方法选择相应的处理器对象(如BookController中的方法),并将请求传递给它。处理器对象将根据请求中的参数和请求体进行处理,并返回一个响应结果。最终,前置控制器将将响应结果进行封装,并将其返回给客户端。
5.2.2 思路分析
需求:将之前的增删改查替换成RESTful的开发方式。
1.之前不同的请求有不同的路径,现在要将其修改为统一的请求路径
修改前: 新增: /save ,修改: /update,删除 /delete…
修改后: 增删改查: /users
2.根据GET查询、POST新增、PUT修改、DELETE删除对方法的请求方式进行限定
3.发送请求的过程中如何设置请求参数?
5.2.3 修改RESTful风格
新增
@Controller
public class UserController {//设置当前请求方法为POST,表示REST风格中的添加操作@RequestMapping(value = "/users",method = RequestMethod.POST)@ResponseBodypublic String save() {System.out.println("user save...");return "{'module':'user save'}";}
}
-
将请求路径更改为
/users
- 访问该方法使用 POST:
http://localhost/users
- 访问该方法使用 POST:
-
使用method属性限定该方法的访问方式为
POST
- 如果发送的不是POST请求,比如发送GET请求,则会报错
删除
@Controller
public class UserController {//设置当前请求方法为DELETE,表示REST风格中的删除操作@RequestMapping(value = "/users",method = RequestMethod.DELETE)@ResponseBodypublic String delete(Integer id) {System.out.println("user delete..." + id);return "{'module':'user delete'}";}
}
- 将请求路径更改为
/users
- 访问该方法使用 DELETE:
http://localhost/users
- 访问该方法使用 DELETE:
访问成功,但是删除方法没有携带所要删除数据的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)@ResponseBodypublic String delete(@PathVariable Integer id) {System.out.println("user delete..." + id);return "{'module':'user delete'}";}
}
思考如下两个问题:
(1)如果方法形参的名称和路径{}
中的值不一致,该怎么办?
(2)如果有多个参数需要传递该如何编写?
前端发送请求的时候使用:http://localhost/users/1/tom
,路径中的1
和tom
就是我们想要传递的两个参数。
后端获取参数,需要做如下修改:
@Controller
public class UserController {//设置当前请求方法为DELETE,表示REST风格中的删除操作@RequestMapping(value = "/users/{id}/{name}",method = RequestMethod.DELETE)@ResponseBodypublic 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)@ResponseBodypublic String update(@RequestBody User user) {System.out.println("user update..." + user);return "{'module':'user update'}";}
}
-
将请求路径更改为
/users
- 访问该方法使用 PUT:
http://localhost/users
- 访问该方法使用 PUT:
-
访问并携带参数:
-
根据ID查询
@Controller
public class UserController {//设置当前请求方法为GET,表示REST风格中的查询操作@RequestMapping(value = "/users/{id}" ,method = RequestMethod.GET)@ResponseBodypublic 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)@ResponseBodypublic 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
名称 | @PathVariable |
---|---|
类型 | 形参注解 |
位置 | SpringMVC控制器方法形参定义前面 |
作用 | 绑定路径参数与处理器方法形参间的关系,要求路径参数名与形参名一一对应 |
关于接收参数,我们学过三个注解@RequestBody
、@RequestParam
、@PathVariable
,这三个注解之间的区别和应用分别是什么?
- 区别
- @RequestParam用于接收url地址传参或表单传参
- @RequestBody用于接收json数据
- @PathVariable用于接收路径参数,使用{参数名称}描述路径参数
- 应用
- 后期开发中,发送请求参数超过1个时,以json格式为主,@RequestBody应用较广
- 如果发送非json格式数据,选用@RequestParam接收请求参数
- 采用RESTful进行开发,当参数数量较少时,例如1个,可以采用@PathVariable接收请求路径变量,通常用于传递id值
5.3 RESTful快速开发
做完了RESTful的开发,你会发现好麻烦,麻烦在哪?
问题1:每个方法的@RequestMapping注解中都定义了访问路径/books,重复性太高。
问题2:每个方法的@RequestMapping注解中都要使用method属性定义请求方式,重复性太高。
问题3:每个方法响应json都需要加上@ResponseBody注解,重复性太高。
对于上面所提的这三个问题,具体该如何解决?
@RestController //@Controller + ReponseBody
@RequestMapping("/books")
public class BookController {//@RequestMapping(method = RequestMethod.POST)@PostMappingpublic 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)@PutMappingpublic 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)@GetMappingpublic 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
名称 | @RestController |
---|---|
类型 | 类注解 |
位置 | 基于SpringMVC的RESTful开发控制器类定义上方 |
作用 | 设置当前控制器类为RESTful风格, 等同于@Controller与@ResponseBody两个注解组合功能 |
知识点2:@GetMapping @PostMapping @PutMapping @DeleteMapping
名称 | @GetMapping @PostMapping @PutMapping @DeleteMapping |
---|---|
类型 | 方法注解 |
位置 | 基于SpringMVC的RESTful开发控制器方法定义上方 |
作用 | 设置当前控制器方法请求访问路径与请求动作,每种对应一个请求动作, 例如@GetMapping对应GET请求 |
相关属性 | value(默认):请求访问路径 |
5.4 RESTful案例
5.4.1 需求分析
需求一:图片列表查询,从后台返回数据,将数据展示在页面上
需求二:新增图片,将新增图书的数据传递到后台,并在控制台打印
**说明:**此次案例的重点是在SpringMVC中如何使用RESTful实现前后台交互,所以本案例并没有和数据库进行交互,所有数据使用假
数据来完成开发。
步骤分析:
1.搭建项目导入jar包
2.编写Controller类,提供两个方法,一个用来做列表查询,一个用来做新增
3.在方法上使用RESTful进行路径设置
4.完成请求、参数的接收和结果的响应
5.使用PostMan进行测试
6.将前端页面拷贝到项目中
7.页面发送ajax请求
8.完成页面数据的展示
5.4.2 环境准备
创建对应的配置类
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[]{"/"};}//乱码处理@Overrideprotected Filter[] getServletFilters() {CharacterEncodingFilter filter = new CharacterEncodingFilter();filter.setEncoding("UTF-8");return new Filter[]{filter};}
}@Configuration
@ComponentScan("com.itheima.controller")
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMvcConfig {
}
编写模型类Book
public class Book {private Integer id;private String type;private String name;private String description;//setter...getter...toString略
}
编写BookController
@Controller
public class BookController {}
最终创建好的项目结构如下:
5.4.2 后台接口开发
步骤1:编写Controller类并使用RESTful进行配置
@RestController
@RequestMapping("/books")
public class BookController {@PostMappingpublic String save(@RequestBody Book book){System.out.println("book save ==> "+ book);return "{'module':'book save success'}";}@GetMappingpublic 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":"这是一本好书"
}
测试查询
5.4.3 页面访问处理
步骤1:拷贝静态页面
将资料\功能页面
下的所有内容拷贝到项目的webapp
目录下
步骤2:访问pages目录下的books.html
打开浏览器输入http://localhost/pages/books.html
(1)出现错误的原因?
SpringMVC拦截了静态资源,根据/pages/books.html去controller找对应的方法,找不到所以会报404的错误。
(2)SpringMVC为什么会拦截静态资源呢?
(3)解决方案?
- SpringMVC需要将静态资源进行放行。定义@Configuration注解让加载SpringMvcConfig类的时候扫到,所以我们得在SpringMvcConfig类的@ComponentScan注解这样写@ComponentScan({“com.itheima.controller”,“com.itheima.config”})
@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {//设置静态资源访问过滤,当前类需要设置为配置类,并被扫描加载@Overrideprotected 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/");}
}
方法作用
方法作用来源
registry.addResourceHandler(“/assets/**”) //表示文件路径,这里的意思是assets包下的所有文件
.addResourceLocations(“classpath:/assets/js/”); //表示要开放的资源,这里的意思是开放assets包下的js则可以访问,如果assets下还有css不开放,则css无法使用
该配置类是在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 --><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-paginationclass="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>