SpringMVC源码分析 (2022.08.23)

已于 2022-08-23 20:26:52 修改
阅读量179 收藏
点赞数
分类专栏： SpringMVC SpringBoot 文章标签： java spring boot mvc
于 2022-08-23 20:10:39 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44600430/article/details/126492047
版权

SpringBoot-SpringMVC源码分析 (2022.08.23)

补充一波SpringMVC源码分析, 请求至响应分析 (版本: v5.3.6)

核心组件:

  • 核心前端控制器: (用于拦截请求,获取url),
  • 处理器映射器:(用于找到需要处理的执行链或者方法参数),
  • 处理器适配器: (根据执行链用于找到合适的处理程序进行处理)
  • 处理器 与 拦截器: 用于执行执行链!
  • 请求参数解析器与类型转换器: 用于解析与转换请求参数绑定到处理器方法
  • 响应参数解析器与消息转换器: 用于解析与转换响应参数;
  • 视图: 一个接口可以支持返回不同页面,(html,jsp)
  • 视图解析器与渲染器: (用于解析与渲染返回的视图)
  • 异常解析器: 用于解决执行处理器出现的异常

容器启动之初会初始化的组件

处理器映射器

会扫描创建好URL : 处理器, 封装进一个Map;

入口类: RequestMappingHandlerMapping

注册映射:

当应用上下文创建该RequestMappingHandlerMapping 时候, 创建完Bean后会触发后续一些操作, 进行注册URL : 处理器 封装进一个Map中;

// RequestMappingHandlerMapping.java
public void afterPropertiesSet() {
	// 映射一些配置
   this.config = new RequestMappingInfo.BuilderConfiguration();
   this.config.setTrailingSlashMatch(useTrailingSlashMatch());
   this.config.setContentNegotiationManager(getContentNegotiationManager());

   if (getPatternParser() != null) {
      this.config.setPatternParser(getPatternParser());
      Assert.isTrue(!this.useSuffixPatternMatch && !this.useRegisteredSuffixPatternMatch,
            "Suffix pattern matching not supported with PathPatternParser.");
   }
   else {
      this.config.setSuffixPatternMatch(useSuffixPatternMatch());
      this.config.setRegisteredSuffixPatternMatch(useRegisteredSuffixPatternMatch());
      this.config.setPathMatcher(getPathMatcher());
   }
	// 调用父类AbstractHandlerMethodMapping 的afterPropertiesSet方法
   super.afterPropertiesSet();
}

// AbstractHandlerMethodMapping
@Override
public void afterPropertiesSet() {
   initHandlerMethods();
}

protected void initHandlerMethods() {
    // obtainApplicationContext().getBeanNamesForType(Object.class) 获取应用上下文所有注册的bean名称
		for (String beanName : getCandidateBeanNames()) {
			if (!beanName.startsWith(SCOPED_TARGET_NAME_PREFIX)) {
				processCandidateBean(beanName);
			}
		}
    // 所有URL => 处理器 映射完毕后调用, 获取到对应Map, 然后handlerMethodsInitialized 输出日志
		handlerMethodsInitialized(getHandlerMethods());
	}

protected void processCandidateBean(String beanName) {
		Class<?> beanType = null;
		try {
            // 获取对应Bean类型
			beanType = obtainApplicationContext().getType(beanName);
		}
		catch (Throwable ex) {
			// An unresolvable bean type, probably from a lazy bean - let's ignore it.
			if (logger.isTraceEnabled()) {
				logger.trace("Could not resolve type for bean '" + beanName + "'", ex);
			}
		}
    	// 判断是否是处理器
		if (beanType != null && isHandler(beanType)) {
			detectHandlerMethods(beanName);
		}
	}

// RequestMappingHandlerMapping.java
protected boolean isHandler(Class<?> beanType) {
   return (AnnotatedElementUtils.hasAnnotation(beanType, Controller.class) ||
         AnnotatedElementUtils.hasAnnotation(beanType, RequestMapping.class));
}

// AbstractHandlerMethodMapping
protected void detectHandlerMethods(Object handler) {
    // 获取处理器类型
   Class<?> handlerType = (handler instanceof String ?
         obtainApplicationContext().getType((String) handler) : handler.getClass());

   if (handlerType != null) {
       // 获取定义类型, 防止获取到生成的子类
      Class<?> userType = ClassUtils.getUserClass(handlerType);
       // 
      Map<Method, T> methods = MethodIntrospector.selectMethods(userType,
            (MethodIntrospector.MetadataLookup<T>) method -> {
               try {
                   // 获取方法映射
                  return getMappingForMethod(method, userType);
               }
               catch (Throwable ex) {
                  throw new IllegalStateException("Invalid mapping on handler class [" +
                        userType.getName() + "]: " + method, ex);
               }
            });
      if (logger.isTraceEnabled()) {
         logger.trace(formatMappings(userType, methods));
      }
      else if (mappingsLogger.isDebugEnabled()) {
         mappingsLogger.debug(formatMappings(userType, methods));
      }
      methods.forEach((method, mapping) -> {
         Method invocableMethod = AopUtils.selectInvocableMethod(method, userType);
         registerHandlerMethod(handler, invocableMethod, mapping);
      });
   }
}

v618KJ.png

处理器适配器

入口 WebMvcConfigurationSupport # requestMappingHandlerAdapter()

@Bean
public RequestMappingHandlerAdapter requestMappingHandlerAdapter(
      @Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager,
      @Qualifier("mvcConversionService") FormattingConversionService conversionService,
      @Qualifier("mvcValidator") Validator validator) {
	
   // 创建请求映射处理器适配器
   RequestMappingHandlerAdapter adapter = createRequestMappingHandlerAdapter();
   adapter.setContentNegotiationManager(contentNegotiationManager);
    // 设置消息转换器集合
   adapter.setMessageConverters(getMessageConverters());
    // 设置数据绑定
   adapter.setWebBindingInitializer(getConfigurableWebBindingInitializer(conversionService, validator));
    // 设置自定义参数转换解析器
   adapter.setCustomArgumentResolvers(getArgumentResolvers());
    // 设置自定义返回值转换处理程序
   adapter.setCustomReturnValueHandlers(getReturnValueHandlers());

   if (jackson2Present) {
      adapter.setRequestBodyAdvice(Collections.singletonList(new JsonViewRequestBodyAdvice()));
      adapter.setResponseBodyAdvice(Collections.singletonList(new JsonViewResponseBodyAdvice()));
   }

   AsyncSupportConfigurer configurer = getAsyncSupportConfigurer();
   if (configurer.getTaskExecutor() != null) {
      adapter.setTaskExecutor(configurer.getTaskExecutor());
   }
   if (configurer.getTimeout() != null) {
      adapter.setAsyncRequestTimeout(configurer.getTimeout());
   }
   adapter.setCallableInterceptors(configurer.getCallableInterceptors());
   adapter.setDeferredResultInterceptors(configurer.getDeferredResultInterceptors());

   return adapter;
}
设置Http消息转换器

v6amVg.md.png

设置参数转换和绑定器 (其他博客说明)

v6IQ74.png

设置参数解析器/返回参数处理器

RequestBodyAdvice和ResponseBodyAdvice接口 (针对于@RequestBody、@ResponseBody, 参数处理增强)

非使用@RequestBody、@ResponseBody, 参考 框架提供的 自定义实现一个参数解析器、响应参数处理 (扩展1.0有个简单例子)

vc9bFI.png

1

适配器完结:

v6au5j.png

请求开始至响应流程

请求是如何找到对应控制器类中对应方法, 转换参数进行执行的呢?

入口类: org.springframework.web.servlet.DispatcherServlet # doService()

doService() 方法只是设置了请求域中的一些属性, 然后会接着调用doDispatch(request, response) 这个方法才是真正的请求后续大量处理入口

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
   HttpServletRequest processedRequest = request;
   HandlerExecutionChain mappedHandler = null;
   boolean multipartRequestParsed = false;
	// 获取异步请求管理器 (https://www.cnblogs.com/deityjian/p/11503218.html)
   WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);

   try {
      ModelAndView mv = null;
      Exception dispatchException = null;

      try {
          // 检测是否是文件上传请求
         processedRequest = checkMultipart(request);
         multipartRequestParsed = (processedRequest != request);

         // Determine handler for the current request (根据请求获取映射处理器)
         mappedHandler = getHandler(processedRequest);
         if (mappedHandler == null) {
            noHandlerFound(processedRequest, response);
            return;
         }

         // Determine handler adapter for the current request. 通过处理器找适配器
         HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

         // Process last-modified header, if supported by the handler.
         String method = request.getMethod();
         boolean isGet = "GET".equals(method);
         if (isGet || "HEAD".equals(method)) {
            long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
            if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {
               return;
            }
         }

         if (!mappedHandler.applyPreHandle(processedRequest, response)) {
            return;
         }

         // Actually invoke the handler.
         mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

         if (asyncManager.isConcurrentHandlingStarted()) {
            return;
         }

         applyDefaultViewName(processedRequest, mv);
         mappedHandler.applyPostHandle(processedRequest, response, mv);
      }
      catch (Exception ex) {
         dispatchException = ex;
      }
      catch (Throwable err) {
         // As of 4.3, we're processing Errors thrown from handler methods as well,
         // making them available for @ExceptionHandler methods and other scenarios.
         dispatchException = new NestedServletException("Handler dispatch failed", err);
      }
      processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
   }
   catch (Exception ex) {
      triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
   }
   catch (Throwable err) {
      triggerAfterCompletion(processedRequest, response, mappedHandler,
            new NestedServletException("Handler processing failed", err));
   }
   finally {
      if (asyncManager.isConcurrentHandlingStarted()) {
         // Instead of postHandle and afterCompletion
         if (mappedHandler != null) {
            mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
         }
      }
      else {
         // Clean up any resources used by a multipart request.
         if (multipartRequestParsed) {
            cleanupMultipart(processedRequest);
         }
      }
   }
}

检测是否是文件上传

v6GqII.png

通过请求找处理器映射器

mappedHandler = getHandler(processedRequest)

vclYGT.png

同时找到了处理器和执行链HandlerExecutionChain handler = mapping.getHandler(request)

通过处理器找适配器并执行任务链

HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler()),

vc3Ub9.png

通过适配器执行处理器获取视图

vcNPEQ.png

获取到视图的后续处理

vcNs2t.png

到此整个请求处理过程的关键步骤都分析完了。理解了SpringMVC V5.x版本上中的请求处理流程;

核心前端控制器执行异常情况

vcUJij.png

扩展

1.0 自定义参数解析器( 到达controller前处理请求参数)

甚至可以定义添加Converters参数转换器来实现

@Configuration
public class MyMVCConfig implements WebMvcConfigurer {
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
    resolvers.add(new HandlerMethodArgumentResolver() {
        // post请求 json交互可以使用实现Advice接口增加请求前参数处理
        // 非json交互 post, get请求, 方法参数实体,  参考 ServletModelAttributeMethodProcessor实现 
        // 非json交互 get 请求, 方法参数非实体  参考 RequestParamMethodArgumentResolver实现
        @Override
        public boolean supportsParameter(MethodParameter parameter) {
            return parameter.getParameter().getParameterizedType() == UserOne.class;
        }

        @Override
        public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
            Class parameterizedType = (Class) parameter.getParameter().getParameterizedType();
            Object target = parameterizedType.newInstance();
            WebDataBinder binder = binderFactory.createBinder(webRequest, target, parameter.getParameter().getName());
            ServletRequest servletRequest = webRequest.getNativeRequest(ServletRequest.class);
            ServletRequestDataBinder servletBinder = (ServletRequestDataBinder) binder;
            servletBinder.bind(servletRequest);
            return binder.getBindingResult().getTarget();
        }
    });
    WebMvcConfigurer.super.addArgumentResolvers(resolvers);
}

2.0 自定义响应参数处理程序

一般使用@ResponseBody 返回的使用Advice接口

返回视图的参考: ViewNameMethodReturnValueHandler , 或者在源码HandlerMethodReturnValueHandlerComposite#handleReturnValue() 参考返回值使用的是那个, 参考着写

1

懵懵懂懂程序员
关注
专栏目录
2022年Java 工程师面试题
weixin_42572320的博客
03-03 2484
第 1 页 共 485 页 目录 1、什么是 Mybatis？............................................................................... 33 2、Mybaits 的优点：............................................................................... 33 3、MyBatis 框架的缺点：.............................
堪称2022最强，所有的（大厂）一面和（必问）的面试题（答案）
m0_68850571的博客
04-15 311
01_本文章前提要求和说明 一些大厂的面试题 某蚁某呗一面： Java容器有哪些？哪些是同步容器,哪些是并发容器？ ArrayList和LinkedList的插入和访问的时间复杂度？ java反射原理，注解原理？ 新生代分为几个区？使用什么算法进行垃圾回收？为什么使用这个算法？ HashMap在什么情况下会扩容，或者有哪些操作会导致扩容？ HashMap push方法的执行过程？ HashMap检测到hash冲突后，将元素插入在链表的末尾还是开头？ 1.8还采用了红黑树，讲讲红黑树的特性
Spring MVC注解与数据绑定(含源码及结果图)
06-21
1、有如下一个订单信息页面order.jsp(置于/WEB-INF/jsp目录下)，按以下步骤实现一个使用POJO类型完成表单数据传输的SpringMVC数据绑定项目。 (1) 创建一个Order类来封装上述订单信息，其中各个属性的名称和数据类型是：产品编号(ProductID，Integer)，用户编号(UserID，Integer)，交易日期(TransactionDate，Date)，价格(Price，Double)，数量(Quantity，Long)，交易金额(TransactionAmount，Double)，用户邮件(Email，String)，备注(Comment，String)。 (2) 编写控制器类OrderController，在类中实现向order.jsp跳转的方法和接收order.jsp页面提交的订单信息的方法(该方法执行完后会将订单信息显示在result.jsp页上，见步骤(6))。 (3)创建日期转换类DateConverter，实现String类型到Date类型的转换。 (4)创建order.jsp页面。 (5)配置springmvc-config.xml文件。 (6)创建一个result.jsp结果页面(置于/WEB-INF/jsp目录下)，用于显示接收到订单信息。
SpringMVC源码分析系列
weixin_33851429的博客
06-26 165
说到java的mvc框架，struts2和springmvc想必大家都知道，struts2的设计基本上完全脱离了Servlet容器，而springmvc是依托着Servlet容器元素来设计的，同时springmvc基于Spring框架，Spring框架想必搞java的同学都很熟悉。 一进Spring的官网就发现了这样一排醒目的文字， spring可以让我们构造简单的、便携的、又快又易于扩展的...
SpringMVC的源码分析
rnang0的博客
03-13 785
SpringMVC 的源码分析1. SpringMVC的执行过程分析2. SpringMVC中三大组件详解2.1 处理器映射器2.2 处理器适配器2.2.1 SimpleControllerHandlerAdapter2.2.2 HttpRequestHandlerAdapter2.2.3 使用@Controller注解2.3 视图解析器（了解即可）3. 不需要视图解析器的场景分析4. 请求参数封...
Spring MVC 源码分析
lengyingzhang的博客
05-16 1874
1. DisptcherServlet介绍 在MVC项目搭建的过程中，我们通常会在webapp下的web.xml文件中添加上一个servelet配置，而且通常我们使用的是DispatcherServlet这个类，如下列代码所示： <?xml version="1.0" encoding="UTF-8"?> <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/200
springmvc源码分析
zhonggongzhangjin的专栏
04-18 315
dispatcherServlet是springmvc的入口，其继承自httpservlet，搭建springmvc环境首先需要将dispatcherServlet交由servletContext管理，并设置在容器启动的时候就初始化。平时使用时还传给他一个ApplicationContext作为与servletcontext对应的父容器的子容器。 1.首先看看这个servlet的初始化。
spring5注解开发学习笔记
java
08-07 723
spring注解开发
兑吧开发规范《源Java手册》
海客森
12-31 3204
1. 规范: 语法规范 1.1. 命名规范 【推荐】业务属性：对象、方法命名，要使用携带业务属性的名词，比如AdvertVO；反例DeleteVO；除非单纯对该对象操作，而对象具备了名词意义，比如AdvertVO中包含方法，getAccountByVO(AdvertVO advertVO) 【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式 说明: 正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使是纯拼音命名方式也要避免采用。 正例: alibaba / taba
Spring Boot 教学 学习 讲义笔记 【入门到精通一篇就够了】（上）
Likme1的博客
10-17 2048
Spring Boot 基于 Spring 开发，Spirng Boot 本身并不提供 Spring 框架的核心特性以及扩展功能，只是用于快速、敏捷地开发新一代基于 Spring 框架的应用程序。
springmvc各种参数绑定
08-19
springmvc各种参数绑定源码实现
springmvc项目在启动完成之后执行一次方法_SpringMVC源码分析
weixin_39558804的博客
11-26 541
一 SpringMVC运行原理二 SpingMVC源码分析1 DispatcherServlet1.1 DispatcherServlet继承结构ServletConfig对象获取Init标签中的配置信息1.1.1 HttpServletBean HttpServletBean复习了init方法，主要做一些初始化的工作麻将web.xml中配置的参数 设置到Servlet...
SpringMVC源码分析
qq_28864749的博客
11-06 103
我们知道SpringMVC实质上是对servlet进行封装，让我们的开发更加简便 1. 准备工作 我们知道springmvc在工作开始之前会加载默认的处理器映射器、处理器适配器、处理器解析器等 可以在spring-webmvc-5.0.6.RELEASE.jar源码包下查看DispatcherServlet.properties文件看有哪些处理器是springmvc默认加载的 ...
Spring MVC源码分析
晚晴小筑
04-27 875
初始化过程 1.      概述 对于Web开发者，MVC模型是大家再熟悉不过的了，SpringMVC中，满足条件的请求进入到负责请求分发的DispatcherServlet，DispatcherServlet根据请求url到控制器的映射（HandlerMapping中保存），HandlerMapping最终返回HandlerExecutionChain，其中包含了具体的处理对象h
Spring Mvc源码剖析
zw815210201的博客
07-03 150
1.Spring Mvc执行源码分析 待补充（赶进度，后面根据讲义梳理补充吧/(ㄒoㄒ)/~~） 2.父子容器初始化 2.1.为什么需要父子容器？ 为了容器之间的隔离.因为spring不仅可以集成springMvc还可以集成其他优秀的框架，子容器中持有父容器的引用,可以获取到父容器中的对象. 2.2.代码调试观察源码 父容器（其实就是spring容器）：通过监听器加载 web.xml中配置监听器，指定spring的配置文件 <context-param> <param-name&
【总结】SpringMVC源码分析
xzzz2020的博客
09-10 420
文章目录一、配置文件分析1. XML配置分析2. MVC配置二、入口方法分析1. 容器初始化2. 解析Controller3. Spring对注解的配置支持三、SpringMVC的核心流程1. 关键流程2. 核心组件 一、配置文件分析 1. XML配置分析 在一个SSM项目中，需要在xml文件配置SpingMVC的相关组件 DispatcherServlet：做请求分发以及结果渲染 ContextLoaderListener：配置监听器，在创建Servlet前，加载SpringMVC的配置 <?x
SpringMVC源码解析
从基础到源码解析的学习记录
10-12 1745
文章目录一、主要组件二、DispatcherServlet初始化过程1）结构体系2）通过requestMapping注解（url）获取controller总结：三、DispatcherServlet处理请求过程2）获取处理器映射器结果2）处理器适配器3）视图渲染==总结== 一、主要组件 DispatcherServlet：前端控制器，统一处理请求和响应，整个流程控制的中心，由它调用其他组件处理用户请求。 HandlerMapping：处理器映射器，根据请求的url、method等信息查找Handler，
springmvc中的web.xml配置
最新发布
07-27
SpringMVC的web.xml配置主要包括以下内容： 1. 配置DispatcherServlet 在web.xml中配置DispatcherServlet，指定它的servlet-name和servlet-class，以及它所处理的请求的url-pattern。 2. 配置...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

懵懵懂懂程序员

如果节省了你的时间, 请鼓励

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值