SpringMVC源码剖析之SpringMVC工作流程

SpringMVC九大组件

• HandlerMapping（处理器映射器）

HandlerMapping 是⽤来查找 Handler 的，也就是处理器，具体的表现形式可以是类，也可以是⽅法。

⽐如，标注了@RequestMapping的每个⽅法都可以看成是⼀个Handler。Handler负责具      体实际的请求处理，在请求到达后，HandlerMapping 的作⽤便是找到请求相应的处理器Handler 和 Interceptor.

• HandlerAdapter（处理器适配器）

HandlerAdapter 是⼀个适配器。因为 Spring MVC 中 Handler 可以是任意形式的，只要能处理请求即可。但是把请求交给 Servlet 的时候，由于 Servlet 的⽅法结构都是doService(HttpServletRequest req,HttpServletResponse resp)形式的，要让固定的 Servlet 处理 ⽅法调⽤ Handler 来进⾏处理，便是 HandlerAdapter 的职责。

• HandlerExceptionResolver（handler的异常解析器）

HandlerExceptionResolver ⽤于处理 Handler 产⽣的异常情况。它的作⽤是根据异常设置ModelAndView，之后交给渲染⽅法进⾏渲染，渲染⽅法会将 ModelAndView 渲染成⻚⾯。

• ViewResolver（视图解析器）

ViewResolver即视图解析器，⽤于将String类型的视图名和Locale解析为View类型的视图，只有⼀个resolveViewName()⽅法。从⽅法的定义可以看出，Controller层返回的String类型视图名viewName 最终会在这⾥被解析成为View。View是⽤来渲染⻚⾯的，也就是说，它会将程序返回的参数和数据填⼊模板中，⽣成html⽂件。

**ViewResolver 在这个过程主要完成两件事情**: ViewResolver 找到渲染所⽤的模板（第⼀件⼤事）和所⽤的技术（第⼆件⼤事，其实也就是找到视图的类型，如JSP）并填⼊参数。默认情况下，Spring MVC会⾃动为我们配置⼀个InternalResourceViewResolver,是针对 JSP 类型视图的。

• RequestToViewNameTranslator

RequestToViewNameTranslator 组件的作⽤是从请求中获取 ViewName.因为 ViewResolver 根据ViewName 查找 View，但有的 Handler 处理完成之后,没有设置 View，也没有设置 ViewName， 便要通过这个组件从请求中查找 ViewName。

• LocaleResolver(国际化解析器)

ViewResolver 组件的 resolveViewName ⽅法需要两个参数，⼀个是视图名，⼀个是 Locale。LocaleResolver ⽤于从请求中解析出 Locale，⽐如中国 Locale 是 zh-CN，⽤来表示⼀个区域。这个组件也是 i18n 的基础。

• ThemeResolver

ThemeResolver 组件是⽤来解析主题的。主题是样式、图⽚及它们所形成的显示效果的集合。

Spring MVC 中⼀套主题对应⼀个 properties⽂件，⾥⾯存放着与当前主题相关的所有资源，如图⽚、CSS样式等。创建主题⾮常简单，只需准备好资源，然后新建⼀个“主题名.properties”并将资源设置进去，放在classpath下，之后便可以在⻚⾯中使⽤了。

SpringMVC中与主题相关的类有ThemeResolver、ThemeSource和Theme。ThemeResolver负责从请求中解析出主题名， ThemeSource根据主题名找到具体的主题，其抽象也就是Theme，可以通过Theme来获取主题和      具体的资源。

• MultipartResolver(文件请求解析器)

MultipartResolver ⽤于上传请求，通过将普通的请求包装成 MultipartHttpServletRequest 来实现。MultipartHttpServletRequest 可以通过 getFile() ⽅法 直接获得⽂件。如果上传多个⽂件，还可以调⽤ getFileMap()⽅法得到Map<FileName，File>这样的结构，MultipartResolver 的作⽤就是封装普通的请求，使其拥有⽂件上传的功能。

• FlashMapManager

FlashMap ⽤于重定向时的参数传递，⽐如在处理⽤户订单时候，为了避免重复提交，可以处理完post请求之后重定向到⼀个get请求，这个get请求可以⽤来显示订单详情之类的信息。这样做虽然 可以规避⽤户重新提交订单的问题，但是在这个⻚⾯上要显示订单的信息，这些数据从哪⾥来获得 呢？因为重定向时么有传递参数这⼀功能的，如果不想把参数写进URL（不推荐），那么就可以通 过FlashMap来传递。只需要在重定向之前将要传递的数据写⼊请求（可以通过

ServletRequestAttributes.getRequest()⽅法获得）的属性OUTPUT_FLASH_MAP_ATTRIBUTE

中，这样在重定向之后的Handler中Spring就会⾃动将其设置到Model中，在显示订单信息的⻚⾯上就可以直接从Model中获取数据。FlashMapManager 就是⽤来管理 FalshMap 的。

准备

@RestController
@RequestMapping("/user")
public class UserController{

    @InitBinder
    public void initBinder(WebDataBinder binder){
        // 字符串 转 date类型
        binder.registerCustomEditor(Date.class,new PropertyEditorSupport(){
            @SneakyThrows
            @Override
            public void setAsText(String text) throws IllegalArgumentException {
               setValue( new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").parse(text));
            }
        });
    }

    @PostMapping
    public Object addUser(@RequestBody User user){
        System.out.println("handler 方法被调用");
        System.out.println(user);
        return "添加成功";
    }


    @GetMapping("{id}")
    public Object getUser(@PathVariable Integer id){
        System.out.println("handler 方法被调用");
        return new User(id,"张三","男",18,null);
    }
}

SpringMVC工作流程分析

DispatcherServlet 本质上是一个Servlet,用来处理客户端发送的请求

1、DispatcherServlet - doDispatch 处理前端发送的请求

2、通过multipartReserver判断当前请求，是不是文件上传请求

具体是通过校验请求的contentType是不是以 multipart/ 开头

校验是不是文件上传请求

3、通过handlerMapping（RequestHandlerMapping），匹配url，获取到当前请求对应的handler。匹配url，获取handler对应的所有interceptor

获取系统默认的handlerMappings，找到RequestMappingHandlerMapping，

通过mappingRegistry 获取到全部的RequestMappingInfo信息，通过url，获取到最终匹配的handler

遍历所有的interceptor，如果当前handler的url匹配，那么将当前的interceptor放入handler中

4、获取handler匹配的handlerAdapter，因为handler的实现方式有多种，一种是通过实现Controller定义handler，一种通过@RequestMapping定义handler等等

5、调用handler对应的interceptor的preHandler方法（走拦截器pre方法）

6、通过handlerAdapter 调用 handler方法，最终返回modelAndVIew，如果返回json对象给前端，那么MAV为null

6.1、获取dataBinder工厂 ，通过获取handler所在类上的initBinder创建dataBinder工厂

private WebDataBinderFactory getDataBinderFactory(HandlerMethod handlerMethod) throws Exception {
		Class<?> handlerType = handlerMethod.getBeanType();
		Set<Method> methods = this.initBinderCache.get(handlerType);
		if (methods == null) {
			// 获取handler类上的iniBinder方法，简单来所就是判断是否存在@InitBinder
			methods = MethodIntrospector.selectMethods(handlerType, INIT_BINDER_METHODS);
			this.initBinderCache.put(handlerType, methods);
		}
		List<InvocableHandlerMethod> initBinderMethods = new ArrayList<>();
		// 获取全局的initBinder
		this.initBinderAdviceCache.forEach((clazz, methodSet) -> {
			if (clazz.isApplicableToBeanType(handlerType)) {
				Object bean = clazz.resolveBean();
				for (Method method : methodSet) {
					initBinderMethods.add(createInitBinderMethod(bean, method));
				}
			}
		});
		// 指定类上的initBinder
		for (Method method : methods) {
			Object bean = handlerMethod.getBean();
			initBinderMethods.add(createInitBinderMethod(bean, method));
		}
		return createDataBinderFactory(initBinderMethods);
	}

6.2、创建modelFactory工厂，获取modelMethod

6.3、为当前handler方法 设置参数解析器，返回值解析器，dataBinderFactory

默认的参数解析器

默认的返回值解析器

此时我们的handler目标方法，存放了dataBinderFactory，参数解析器，返回值解析器，所在Bean对象，handler方法，handler方法上的参数

6.3、开始调用真正的handler方法

7、获取handler上的方法参数，获取默认的参数解析器，遍历参数解析器，看是否支持，如果支持，那么通过参数解析器，解析当前参数

以参数上的@RequestBody为例，无非是判断参数上，是否存在@RequestBody注解，如果满足，那么当前的参数解析器就是满足的

通过参数解析器解析当前参数

参数解析参数，本质上是通过request进行的

参数是对象

例如： handler方法上存在参数 User user，方法上存在@RequestBody注解，那么找到RequestBodyReserver解析器，解析参数User。

通过request读取流的方式，封装成目标类型对象user

参数是普通参数

例如： handler方法上存在参数 Integer Id

然后通过request.getParameter(属性名)，获取request中的属性值，然后反射将属性值赋值给对应的属性。最终user对象通过反射创建完成，并且通过反射赋值成功

反射调用initBinder方法

通过解析到的参数 反射调用目标方法

8、遍历所有返回值解析器，通过匹配的返回值解析器，处理返回值，例如ResponseBody返回值处理器，向客户端返回json。modelAndView返回值处理器返回ModelAndView

返回值处理的原理也跟参数处理器一样，通过判断当前handler方法上是否存在对应的注解，来匹配返回值处理器

例如: 方法上存在@ResponseBody，那么通过ResponseBodyReturnValueHandler进行处理，将对象转json，返回json

9、调用handler中的interceptor的postHandler方法

10、processDispatchResult， 如果handler执行中方法出现异常exception，遍历handlerExceptionResolver进行处理

11、processDispatchResult，如果没有出现异常，并且返回的modelAndView，存在视图和数据，那么解析视图，渲染数据到视图，返回视图

总结

1、dispatchServlet处理请求，通过multipartReserver判断当前请求，是不是文件上传请求

2、通过handlerMapping（RequestHandlerMapping），匹配url，获取到当前请求对应的handler。匹配url，获取handler对应的所有interceptors

3、获取handler匹配的handlerAdapter，因为handler的实现方式有多种，一种是通过实现Controller定义handler，一种通过@RequestMapping定义handler等等。

4、调用handler对应的interceptors的preHandler方法（走拦截器pre方法）

5、通过handlerAdapter 调用 handler方法，最终返回modelAndVIew，如果返回json对象给前端，那么MAV为null

6、获取handler上的方法参数，获取默认的参数解析器，遍历参数解析器，看是否支持，如果支持，那么通过参数解析器，解析当前参数.解析成功后，通过反射调用initBinder，调用目标handler

7、遍历所有返回值解析器，通过匹配的返回值解析器，处理返回值，例如ResponseBody返回值处理器，解析到returnValue，那么直接向前端返回json。modelAndView返回值处理器返回ModelAndView，交由dispatcherServlet处理

8、调用handler中的interceptor的postHandler方法

9、processDispatchResult， 如果handler执行中方法出现异常exception，遍历handlerExceptionResolver进行处理

10、如果没有出现异常，并且返回的modelAndView，存在视图和数据，那么解析视图，渲染数据到视图，返回视图

来一个详细一点的