SpringMVC源码(九)：无异常View视图解析

　　在MVC请求流程中，处理Controller控制器逻辑后获取到的ModelAndView对象并不能直接返回到浏览器，需要通过对ModelAndView中的View属性做解析获取视图，并用Model属性中的数据完成对视图的渲染再返回浏览器。

1、核心流程图

  

2、核心流程源码分析

　　处理ModelAndView返回结果进行View视图渲染，有关处理过程中出现异常的视图处理，在MVC异常处理时统一分析。本文着重对处理过程中无异常，返回结果为String类型的视图解析处理，DispatcherServlet#processDispatchResult() 核心伪代码：

private void processDispatchResult(HttpServletRequest request, HttpServletResponse response,
      @Nullable HandlerExecutionChain mappedHandler, @Nullable ModelAndView mv,
      @Nullable Exception exception) throws Exception {
    
   // 标记是否为处理生成异常的ModelAndView对象
   boolean errorView = false;
    
   // 如果请求处理过程中有异常抛出则处理异常
   if (exception != null) {
      // 从ModelAndViewDefiningException中获得ModelAndView对象
      if (exception instanceof ModelAndViewDefiningException) {
         logger.debug("ModelAndViewDefiningException encountered", exception);
         mv = ((ModelAndViewDefiningException) exception).getModelAndView();
      }
      // 处理异常，生成ModelAndView对象
      else {
         Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);
         mv = processHandlerException(request, response, handler, exception);
         errorView = (mv != null);
      }
   }
        
   // 是否进行页面渲染
   if (mv != null && !mv.wasCleared()) {
      // 渲染页面
      render(mv, request, response);
   }

   // 发出请求处理完成通知，触发Interceptor的afterCompletion
   if (mappedHandler != null) {
      mappedHandler.triggerAfterCompletion(request, response, null);
   }
}

　　有关处理过程中出现异常的场景，本节暂不分析。

2.1、是否需要页面渲染

　　当前ModelAndView对象不为空，当前ModelAndView对象是否被清理。

　　ModelAndView#wasCleared() 核心代码

// 当前实例是否被清理标识，通过调用clear()方法，可完成清理，默认为false
private boolean cleared = false;

// 当前ModelAndView是否被清理判断
public boolean wasCleared() {
   // 判断清理标识及 ModelAndView中的model属性、View属性
   return (this.cleared && isEmpty());
}

　　ModelAndView#wasCleared() 核心代码

// ModelAndView是否为一个空对象或者model属性、view为空
public boolean isEmpty() {
   return (this.view == null && CollectionUtils.isEmpty(this.model));
}

页面渲染条件：

　　ModelAndView对象不为空、当前ModelAndView对象未被清理，并且ModelAndView中的model属性、View属性都不为空，

2.2、页面渲染

　　页面渲染，DispatcherServlet#render() 核心伪代码：

protected void render(ModelAndView mv, HttpServletRequest request, HttpServletResponse response) throws Exception {
   // 解析request中获得Locale对象，并设置到response 中
   Locale locale =
         (this.localeResolver != null ? this.localeResolver.resolveLocale(request) : request.getLocale());
   response.setLocale(locale);

   // 声明 View 对象
   View view;
   // 获取ModelAndView中的视图
   String viewName = mv.getViewName();
   // 返回视图为字符串类型，通过对视图名称的解析获取视图
   if (viewName != null) {
      // 根据 viewName 获得 View 对象
      view = resolveViewName(viewName, mv.getModelInternal(), locale, request);
      // 获取不到view，抛出 ServletException 异常
      if (view == null) {
         throw new ServletException("Could not resolve view with name '" + mv.getViewName() +
               "' in servlet with name '" + getServletName() + "'");
      }
   }
   else {
      // 直接使用 ModelAndView 对象的 View 对象
      view = mv.getView();
      // 获取不到view，抛出 ServletException 异常
      if (view == null) {
         throw new ServletException("ModelAndView [" + mv + "] neither contains a view name nor a " +
               "View object in servlet with name '" + getServletName() + "'");
      }
   }

   // 设置响应的状态码
   if (mv.getStatus() != null) {
     response.setStatus(mv.getStatus().value());
   }
   // 渲染页面
   view.render(mv.getModelInternal(), request, response);
}

1、解析请求Request获取Locale设置到响应Response中

　　语言处理器LocaleResolver为MVC内置的九大组件之一，在源码(三)：MVC九大内置组件初始化中已经提到DispatcherServlet#localeResolver属性的初始化，获取默认处理器AcceptHeaderLocaleResolver，这里不再赘述。

 

2、获取视图View

　　获取View视图名称，ModelAndView#getViewName() 核心代码

// 若未view为字符串类型，则返回view；否则返回null
public String getViewName() {
   return (this.view instanceof String ? (String) this.view : null);
}

获取ModelAndView对象中的view属性，对view类型做如下判断

2.1、ModelAndView属性view类型为String

　　解析返回的字符串获取View对象，DispatcherServlet#resolveViewName() 核心代码

// 解析视图名称
protected View resolveViewName(String viewName, @Nullable Map<String, Object> model,
      Locale locale, HttpServletRequest request) throws Exception {
   // 视图解析器为空，返回null
   if (this.viewResolvers != null) {
      // 遍历 ViewResolver 数组
      for (ViewResolver viewResolver : this.viewResolvers) {
         // 根据 viewName + locale 参数，解析出 View 对象
         View view = viewResolver.resolveViewName(viewName, locale);
         // 解析成功，直接返回 View 对象
         if (view != null) {
            return view;
         }
      }
   }
   return null;
}

　　在源码(三)：MVC九大内置组件初始化中已提及视图解析器ViewResolver的初始化，获取MVC默认的视图解析器InternalResourceViewResolver，类图如下：

  

　　InternalResourceViewResolver对象的构造函数如下，在创建InternalResourceViewResolver对象时，初始化viewClass属性为JstlView.class。

public InternalResourceViewResolver() {
   Class<?> viewClass = requiredViewClass();
   if (InternalResourceView.class == viewClass && jstlPresent) {
      viewClass = JstlView.class;
   }
   setViewClass(viewClass);
}

　　resolveViewName()方法在父类AbstractCachingViewResolver中实现，下面来看看视图是如何被解析出来的，AbstractCachingViewResolver#resolveViewName()核心伪代码

public View resolveViewName(String viewName, Locale locale) throws Exception {
   // 如果禁用缓存，则创建 viewName 对应的 View 对象
   if (!isCache()) {
      return createView(viewName, locale);
   }
   else {
      // 获得缓存 KEY
      Object cacheKey = getCacheKey(viewName, locale);
      // 从 viewAccessCache 缓存中，获得 View 对象
      View view = this.viewAccessCache.get(cacheKey);
      // 如果获得不到缓存，则从 viewCreationCache 中，获得 View 对象
      if (view == null) {
         synchronized (this.viewCreationCache) {
            // 从 viewCreationCache 中，获得 View 对象
            view = this.viewCreationCache.get(cacheKey);
            if (view == null) {
               // Ask the subclass to create the View object.
               // 创建 viewName 对应的 View 对象
               view = createView(viewName, locale);
               // 如果创建失败，但是 cacheUnresolved 为 true ，则设置为 UNRESOLVED_VIEW
               if (view == null && this.cacheUnresolved) {
                  view = UNRESOLVED_VIEW;
               }
               // 如果 view 非空，则添加到 viewAccessCache 缓存中
               if (view != null && this.cacheFilter.filter(view, viewName, locale)) {
                  this.viewAccessCache.put(cacheKey, view);
                  this.viewCreationCache.put(cacheKey, view);
               }
            }
         }
      }
      
      return (view != UNRESOLVED_VIEW ? view : null);
   }
}

1、如果禁用缓存，创建视图

2、获取缓存的key

　　获取缓存的Key,直接返回viewName，UrlBasedViewResolver#getCacheKey() 核心代码

// 获取缓存的key
protected Object getCacheKey(String viewName, Locale locale) {
   // 重写了父类的方法，去除locale直接返回viewName
   return viewName;
}

3、创建视图View　　

　　根据key从AbstractCachingViewResolver的viewAccessCache缓存中获取View视图，若为缓存中不存在，创建View视图并添加进缓存中；若缓存中存在，返回缓存中的视图。

　　当前缓存中不存在需创建视图，创建视图 UrlBasedViewResolver#createView() 核心伪代码

// 创建视图
protected View createView(String viewName, Locale locale) throws Exception {
   // ...
   // 调用父类实现，加载视图
   return super.createView(viewName, locale);
}

-> 创建视图 AbstractCachingViewResolver#createView() 核心代码

// 创建视图
protected View createView(String viewName, Locale locale) throws Exception {
   // 根据视图名称加载视图
   return loadView(viewName, locale); 
}

 -> 加载视图 UrlBasedViewResolver#loadView() 核心伪代码

// 加载视图
protected View loadView(String viewName, Locale locale) throws Exception {
   // 创建 viewName 对应的 View 对象
   AbstractUrlBasedView view = buildView(viewName);
   // 完成view实例初始化bean的处理
   View result = applyLifecycleMethods(viewName, view);
   // 返回view对象
   return (view.checkResource(locale) ? result : null);
}

构建并返回View视图，构建View视图，UrlBasedViewResolver#buildView() 核心伪代码：

protected AbstractUrlBasedView buildView(String viewName) throws Exception {
   // 获取Class对象，在InternalResourceViewResolver类构造器中设置JstlView.class
   Class<?> viewClass = getViewClass();
   // 通过反射实例化View对象
   AbstractUrlBasedView view = (AbstractUrlBasedView) BeanUtils.instantiateClass(viewClass);
   // 设置url: 配置文件中 前缀 + 视图名称 + 后缀
   view.setUrl(getPrefix() + viewName + getSuffix());
   view.setAttributesMap(getAttributesMap());
   // ...
   return view;
}

　　完成View对象的创建及视图路径url的拼接设置，返回view对象详情。

  

4、 如果视图创建失败，但是 cacheUnresolved 为 true ，则设置为 UNRESOLVED_VIEW 进缓存中

5、如果解析视图失败返回null，否则返回解析的View视图对象

2.2、ModelAndView属性view类型为View

　　如果ModelAndView属性view为View类型，直接获取View对象，若属性为空，抛出异常。

2.3、View页面渲染

　　页面渲染，AbstractView#render() 核心伪代码：

public void render(@Nullable Map<String, ?> model, HttpServletRequest request,
      HttpServletResponse response) throws Exception {

   // 合并返回结果，将 Model 中的静态数据和请求中的动态数据进行合并
   Map<String, Object> mergedModel = createMergedOutputModel(model, request, response);
   // 进行一些准备工作（修复 IE 中存在的 BUG）
   prepareResponse(request, response);
   // 进行渲染
   renderMergedOutputModel(mergedModel, getRequestToExpose(request), response);
}

1、将request请求中的参数与model属性中的参数合并

2、进行页面渲染

　　页面渲染，InternalResourceView#renderMergedOutputModel() 核心伪代码

protected void renderMergedOutputModel(
      Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception {

   // 将model内容设置进request的属性中
   exposeModelAsRequestAttributes(model, request);

   // 往请求中设置一些属性，Locale、TimeZone、LocalizationContext
   exposeHelpers(request);

   // 获取需要转发的路径
   String dispatcherPath = prepareForRendering(request, response);

   // 获取请求转发器
   RequestDispatcher rd = getRequestDispatcher(request, dispatcherPath);
   
   // ...
   // 进行转发
   rd.forward(request, response);
}

　　1、将model属性设置到request的attribute属性中，并设置request其他相关属性

　　2、根据需要转发的路径与request请求，获取请求转发器

　　3、由请求转发器进行转发，后续流程由tomcat处理。