ModelAndViewContainer、ModelMap、Model、ModelAndView详细介绍【享学Spring MVC】（上）

Records model and view related decisions made by {@link HandlerMethodArgumentResolver HandlerMethodArgumentResolvers} and
{@link HandlerMethodReturnValueHandler HandlerMethodReturnValueHandlers} during the course of invocation of a controller method.

// @since 3.1
public class ModelAndViewContainer {
  // =================它所持有的这些属性还是蛮重要的=================
  // redirect时,是否忽略defaultModel 默认值是false：不忽略
  private boolean ignoreDefaultModelOnRedirect = false;
  // 此视图可能是个View，也可能只是个逻辑视图String
  @Nullable
  private Object view;
  // defaultModel默认的Model
  // 注意：ModelMap 只是个Map而已，但是实现类BindingAwareModelMap它却实现了org.springframework.ui.Model接口
  private final ModelMap defaultModel = new BindingAwareModelMap();
  // 重定向时使用的模型（提供set方法设置进来）
  @Nullable
  private ModelMap redirectModel;
  // 控制器是否返回重定向指令
  // 如：使用了前缀"redirect:xxx.jsp"这种，这个值就是true。然后最终是个RedirectView
  private boolean redirectModelScenario = false;
  // Http状态码
  @Nullable
  private HttpStatus status;
  private final Set<String> noBinding = new HashSet<>(4);
  private final Set<String> bindingDisabled = new HashSet<>(4);
  // 很容易想到，它和@SessionAttributes标记的元素有关
  private final SessionStatus sessionStatus = new SimpleSessionStatus();
  // 这个属性老重要了：标记handler是否**已经完成**请求处理
  // 在链式操作中，这个标记很重要
  private boolean requestHandled = false;
  ...
  public void setViewName(@Nullable String viewName) {
    this.view = viewName;
  }
  public void setView(@Nullable Object view) {
    this.view = view;
  }
  // 是否是视图的引用
  public boolean isViewReference() {
    return (this.view instanceof String);
  }
  // 是否使用默认的Model
  private boolean useDefaultModel() {
    return (!this.redirectModelScenario || (this.redirectModel == null && !this.ignoreDefaultModelOnRedirect));
  }
  // 注意子方法和下面getDefaultModel()方法的区别
  public ModelMap getModel() {
    if (useDefaultModel()) { // 使用默认视图
      return this.defaultModel;
    } else {
      if (this.redirectModel == null) { // 若重定向视图为null，就new一个空的返回
        this.redirectModel = new ModelMap();
      }
      return this.redirectModel;
    }
  }
  // @since 4.1.4
  public ModelMap getDefaultModel() {
    return this.defaultModel;
  }
  // @since 4.3 可以设置响应码，最终和ModelAndView一起被View渲染时候使用
  public void setStatus(@Nullable HttpStatus status) {
    this.status = status;
  }
  // 以编程方式注册一个**不应**发生数据绑定的属性，对于随后声明的@ModelAttribute也是不能绑定的
  // 虽然方法是set 但内部是add哦  ~~~~
  public void setBindingDisabled(String attributeName) {
    this.bindingDisabled.add(attributeName);
  }
  public boolean isBindingDisabled(String name) {
    return (this.bindingDisabled.contains(name) || this.noBinding.contains(name));
  }
  // 注册是否应为相应的模型属性进行数据绑定
  public void setBinding(String attributeName, boolean enabled) {
    if (!enabled) {
      this.noBinding.add(attributeName);
    } else {
      this.noBinding.remove(attributeName);
    }
  }
  // 这个方法需要重点说一下：请求是否已在处理程序中完全处理
  // 举个例子：比如@ResponseBody标注的方法返回值，无需View继续去处理，所以就可以设置此值为true了
  // 说明：这个属性也就是可通过源生的ServletResponse、OutputStream来达到同样效果的
  public void setRequestHandled(boolean requestHandled) {
    this.requestHandled = requestHandled;
  }
  public boolean isRequestHandled() {
    return this.requestHandled;
  }
  // =========下面是Model的相关方法了==========
  // addAttribute/addAllAttributes/mergeAttributes/removeAttributes/containsAttribute
}

RequestMappingHandlerAdapter：
  @Nullable
  private ModelAndView getModelAndView(ModelAndViewContainer mavContainer ModelFactory modelFactory, NativeWebRequest webRequest) throws Exception {
    // 将列为@SessionAttributes的模型属性提升到会话
    modelFactory.updateModel(webRequest, mavContainer);
    if (mavContainer.isRequestHandled()) {
      return null;
    }
    ModelMap model = mavContainer.getModel();
    ModelAndView mav = new ModelAndView(mavContainer.getViewName(), model, mavContainer.getStatus());
    // 真正的View 可见ModelMap/视图名称、状态HttpStatus最终都交给了Veiw去渲染
    if (!mavContainer.isViewReference()) {
      mav.setView((View) mavContainer.getView());
    }
    // 这个步骤：是Spring MVC对重定向的支持~~~~
    // 重定向之间传值，使用的RedirectAttributes这种Model~~~~
    if (model instanceof RedirectAttributes) {
      Map<String, ?> flashAttributes = ((RedirectAttributes) model).getFlashAttributes();
      HttpServletRequest request = webRequest.getNativeRequest(HttpServletRequest.class);
      if (request != null) {
        RequestContextUtils.getOutputFlashMap(request).putAll(flashAttributes);
      }
    }
  }