Spring MVC 的工作流程

Spring MVC 的工作流程

文字描述

1）用户发送请求到前端控制器DispatcherServlet

2）DispatcherServlet 收到请求调用 HandleMapping处理器映射器

3）处理器映射器找到具体的处理器（可以根据xml配置文件、注解进行查找），生成处理器及处理器拦截器（如果有则生成）一并返回给DispatcherServlet

4）DispatcherServlet 调用HandleAdapter处理器适配器

5）HandleAdapter经过适配器调用具体的处理器（Controller，也叫后端控制器）

6）controller执行完成返回 ModelAndView

7）HandlerAdapt将controller执行结果ModelAndView返回给DispatcherServlet

8）DispatcherServlet 将ModelAndView传给ViewReslover视图解析器

9）ViewReslover 解析后返回具体View

10）DispatcherServlet 根据View进行渲染视图

11）DispatcherServlet 响应用户

代码走查

DispatcherServlet 的doService() 方法

protected void doService(HttpServletRequest request, HttpServletResponse response) throws Exception {
   if (logger.isDebugEnabled()) {
      String resumed = WebAsyncUtils.getAsyncManager(request).hasConcurrentResult() ? " resumed" : "";
      logger.debug("DispatcherServlet with name '" + getServletName() + "'" + resumed +
            " processing " + request.getMethod() + " request for [" + getRequestUri(request) + "]");
   }

   // Keep a snapshot of the request attributes in case of an include,
   // to be able to restore the original attributes after the include.
   Map<String, Object> attributesSnapshot = null;
   if (WebUtils.isIncludeRequest(request)) {
      attributesSnapshot = new HashMap<>();
      Enumeration<?> attrNames = request.getAttributeNames();
      while (attrNames.hasMoreElements()) {
         String attrName = (String) attrNames.nextElement();
         if (this.cleanupAfterInclude || attrName.startsWith(DEFAULT_STRATEGIES_PREFIX)) {
            attributesSnapshot.put(attrName, request.getAttribute(attrName));
         }
      }
   }

   // Make framework objects available to handlers and view objects.
   request.setAttribute(WEB_APPLICATION_CONTEXT_ATTRIBUTE, getWebApplicationContext());
   request.setAttribute(LOCALE_RESOLVER_ATTRIBUTE, this.localeResolver);
   request.setAttribute(THEME_RESOLVER_ATTRIBUTE, this.themeResolver);
   request.setAttribute(THEME_SOURCE_ATTRIBUTE, getThemeSource());

   if (this.flashMapManager != null) {
      FlashMap inputFlashMap = this.flashMapManager.retrieveAndUpdate(request, response);
      if (inputFlashMap != null) {
         request.setAttribute(INPUT_FLASH_MAP_ATTRIBUTE, Collections.unmodifiableMap(inputFlashMap));
      }
      request.setAttribute(OUTPUT_FLASH_MAP_ATTRIBUTE, new FlashMap());
      request.setAttribute(FLASH_MAP_MANAGER_ATTRIBUTE, this.flashMapManager);
   }

   try {
       
       //执行doDisPatch方法
      doDispatch(request, response);
   }
   finally {
      if (!WebAsyncUtils.getAsyncManager(request).isConcurrentHandlingStarted()) {
         // Restore the original attribute snapshot, in case of an include.
         if (attributesSnapshot != null) {
            restoreAttributesAfterInclude(request, attributesSnapshot);
         }
      }
   }
}

doDisPatch方法（核心处理方法 分发操作）

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
   HttpServletRequest processedRequest = request;
   HandlerExecutionChain mappedHandler = null;
   boolean multipartRequestParsed = false;

   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.
          //这是在寻找HanderMappings 返回值是HandlerExecutionChain类型 其中包括了Handler和拦截器
         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 (logger.isDebugEnabled()) {
               logger.debug("Last-Modified value for [" + getRequestUri(request) + "] is: " + lastModified);
            }
            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);
         }
      }
   }
}

getHandler()方法 调用处理器映射器

protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {
   if (this.handlerMappings != null) {
      for (HandlerMapping hm : this.handlerMappings) {
         if (logger.isTraceEnabled()) {
            logger.trace(
                  "Testing handler map [" + hm + "] in DispatcherServlet with name '" + getServletName() + "'");
         }
          
          //这一步才是封装HandlerExecutionChain
         HandlerExecutionChain handler = hm.getHandler(request);
         if (handler != null) {
            return handler;
         }
      }
   }
   return null;
}

hm.getHandler()方法进行实际的封装

public final HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {
   Object handler = getHandlerInternal(request);
   if (handler == null) {
      handler = getDefaultHandler();
   }
   if (handler == null) {
      return null;
   }
   // Bean name or resolved handler?
   if (handler instanceof String) {
      String handlerName = (String) handler;
       
      handler = obtainApplicationContext().getBean(handlerName);
   }

    //获取HandlerExecutionChain
   HandlerExecutionChain executionChain = getHandlerExecutionChain(handler, request);
   if (CorsUtils.isCorsRequest(request)) {
      CorsConfiguration globalConfig = this.globalCorsConfigSource.getCorsConfiguration(request);
      CorsConfiguration handlerConfig = getCorsConfiguration(handler, request);
      CorsConfiguration config = (globalConfig != null ? globalConfig.combine(handlerConfig) : handlerConfig);
      executionChain = getCorsHandlerExecutionChain(request, executionChain, config);
   }
   return executionChain;
}

HandlerExecutionChain（）真正的获取HandlerExecutionChain

protected HandlerExecutionChain getHandlerExecutionChain(Object handler, HttpServletRequest request) {
   HandlerExecutionChain chain = (handler instanceof HandlerExecutionChain ?
         (HandlerExecutionChain) handler : new HandlerExecutionChain(handler));

   String lookupPath = this.urlPathHelper.getLookupPathForRequest(request);
   for (HandlerInterceptor interceptor : this.adaptedInterceptors) {
      if (interceptor instanceof MappedInterceptor) {
         MappedInterceptor mappedInterceptor = (MappedInterceptor) interceptor;
         if (mappedInterceptor.matches(lookupPath, this.pathMatcher)) {
            chain.addInterceptor(mappedInterceptor.getInterceptor());
         }
      }
      else {
         chain.addInterceptor(interceptor);
      }
   }
   return chain;
}

getHandlerAdapter() 获取处理器适配器

protected HandlerAdapter getHandlerAdapter(Object handler) throws ServletException {
   if (this.handlerAdapters != null) {
       
       //循环遍历获取相应的适配器
       //spring内置的适配器
       //RequestMappingHandlerAdapter
       //HttpRequestHandlerAdapter
       //SimpleControllerHandlerAdapter
      for (HandlerAdapter ha : this.handlerAdapters) {
         if (logger.isTraceEnabled()) {
            logger.trace("Testing handler adapter [" + ha + "]");
         }
         if (ha.supports(handler)) {
            return ha;
         }
      }
   }
   throw new ServletException("No adapter for handler [" + handler +
         "]: The DispatcherServlet configuration needs to include a HandlerAdapter that supports this handler");
}

ha.handle() 调用所选handler的handler方法

((Controller) handler).handleRequest(request, response);
((HttpRequestHandler) handler).handleRequest(request, response);
((Servlet) handler).service(request, response);

processDispatchResult() 渲染结果

private void processDispatchResult(HttpServletRequest request, HttpServletResponse response,
      @Nullable HandlerExecutionChain mappedHandler, @Nullable ModelAndView mv,
      @Nullable Exception exception) throws Exception {

   boolean errorView = false;

   if (exception != null) {
      if (exception instanceof ModelAndViewDefiningException) {
         logger.debug("ModelAndViewDefiningException encountered", exception);
         mv = ((ModelAndViewDefiningException) exception).getModelAndView();
      }
      else {
         Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);
         mv = processHandlerException(request, response, handler, exception);
         errorView = (mv != null);
      }
   }

   // Did the handler return a view to render?
   if (mv != null && !mv.wasCleared()) {
       
       //
      render(mv, request, response);
      if (errorView) {
         WebUtils.clearErrorRequestAttributes(request);
      }
   }
   else {
      if (logger.isDebugEnabled()) {
         logger.debug("Null ModelAndView returned to DispatcherServlet with name '" + getServletName() +
               "': assuming HandlerAdapter completed request handling");
      }
   }

   if (WebAsyncUtils.getAsyncManager(request).isConcurrentHandlingStarted()) {
      // Concurrent handling started during a forward
      return;
   }

   if (mappedHandler != null) {
      mappedHandler.triggerAfterCompletion(request, response, null);
   }
}

render ()

protected void render(ModelAndView mv, HttpServletRequest request, HttpServletResponse response) throws Exception {   // Determine locale for request and apply it to the response.   Locale locale =         (this.localeResolver != null ? this.localeResolver.resolveLocale(request) : request.getLocale());   response.setLocale(locale);   View view;   String viewName = mv.getViewName();   if (viewName != null) {      // We need to resolve the view name.      view = resolveViewName(viewName, mv.getModelInternal(), locale, request);      if (view == null) {         throw new ServletException("Could not resolve view with name '" + mv.getViewName() +               "' in servlet with name '" + getServletName() + "'");      }   }   else {      // No need to lookup: the ModelAndView object contains the actual View object.      view = mv.getView();      if (view == null) {         throw new ServletException("ModelAndView [" + mv + "] neither contains a view name nor a " +               "View object in servlet with name '" + getServletName() + "'");      }   }   // Delegate to the View object for rendering.   if (logger.isDebugEnabled()) {      logger.debug("Rendering view [" + view + "] in DispatcherServlet with name '" + getServletName() + "'");   }   try {      if (mv.getStatus() != null) {         response.setStatus(mv.getStatus().value());      }      view.render(mv.getModelInternal(), request, response);   }   catch (Exception ex) {      if (logger.isDebugEnabled()) {         logger.debug("Error rendering view [" + view + "] in DispatcherServlet with name '" +               getServletName() + "'", ex);      }      throw ex;   }}

resolveViewName() 将MV转换为View

protected View resolveViewName(String viewName, @Nullable Map<String, Object> model,      Locale locale, HttpServletRequest request) throws Exception {   if (this.viewResolvers != null) {       //获取合适的视图解析器 解析MV 返回View      for (ViewResolver viewResolver : this.viewResolvers) {         View view = viewResolver.resolveViewName(viewName, locale);         if (view != null) {            return view;         }      }   }   return null;}

view.render()方法渲染数据 并将数据发送到客户端

public void render(@Nullable Map<String, ?> model, HttpServletRequest request,      HttpServletResponse response) throws Exception {   if (logger.isTraceEnabled()) {      logger.trace("Rendering view with name '" + this.beanName + "' with model " + model +         " and static attributes " + this.staticAttributes);   }   Map<String, Object> mergedModel = createMergedOutputModel(model, request, response);   prepareResponse(request, response);      //发送数据到客户端   // 其中有个接口有 rd.forward(request, response);   renderMergedOutputModel(mergedModel, getRequestToExpose(request), response);}