Spring MVC 源码分析 & 时序图 非原创- 2021-01-14 21:11- spring: Spring MVC 源码
—-

Spring MVC 初体验

初探 Spring MVC 请求处理流程

Spring MVC 相对于前面的章节算是比较简单的,我们首先引用《Spring in Action》上的一张图来了解 Spring MVC 的核心组件和大致处理流程:

image.png
从上图中看到①DispatcherServlet 是 SpringMVC 中的前端控制器(Front Controller), 负责接收 Request 并将 Request 转发给对应的处理组件。② HanlerMapping 是 SpringMVC 中 完 成 url 到 Controller 映 射 的 组 件 。 DispatcherServlet 接 收 Request, 然 后 从 HandlerMapping 查 找 处 理 Request 的Controller。③、Controller 处理 Request,并返回 ModelAndView 对象,Controller 是 SpringMVC中负责处理 Request 的组件(类似于 Struts2 中的 Action),ModelAndView 是封装结果视图的组件。④、⑤、⑥视图解析器解析 ModelAndView 对象并返回对应的视图给客户端。
容器初始化时会建立所有 url 和 Controller 中的Method 的对应关系,保存到 HandlerMapping 中,用户请求是根据 Request 请求的url 快速定位到Controller中的某个方法。在 Spring 中先将 url 和 Controller 的对应关 系,保存到 Map中。Web 容器启动时会通知 Spring 初始化容器(加载
Bean 的定义信息和初始化所有单例 Bean),然后 SpringMVC 会遍历容器中的 Bean,获取每一个 Controller 中的所有方法访问的 url,然后将 url 和 Controller 保存到一个 Map中;这样就可以根据 Request 快速定位到 Controller,因为最终处理 Request 的是Controller 中的方法,Map 中只保留了 url 和 Controller 中的对应关系,所以要根据Request 的 url 进一步确认 Controller 中的 Method,这一步工作的原理就是拼接Controller 的 url(Controller 上@RequestMapping 的值)和方法的 url(Method 上@RequestMapping 的值),与 request 的 url 进行匹配,找到匹配的那个方法;确定处 理请求的 Method 后,接下来的任务就是参数绑定,把 Request 中参数绑定到方法的形式参数上,这一步是整个请求处理过程中最复杂的一个步骤。

Spring MVC 九大组件

HandlerMappings

HandlerMapping 是用来查找 Handler 的,也就是处理器,具体的表现形式可以是类也可以是方法。比如,标注了@RequestMapping 的每个 method 都可以看成是一个Handler,由 Handler 来负责实际的请求处理。 HandlerMapping 在请求到达之后,它的作用便是找到请求相应的处理器 Handler 和 Interceptors。

HandlerAdapters

从名字上看,这是一个适配器。因为 Spring MVC 中 Handler 可以是任意形式的,只要能够处理请求便行, 但是把请求交给 Servlet 的时候,由于 Servlet 的方法结构都是如doService(HttpServletRequest req, HttpServletResponse resp) 这样的形式,让固定的 Servlet 处理方法调用 Handler 来进行处理,这一步工作便是 HandlerAdapter 要做的事。

HandlerExceptionResolvers

从这个组件的名字上看,这个就是用来处理 Handler 过程中产生的异常情况的组件。 具体来说,此组件的作用是根据异常设置 ModelAndView, 之后再交给 render()方法进行渲染 , 而 render() 便 将 ModelAndView 渲 染 成 页 面 。 不过有一点 ,HandlerExceptionResolver 只是用于解析对请求做处理阶段产生的异常,而渲染阶段的 异常则不归他管了,这也是 Spring MVC 组件设计的一大原则分工明确互不干涉。

ViewResolvers

视图解析器,相信大家对这个应该都很熟悉了。因为通常在 SpringMVC 的配置文件中,都会配上一个该接口的实现类来进行视图的解析。 这个组件的主要作用,便是将 String类型的视图名和Locale解析为View类型的视图。这个接口只有一个resolveViewName() 方法。从方法的定义就可以看出,Controller 层返回的 String 类型的视图名 viewName,最终会在这里被解析成为 View。View 是用来渲染页面的,也就是说,它会将程序返回的参数和数据填入模板中,最终生成 html 文件。ViewResolver 在这个过程中,主要做两件大事,即,ViewResolver 会找到渲染所用的模板(使用什么模板来渲染?)和所用的技术(其实也就是视图的类型,如 JSP 啊还是其他什么 Blabla 的)填入参数。默认情况下,Spring MVC 会为我们自动配置一个 InternalResourceViewResolver,这个是针对 JSP 类型视图的。

RequestToViewNameTranslator

这个组件的作用,在于从 Request 中获取 viewName. 因为 ViewResolver 是根据ViewName 查找 View, 但有的 Handler 处理完成之后,没有设置 View 也没有设置ViewName, 便要通过这个组件来从 Request 中查找 viewName。

LocaleResolver

在上面我们有看到 ViewResolver 的 resolveViewName()方法,需要两个参数。那么第二个参数 Locale 是从哪来的呢,这就是 LocaleResolver要做的事了。 LocaleResolver用于从 request 中解析出 Locale, 在中国大陆地区,Locale 当然就会是 zh-CN 之类, 用来表示一个区域。这个类也是 i18n 的基础。

ThemeResolver

从名字便可看出,这个类是用来解析主题的。主题,就是样式,图片以及它们所形成的显示效果的集合。Spring MVC 中一套主题对应一个 properties 文件,里面存放着跟当前主题相关的所有资源,如图片,css 样式等。创建主题非常简单,只需准备好资源,然后新建一个 “主题名.properties” 并将资源设置进去,放在 classpath 下,便可以在页面中使用了。 Spring MVC 中跟主题有关的类有 ThemeResolver, ThemeSource 和Theme。 ThemeResolver 负责从 request 中解析出主题名, ThemeSource 则根据主题名找到具体的主题, 其抽象也就是 Theme, 通过 Theme 来获取主题和具体的资源。

MultipartResolver

其实这是一个大家很熟悉的组件,MultipartResolver 用于处理上传请求,通过将普通的Request 包装成MultipartHttpServletRequest 来实现。MultipartHttpServletRequest可以通过 getFile() 直接获得文件,如果是多个文件上传,还可以通过调用 getFileMap得到 Map 这样的结构。MultipartResolver 的作用就是用来封装普通的 request,使其拥有处理文件上传的功能。

FlashMapManager

说到 FlashMapManager,就得先提一下 FlashMap。FlashMap 用于重定向 Redirect 时的参数数据传递,比如,在处理用户订单提交时,为了避免重复提交,可以处理完 post 请求后 redirect 到一个 get 请求,这个 get 请求可以用来显示订单详情之类的信息。这样做虽然可以规避用户刷新重新提交表单的问题,但是在这个页面上要显示订单的信息,那这些数据从哪里去获取呢,因为 redirect 重定向是没有传递参数这一功能的,如果不想把参数写进 url(其实也不推荐这么做,url 有长度限制不说,把参数都直接暴露,感觉也不安全), 那么就可以通过 flashMap 来传递。只需 要 在 redirect 之 前 , 将 要 传 递 的 数 据 写 入 request ( 可 以 通 过ServletRequestAttributes.getRequest()获得)的属性OUTPUT_FLASH_MAP_ATTRIBUTE 中,这样在 redirect 之后的 handler 中 Spring 就会自动将其设置到 Model 中,在显示订单信息的页面上,就可以直接从 Model 中取得
数据了。而 FlashMapManager 就是用来管理 FlashMap 的。

Spring MVC 源码分析

根据上面分析的 Spring MVC 工作机制,从三个部分来分析 Spring MVC 的源代码。
其一,ApplicationContext 初始化时用 Map 保存所有 url 和 Controller 类的对应关系;
其二,根据请求 url 找到对应的 Controller,并从 Controller 中找到处理请求的方法;
其三,Request 参数绑定到方法的形参,执行方法处理请求,并返回结果视图。

初始化阶段

我们首先找到 DispatcherServlet 这个类,必然是寻找 init()方法。然后,我们发现其 init方法其实在父类 HttpServletBean 中,其源码如下:

  1. @Override
  2. public final void init() throws ServletException {
  3. if (logger.isDebugEnabled()) {
  4. logger.debug("Initializing servlet '" + getServletName() + "'");
  5. }
  6. // Set bean properties from init parameters.
  7. PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
  8. if (!pvs.isEmpty()) {
  9. try {
  10. //定位资源
  11. BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
  12. //加载配置信息
  13. ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
  14. bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
  15. initBeanWrapper(bw);
  16. bw.setPropertyValues(pvs, true);
  17. }
  18. catch (BeansException ex) {
  19. if (logger.isErrorEnabled()) {
  20. logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
  21. }
  22. throw ex;
  23. }
  24. }
  25. // Let subclasses do whatever initialization they like.
  26. initServletBean();
  27. if (logger.isDebugEnabled()) {
  28. logger.debug("Servlet '" + getServletName() + "' configured successfully");
  29. }
  30. }

我 们 看 到 在 这 段 代 码 中 , 又 调 用 了 一 个 重 要 的 initServletBean() 方 法 。 进 入initServletBean()方法看到以下源码:

  1. @Override
  2. protected final void initServletBean() throws ServletException {
  3. getServletContext().log("Initializing Spring FrameworkServlet '" + getServletName() + "'");
  4. if (this.logger.isInfoEnabled()) {
  5. this.logger.info("FrameworkServlet '" + getServletName() + "': initialization started");
  6. }
  7. long startTime = System.currentTimeMillis();
  8. try {
  9. this.webApplicationContext = initWebApplicationContext();
  10. initFrameworkServlet();
  11. }
  12. catch (ServletException ex) {
  13. this.logger.error("Context initialization failed", ex);
  14. throw ex;
  15. }
  16. catch (RuntimeException ex) {
  17. this.logger.error("Context initialization failed", ex);
  18. throw ex;
  19. }
  20. if (this.logger.isInfoEnabled()) {
  21. long elapsedTime = System.currentTimeMillis() - startTime;
  22. this.logger.info("FrameworkServlet '" + getServletName() + "': initialization completed in " +
  23. elapsedTime + " ms");
  24. }
  25. }

这段代码中最主要的逻辑就是初始化 IOC 容器,最终会调用 refresh()方法,前面的章节中对 IOC 容器的初始化细节我们已经详细掌握,在此我们不再赘述。我们看到上面的代码中,IOC 容器初始化之后,最后有调用了 onRefresh()方法。这个方法最终是在DisptcherServlet 中实现,来看源码:

  1. @Override
  2. protected void onRefresh(ApplicationContext context) {
  3. initStrategies(context);
  4. }
  5. //初始化策略
  6. protected void initStrategies(ApplicationContext context) {
  7. //多文件上传的组件
  8. initMultipartResolver(context);
  9. //初始化本地语言环境
  10. initLocaleResolver(context);
  11. //初始化模板处理器
  12. initThemeResolver(context);
  13. //handlerMapping
  14. initHandlerMappings(context);
  15. //初始化参数适配器
  16. initHandlerAdapters(context);
  17. //初始化异常拦截器
  18. initHandlerExceptionResolvers(context);
  19. //初始化视图预处理器
  20. initRequestToViewNameTranslator(context);
  21. //初始化视图转换器
  22. initViewResolvers(context);
  23. //
  24. initFlashMapManager(context);
  25. }

到这一步就完成了Spring MVC的九大组件的初始化。接下来,我们来看url和Controller的关系是如何建立的呢 ?HandlerMapping的子类AbstractDetectingUrlHandlerMapping实现了initApplicationContext()方法,所以我们直接看子类中的初始化容器方法。

  1. @Override
  2. public void initApplicationContext() throws ApplicationContextException {
  3. super.initApplicationContext();
  4. detectHandlers();
  5. }
  6. /**
  7. * 建立当前ApplicationContext中的所有controller和url的对应关系
  8. */
  9. protected void detectHandlers() throws BeansException {
  10. ApplicationContext applicationContext = obtainApplicationContext();
  11. if (logger.isDebugEnabled()) {
  12. logger.debug("Looking for URL mappings in application context: " + applicationContext);
  13. }
  14. // 获取ApplicationContext容器中所有bean的Name
  15. String[] beanNames = (this.detectHandlersInAncestorContexts ?
  16. BeanFactoryUtils.beanNamesForTypeIncludingAncestors(applicationContext, Object.class) :
  17. applicationContext.getBeanNamesForType(Object.class));
  18. // Take any bean name that we can determine URLs for.
  19. // 遍历beanNames,并找到这些bean对应的url
  20. for (String beanName : beanNames) {
  21. // 找bean上的所有url(controller上的url+方法上的url),该方法由对应的子类实现
  22. String[] urls = determineUrlsForHandler(beanName);
  23. if (!ObjectUtils.isEmpty(urls)) {
  24. // URL paths found: Let's consider it a handler.
  25. // 保存urls和beanName的对应关系,put it to Map<urls,beanName>,该方法在父类AbstractUrlHandlerMapping中实现
  26. registerHandler(urls, beanName);
  27. }
  28. else {
  29. if (logger.isDebugEnabled()) {
  30. logger.debug("Rejected bean name '" + beanName + "': no URL paths identified");
  31. }
  32. }
  33. }
  34. }
  35. /** 获取controller中所有方法的url,由子类实现,典型的模板模式 **/
  36. protected abstract String[] determineUrlsForHandler(String beanName);

determineUrlsForHandler(String beanName)方法的作用是获取每个Controller 中的url,不同的子类有不同的实现,这是一个典型的模板设计模式。因为开发中我们用的最多的就是用注解来配置Controller中的url,BeanNameUrlHandlerMapping是AbstractDetectingUrlHandlerMapping 的子类,处理注解形式的 url 映射.所以我们这里以BeanNameUrlHandlerMapping来进行分析 。 我们看BeanNameUrlHandlerMapping是如何查beanName上所有映射的url。

  1. @Override
  2. protected String[] determineUrlsForHandler(String beanName) {
  3. List<String> urls = new ArrayList<>();
  4. if (beanName.startsWith("/")) {
  5. urls.add(beanName);
  6. }
  7. String[] aliases = obtainApplicationContext().getAliases(beanName);
  8. for (String alias : aliases) {
  9. if (alias.startsWith("/")) {
  10. urls.add(alias);
  11. }
  12. }
  13. return StringUtils.toStringArray(urls);
  14. }

到这里 HandlerMapping 组件就已经建立所有 url 和 Controller 的对应关系。

运行调用阶段

这一步步是由请求触发的,所以入口为 DispatcherServlet 的核心方法为 doService(),doService()中的核心逻辑由 doDispatch()实现,源代码如下:

  1. /** 中央控制器,控制请求的转发 **/
  2. protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
  3. HttpServletRequest processedRequest = request;
  4. HandlerExecutionChain mappedHandler = null;
  5. boolean multipartRequestParsed = false;
  6. WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
  7. try {
  8. ModelAndView mv = null;
  9. Exception dispatchException = null;
  10. try {
  11. // 1.检查是否是文件上传的请求
  12. processedRequest = checkMultipart(request);
  13. multipartRequestParsed = (processedRequest != request);
  14. // Determine handler for the current request.
  15. // 2.取得处理当前请求的controller,这里也称为hanlder,处理器,
  16. // 第一个步骤的意义就在这里体现了.这里并不是直接返回controller,
  17. // 而是返回的HandlerExecutionChain请求处理器链对象,
  18. // 该对象封装了handler和interceptors.
  19. mappedHandler = getHandler(processedRequest);
  20. // 如果handler为空,则返回404
  21. if (mappedHandler == null) {
  22. noHandlerFound(processedRequest, response);
  23. return;
  24. }
  25. // Determine handler adapter for the current request.
  26. //3. 获取处理request的处理器适配器handler adapter
  27. HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
  28. // Process last-modified header, if supported by the handler.
  29. // 处理 last-modified 请求头
  30. String method = request.getMethod();
  31. boolean isGet = "GET".equals(method);
  32. if (isGet || "HEAD".equals(method)) {
  33. long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
  34. if (logger.isDebugEnabled()) {
  35. logger.debug("Last-Modified value for [" + getRequestUri(request) + "] is: " + lastModified);
  36. }
  37. if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {
  38. return;
  39. }
  40. }
  41. if (!mappedHandler.applyPreHandle(processedRequest, response)) {
  42. return;
  43. }
  44. // Actually invoke the handler.
  45. // 4.实际的处理器处理请求,返回结果视图对象
  46. mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
  47. if (asyncManager.isConcurrentHandlingStarted()) {
  48. return;
  49. }
  50. // 结果视图对象的处理
  51. applyDefaultViewName(processedRequest, mv);
  52. mappedHandler.applyPostHandle(processedRequest, response, mv);
  53. }
  54. catch (Exception ex) {
  55. dispatchException = ex;
  56. }
  57. catch (Throwable err) {
  58. // As of 4.3, we're processing Errors thrown from handler methods as well,
  59. // making them available for @ExceptionHandler methods and other scenarios.
  60. dispatchException = new NestedServletException("Handler dispatch failed", err);
  61. }
  62. processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
  63. }
  64. catch (Exception ex) {
  65. triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
  66. }
  67. catch (Throwable err) {
  68. triggerAfterCompletion(processedRequest, response, mappedHandler,
  69. new NestedServletException("Handler processing failed", err));
  70. }
  71. finally {
  72. if (asyncManager.isConcurrentHandlingStarted()) {
  73. // Instead of postHandle and afterCompletion
  74. if (mappedHandler != null) {
  75. // 请求成功响应之后的方法
  76. mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
  77. }
  78. }
  79. else {
  80. // Clean up any resources used by a multipart request.
  81. if (multipartRequestParsed) {
  82. cleanupMultipart(processedRequest);
  83. }
  84. }
  85. }
  86. }

getHandler(processedRequest)方法实际上就是从HandlerMapping中找到 url 和Controller的对应关系。也就是Map。我们知道,最终处理 Request的是 Controller 中的方法,我们现在只是知道了Controller,我们如何确认Controller中处理 Request 的方法呢?继续往下看。
从 Map中取得 Controller 后,经过拦截器的预处理方法,再通过反射获取该方法上的注解和参数,解析方法和参数上的注解,然后反射调用方法获取ModelAndView 结果视图。最后,调用的就是 RequestMappingHandlerAdapter的handle()中的核心逻辑由 handleInternal(request, response, handler)实现。

  1. @Override
  2. protected ModelAndView handleInternal(HttpServletRequest request,
  3. HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
  4. ModelAndView mav;
  5. checkRequest(request);
  6. // Execute invokeHandlerMethod in synchronized block if required.
  7. if (this.synchronizeOnSession) {
  8. HttpSession session = request.getSession(false);
  9. if (session != null) {
  10. Object mutex = WebUtils.getSessionMutex(session);
  11. synchronized (mutex) {
  12. mav = invokeHandlerMethod(request, response, handlerMethod);
  13. }
  14. }
  15. else {
  16. // No HttpSession available -> no mutex necessary
  17. mav = invokeHandlerMethod(request, response, handlerMethod);
  18. }
  19. }
  20. else {
  21. // No synchronization on session demanded at all...
  22. mav = invokeHandlerMethod(request, response, handlerMethod);
  23. }
  24. if (!response.containsHeader(HEADER_CACHE_CONTROL)) {
  25. if (getSessionAttributesHandler(handlerMethod).hasSessionAttributes()) {
  26. applyCacheSeconds(response, this.cacheSecondsForSessionAttributeHandlers);
  27. }
  28. else {
  29. prepareResponse(response);
  30. }
  31. }
  32. return mav;
  33. }

整个处理过程中最核心的逻辑其实就是拼接 Controller 的 url 和方法的 url,与 Request的url进行匹配,找到匹配的方法。

  1. public abstract class AbstractHandlerMethodMapping<T> extends AbstractHandlerMapping implements InitializingBean {
  2. @Override
  3. protected HandlerMethod getHandlerInternal(HttpServletRequest request) throws Exception {
  4. // 如果请求 url 为,http://localhost:8080/web/hello.json, 则 lookupPath=web/hello.json
  5. String lookupPath = getUrlPathHelper().getLookupPathForRequest(request);
  6. if (logger.isDebugEnabled()) {
  7. logger.debug("Looking up handler method for path " + lookupPath);
  8. }
  9. this.mappingRegistry.acquireReadLock();
  10. try {
  11. HandlerMethod handlerMethod = lookupHandlerMethod(lookupPath, request);
  12. if (logger.isDebugEnabled()) {
  13. if (handlerMethod != null) {
  14. logger.debug("Returning handler method [" + handlerMethod + "]");
  15. }
  16. else {
  17. logger.debug("Did not find handler method for [" + lookupPath + "]");
  18. }
  19. }
  20. return (handlerMethod != null ? handlerMethod.createWithResolvedBean() : null);
  21. }
  22. finally {
  23. this.mappingRegistry.releaseReadLock();
  24. }
  25. }
  26. }

通过上面的代码分析,已经可以找到处理Request的Controller中的方法了,现在看如何解析该方法上的参数,并反射调用该方法。

  1. /** 获取处理请求的方法,执行并返回结果视图 **/
  2. @Nullable
  3. protected ModelAndView invokeHandlerMethod(HttpServletRequest request,
  4. HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
  5. ServletWebRequest webRequest = new ServletWebRequest(request, response);
  6. try {
  7. WebDataBinderFactory binderFactory = getDataBinderFactory(handlerMethod);
  8. ModelFactory modelFactory = getModelFactory(handlerMethod, binderFactory);
  9. ServletInvocableHandlerMethod invocableMethod = createInvocableHandlerMethod(handlerMethod);
  10. if (this.argumentResolvers != null) {
  11. invocableMethod.setHandlerMethodArgumentResolvers(this.argumentResolvers);
  12. }
  13. if (this.returnValueHandlers != null) {
  14. invocableMethod.setHandlerMethodReturnValueHandlers(this.returnValueHandlers);
  15. }
  16. invocableMethod.setDataBinderFactory(binderFactory);
  17. invocableMethod.setParameterNameDiscoverer(this.parameterNameDiscoverer);
  18. ModelAndViewContainer mavContainer = new ModelAndViewContainer();
  19. mavContainer.addAllAttributes(RequestContextUtils.getInputFlashMap(request));
  20. modelFactory.initModel(webRequest, mavContainer, invocableMethod);
  21. mavContainer.setIgnoreDefaultModelOnRedirect(this.ignoreDefaultModelOnRedirect);
  22. AsyncWebRequest asyncWebRequest = WebAsyncUtils.createAsyncWebRequest(request, response);
  23. asyncWebRequest.setTimeout(this.asyncRequestTimeout);
  24. WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
  25. asyncManager.setTaskExecutor(this.taskExecutor);
  26. asyncManager.setAsyncWebRequest(asyncWebRequest);
  27. asyncManager.registerCallableInterceptors(this.callableInterceptors);
  28. asyncManager.registerDeferredResultInterceptors(this.deferredResultInterceptors);
  29. if (asyncManager.hasConcurrentResult()) {
  30. Object result = asyncManager.getConcurrentResult();
  31. mavContainer = (ModelAndViewContainer) asyncManager.getConcurrentResultContext()[0];
  32. asyncManager.clearConcurrentResult();
  33. if (logger.isDebugEnabled()) {
  34. logger.debug("Found concurrent result value [" + result + "]");
  35. }
  36. invocableMethod = invocableMethod.wrapConcurrentResult(result);
  37. }
  38. invocableMethod.invokeAndHandle(webRequest, mavContainer);
  39. if (asyncManager.isConcurrentHandlingStarted()) {
  40. return null;
  41. }
  42. return getModelAndView(mavContainer, modelFactory, webRequest);
  43. }
  44. finally {
  45. webRequest.requestCompleted();
  46. }
  47. }

invocableMethod.invokeAndHandle()最终要实现的目的就是:完成 Request 中的参数和方法参数上数据的绑定。Spring MVC 中提供两种 Request 参数到方法中参数的绑定方式:
1、通过注解进行绑定,@RequestParam。
2、通过参数名称进行绑定。
使用注解进行绑定,我们只要在方法参数前面声明@RequestParam(“name”),就可以将 request 中参数 name 的值绑定到方法的该参数上。使用参数名称进行绑定的前提是必须要获取方法中参数的名称,Java 反射只提供了获取方法的参数的类型,并没有提供获取参数名称的方法。SpringMVC 解决这个问题的方法是用 asm 框架读取字节码文件,来获取方法的参数名称。asm 框架是一个字节码操作框架,关于 asm 更多介绍可以参考其官网。个人建议,使用注解来完成参数绑定,这样就可以省去 asm 框架的读取字节码 的操作。

  1. public class InvocableHandlerMethod extends HandlerMethod {
  2. @Nullable
  3. public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer,
  4. Object... providedArgs) throws Exception {
  5. Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);
  6. if (logger.isTraceEnabled()) {
  7. logger.trace("Invoking '" + ClassUtils.getQualifiedMethodName(getMethod(), getBeanType()) +
  8. "' with arguments " + Arrays.toString(args));
  9. }
  10. Object returnValue = doInvoke(args);
  11. if (logger.isTraceEnabled()) {
  12. logger.trace("Method [" + ClassUtils.getQualifiedMethodName(getMethod(), getBeanType()) +
  13. "] returned [" + returnValue + "]");
  14. }
  15. return returnValue;
  16. }
  17. private Object[] getMethodArgumentValues(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer,
  18. Object... providedArgs) throws Exception {
  19. MethodParameter[] parameters = getMethodParameters();
  20. Object[] args = new Object[parameters.length];
  21. for (int i = 0; i < parameters.length; i++) {
  22. MethodParameter parameter = parameters[i];
  23. parameter.initParameterNameDiscovery(this.parameterNameDiscoverer);
  24. args[i] = resolveProvidedArgument(parameter, providedArgs);
  25. if (args[i] != null) {
  26. continue;
  27. }
  28. if (this.argumentResolvers.supportsParameter(parameter)) {
  29. try {
  30. args[i] = this.argumentResolvers.resolveArgument(
  31. parameter, mavContainer, request, this.dataBinderFactory);
  32. continue;
  33. }
  34. catch (Exception ex) {
  35. if (logger.isDebugEnabled()) {
  36. logger.debug(getArgumentResolutionErrorMessage("Failed to resolve", i), ex);
  37. }
  38. throw ex;
  39. }
  40. }
  41. if (args[i] == null) {
  42. throw new IllegalStateException("Could not resolve method parameter at index " +
  43. parameter.getParameterIndex() + " in " + parameter.getExecutable().toGenericString() +
  44. ": " + getArgumentResolutionErrorMessage("No suitable resolver for", i));
  45. }
  46. }
  47. return args;
  48. }
  49. }

关于 asm 框架获取方法参数的部分,这里就不再进行分析了。感兴趣的小伙伴可以继续深入了解这个处理过程。
到这里,方法的参数值列表也获取到了,就可以直接进行方法的调用了。整个请求过程中最复杂的一步就是在这里了。到这里整个请求处理过程的关键步骤都已了解。理解了Spring MVC 中的请求处理流程,整个代码还是比较清晰的。最后我们再来梳理一下Spring MVC 核心组件的关联关系(如下图):
image.png

时序图

image.png


**