Spring-MVC
1.SpringMVC简介
- SpringMVC概述
SpringMVC是一个基于Spring开发的MVC轻量级框架,Spring3.0后发布的组件,SpringMVC和Spring可以无缝整合,使用DispatcherServlet作为前端控制器,且内部提供了处理器映射器、处理器适配器、视图解析器等组件,可以简化JavaBean封装,Json转化、文件上传等操作。
- SpringMVC快速入门
(1)导入Spring-webmvc坐标
(2)编写一个控制器Controller,配置映射信息
(3)在web.xml中配置SpringMVC的前端控制器ServletDispatcher
<servlet><servlet-name>DispatcherServlet</servlet-name><servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class><!--指定springMVC配置文件位置--><init-param><param-name>contextConfigLocation</param-name><param-value>classpath:spring-mvc.xml</param-value></init-param><!--服务器启动就创建--><load-on-startup>2</load-on-startup>
</servlet><servlet-mapping><servlet-name>DispatcherServlet</servlet-name><url-pattern>/</url-pattern>
</servlet-mapping>
(4)创建springMVC的核心配置文件 spring-mvc.xml,并配置组件扫描web层
<?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/xmlSchema-instance"xmlns:mvc="http://www.springframework.org/schema/mvc"xmlns:context="http://www.springframework.org/schema/context"xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsdhttp://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd"><!-- 组件扫描web层 --><context:component-scan base-package="com.itheima.controller"/></beans>
- Controller中访问容器中的Bean
配置Spring容器
在web.xml中配置ContextLoaderListener
<!--配置ContextLoaderListener-->
<context-param><param-name>contextConfigLocation</param-name><param-value>classpath:applictionContext.xml</param-value>
</context-param>
<listener><listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
在Controller中使用@Autowire注入service
Controller层是在SpringMVC容器中,Service,Dao层是在Spring容器中
- SpringMVC关键组件浅析
组件的关系
SpringMVC的默认组件,SpringMVC 在前端控制器 DispatcherServlet加载时,就会进行初始化操作,在进行初始化时,就会加载SpringMVC默认指定的一些组件,这些默认组件配置在 DispatcherServlet.properties 文件中,该文件存在与spring-webmvc-5.3.7.jar包下的org\springframework\web\servlet\DispatcherServlet.properties
org.springframework.web.servlet.HandlerMapping=org.springframework.web.servlet.handler.BeanNameUrl
HandlerMapping,\org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping,\org.springframework.web.servlet.function.support.RouterFunctionMapping
org.springframework.web.servlet.HandlerAdapter=org.springframework.web.servlet.mvc.HttpRequestHand
lerAdapter,\org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter,\org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter,\org.springframework.web.servlet.function.support.HandlerFunctionAdapter
org.springframework.web.servlet.ViewResolver=org.springframework.web.servlet.view.InternalResource
ViewResolver
配置组件代替默认组件,如果不想使用默认组件,可以将替代方案使用Spring Bean的方式进行配置,例如,在spring-mvc.xml中配置RequestMappingHandlerMapping
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping"/>
当我们在Spring容器中配置了HandlerMapping,则就不会在加载默认的HandlerMapping策略了,原理比较简单,DispatcherServlet 在进行HandlerMapping初始化时,先从SpringMVC容器中找是否存在HandlerMapping,如果存在直接取出容器中的HandlerMapping,在存储到 DispatcherServlet 中的handlerMappings集合中去。
2.SpringMVC的请求处理
- 请求映射路径的配置
配置映射路径,映射器处理器才能找到Controller的方法资源,目前主流映射路径配置方式就是@RequestMapping
@RequestMapping 在类上使用,@RequestMapping 、@GetMapping、@PostMapping还可以使用在Controller类上,使用在类上后,该类所有方法都公用该@RequestMapping设置的属性,访问路径则为类上的映射地址+方法上的映射地址
- 请求数据的接收
接收普通请求数据,当客户端提交的数据是普通键值对形式时,直接使用同名形参接收即可
接收普通请求数据,当请求参数有特殊格式数据,如日期时
Date可以正常接收,因为Spring内置的类型解析器,可以识别的日期格式是 yyyy/MM/dd。如果想使用自定义的日期解析格式,使用@DateTimeFormat 指定日期格式
接收普通请求数据,当请求参数的名称与方法参数名不一致时,可以使用@RequestParam注解进行标注
接收实体JavaBean属性数据,单个JavaBean数据:提交的参数名称只要与Java的属性名一致,就可以进行自动封装
接收数组或集合数据,客户端传递多个同名参数时,可以使用数组接收
接收数组或集合数据,客户端传递多个同名参数时,也可以使用单列集合接收,但是需要使用@RequestParam告知框架传递的参数是要同名设置的,不是对象属性设置的
接收Json数据格式数据,Json数据都是以请求体的方式提交的,且不是原始的键值对格式的,所以我们要使用@RequestBody注解整体接收该数据。
将json转成javebean,使用了SpringMVC的组件RequestMappingHandlerAdapter
接收Restful风格数据,Restful请求数据一般会在URL地址上携带,可以使用注解 @PathVariable(占位符参数名称)
接收文件上传的数据,文件上传的表单需要一定的要求,如下:
表单的提交方式必须是POST表单的enctype属性必须是multipart/form-data文件上传项需要有name属性
<form action="" enctype="multipart/form-data"><input type="file" name="myFile">
</form>
服务器端,由于映射器适配器需要文件上传解析器,而该解析器默认未被注册,所以手动注册
<!--配置文件上传解析器,注意:id的名字是固定写法-->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"><property name="defaultEncoding" value="UTF-8"/><!--文件的编码格式 默认是ISO8859-1--><property name="maxUploadSizePerFile" value="1048576"/><!--上传的每个文件限制的大小 单位字节--><property name="maxUploadSize" value="3145728"/><!--上传文件的总大小--><property name="maxInMemorySize" value="1048576"/><!--上传文件的缓存大小-->
</bean>
使用MultipartFile类型接收上传文件
@PostMapping("/fileUpload")
public String fileUpload(@RequestBody MultipartFile myFile) throws IOException {System.out.println(myFile);//获得上传的文件的流对象InputStream inputStream = myFile.getInputStream();//使用commons-io存储到C:\haohao\abc.txt位置FileOutputStream outputStream = new FileOutputStream("C:\\Users\\haohao\\"+myFile.getOriginalFilename());IOUtils.copy(inputStream,outputStream);//关闭资源inputStream.close();outputStream.close();return "/index.jsp";
}
接收Http请求头数据,接收指定名称的请求头
接收所有的请求头信息
获得客户端携带的Cookie数据
获得转发Request域中数据,在进行资源之间转发时,有时需要将一些参数存储到request域中携带给下一个资源
- Javaweb常用对象获取
获得Javaweb常见原生对象,有时在我们的Controller方法中需要用到Javaweb的原生对象,例如:Request、Response等,我们只需要将需要的对象以形参的形式写在方法上,SpringMVC框架在调用Controller方法时,会自动传递实参:
- 请求静态资源
静态资源请求失效的原因,当DispatcherServlet的映射路径配置为 / 的时候,那么就覆盖的Tomcat容器默认的缺省Servlet
解决方案
在spring-mvc.xml中去配置< mvc:default-servlet-handler >,该方式是注册了一个DefaultServletHttpRequestHandler 处理器,静态资源的访问都由该处理器去处理,这也是开发中使用最多的
<mvc:default-servlet-handler/>
- 注解驱动 mvc:annotation-driven 标签
该标签内部会帮我们注册RequestMappingHandlerMapping、注册RequestMappingHandlerAdapter并注入Json消息转换器等
原配置
现配置
3.SpringMVC的响应处理
- 传统同步业务数据响应
请求资源转发;
请求资源重定向;
响应模型数据;
直接回写数据给客户端;
- 前后端分离异步业务数据响应
此处@ResponseBody也可以将JavaBean自动给我们转换成Json格式字符串回响应
@RestController替代@Controller和@ResponseBody
4.SpringMVC的拦截器
- 拦截器 Interceptor 简介
SpringMVC的拦截器Interceptor规范,主要是对Controller资源访问时进行拦截操作的技术,当然拦截后可以进行权限控制,功能增强等都是可以的。拦截器有点类似 Javaweb 开发中的Filter,拦截器与Filter的区别如下图:
HandlerInterceptor接口方法的作用及其参数、返回值详解如下:
- 拦截器快速入门
配置Interceptor
<!--配置拦截器-->
<mvc:interceptors><mvc:interceptor><!--配置对哪些资源进行拦截操作--><mvc:mapping path="/*"/><bean class="com.itheima.interceptor.MyInterceptor01"></bean></mvc:interceptor>
</mvc:interceptors>
- 拦截器执行顺序
当每个拦截器都是放行状态时,三个方法的执行顺序如下:
当Interceptor1和Interceptor2处于放行,Interceptor3处于不放行时,三个方法的执行顺序如下
拦截器执行顺序取决于 interceptor 的配置顺序
- 拦截器执行原理
请求到来时先会使用组件HandlerMapping去匹配Controller的方法(Handler)和符合拦截路径的Interceptor,Handler和多个Interceptor被封装成一个HandlerExecutionChain的对象
在DispatcherServlet的doDispatch方法中执行拦截器
5.SpringMVC的全注解开发
- spring-mvc.xml 中组件转化为注解形式
关于SpringMvc的xml
组件扫描,可以通过@ComponentScan注解完成;
文件上传解析器multipartResolver可以通过非自定义Bean的注解配置方式,即@Bean注解完成
<mvc:default-servlet-handler /> 和 <mvc:interceptor > 怎么办呢?SpringMVC 提供了一个注解叫做@EnableWebMvc,我们看一下源码,内部通过@Import 导入了DelegatingWebMvcConfiguration类,WebMvcConfigurer类型的Bean会被注入进来,然后被自动调用,所以可以实现WebMvcConfigurer接口,完成一些解析器、默认Servlet等的指定,WebMvcConfigurer接口定义如下:
创建MyWebMvcConfigurer实现WebMvcConfigurer接口,实现addInterceptors 和configureDefaultServletHandling方法
最后,在SpringMVC核心配置类上添加@EnableWebMvc注解
- DispatcherServlet加载核心配置类
DispatcherServlet在进行SpringMVC配置文件加载时,使用的是以下方式:
现在是使用SpringMVCConfig核心配置类提替代的spring-mvc.xml,怎么加载呢?参照Spring的ContextLoaderListener加载核心配置类的做法,定义了一个AnnotationConfigWebApplicationContext,通过代码注册核心配置类
- 消除web.xml
目前,几乎消除了配置文件,但是web工程的入口还是使用的web.xml进行配置的,如下
Servlet3.0环境中,web容器提供了javax.servlet.ServletContainerInitializer接口,实现了该接口后,在对应的类加载路径的META-INF/services 目录创建一个名为javax.servlet.ServletContainerInitializer的文件,文件内容指定具体的ServletContainerInitializer实现类,那么,当web容器启动时就会运行这个初始化器做一些组件内的初始化工作;
基于这个特性,Spring就定义了一个SpringServletContainerInitializer实现了ServletContainerInitializer接口;
而SpringServletContainerInitializer会查找实现了WebApplicationInitializer的类,Spring又提供了一个WebApplicationInitializer的基础实现类AbstractAnnotationConfigDispatcherServletInitializer,当我们编写类继承AbstractAnnotationConfigDispatcherServletInitializer时,容器就会自动发现我们自己的类,在该类中我们就可以配置Spring和SpringMVC的入口了。
6.SpringMVC的组件原理剖析
- 前端控制器初始化
前端控制器DispatcherServlet是SpringMVC的入口,也是SpringMVC的大脑,主流程的工作都是在此完成的,梳理一下DispatcherServlet 代码。DispatcherServlet 本质是个Servlet,当配置了 load-on-startup 时,会在服务器启动时就执行创建和执行初始化init方法,每次请求都会执行service方法
DispatcherServlet 的初始化主要做了两件事:
(1)获得了一个 SpringMVC 的 ApplicationContext容器,设置父子容器
父容器:Spring 通过ContextLoaderListener为入口产生的applicationContext容器,内部主要维护的是applicationContext.xml(或相应配置类)配置的Bean信息;
子容器:SpringMVC通过DispatcherServlet的init() 方法产生的applicationContext容器,内部主要维护的是spring-mvc.xml(或相应配置类)配置的Bean信息,且内部还通过parent属性维护这父容器的引用。
Bean的检索顺序:根据上面子父容器的概念,可以知道Controller存在与子容器中,而Controller中要注入Service时,会先从子容器本身去匹配,匹配不成功时在去父容器中去匹配,于是最终从父容器中匹配到的UserService,这样子父容器就可以进行联通了。但是父容器只能从自己容器中进行匹配,不能从子容器中进
行匹配。
(2)注册了 SpringMVC的 九大组件
注册 SpringMVC的 九大组件,在初始化容器initWebApplicationContext方法中执行了onRefresh方法,进而执行了初始化策略initStrategies方法,注册了九个解析器组件
在初始化前端控制器时,会先去父子容器中找到是否有对应的HandlerMapping(自己配置的),如果没有就加载默认的
- 前端控制器执行主流程
7.SpringMVC的异常处理机制
- SpringMVC 异常的处理流程
SpringMVC 处理异常的思路是,一路向上抛,都抛给前端控制器 DispatcherServlet ,DispatcherServlet 在调用异常处理器ExceptionResolver进行处理,如下图:
- SpringMVC 的异常处理方式
(1)简单异常处理器:使用SpringMVC 内置的异常处理器处理 SimpleMappingExceptionResolver;
注解方式配置简单映射异常处理器
(2)自定义异常处理器:实现HandlerExceptionResolver接口,自定义异常进行处理;
交给Spring管理异常处理器
(3)注解方式:使用@ControllerAdvice + @ExceptionHandler 来处理。
@ControllerAdvice 注解本质是一个@Component,也会被扫描到,与此同时,具备AOP功能,默认情况下对所有的Controller都进行拦截操作,
拦截后干什么呢?就需要在结合@ExceptionHandler、@InitBinder、@ModelAttribute 注解一起使用了,此处我们讲解的是异常,所以是@ControllerAdvice + @ExceptionHandler的组合形式。
编写全局异常处理器类,使用@ControllerAdvice标注,且@ExceptionHandler指定异常类型
如果全局异常处理器响应的数据都是Json格式的字符串的话,可以使用@RestControllerAdvice替代@ControllerAdvice 和 @ResponseBody
- 异常处理机制原理剖析
初始化加载异常处理解析器,配置了自定义的异常处理器后,默认的异常处理器就不会被加载,当配置<mvc:annotation-driven /> 或配置了注解@EnableWebMvc后,默认异常处理器和自定的处理器异常解析器都会被注册
在发生异常后,获得当前发生异常的Handler对象,执行对应方法
- SpringMVC 常用的异常解析器.
SpringMVC 相关的处理器异常解析器继承体系如下:
SpringMVC 常用的异常解析器