乐趣区

ModelAndViewContainerModelMapModel详细介绍享学Spring-MVC

jiezi

每篇一句

一个开源的技术产品做得好不好，主要是看你能解决多少非功能性问题（因为功能性问题是所有产品都能够想到的）

前言

写这篇文章非我本意，因为我觉得对如题的这个几个类的了解还是比较基础且简单的一块内容，直到有超过两个同学问过我一些问题的时候：通过聊天发现小伙伴都听说过这几个类，但对于他们的使用、功能定位是傻傻分不清楚的（因为名字上都有很多的相似之处）。
那么书写本文就是当作一篇科普类文章记录下来，已经非常熟悉小伙伴就没太大必要往下继续阅读本文内容了，因为这块不算难的（当然我只是建议而已~）。

ModelAndViewContainer

我把这个类放在首位，是因为相较而言它的逻辑性稍强一点，并且对于理解处理器 ReturnValue 返回值的处理上有很好的帮助。

ModelAndViewContainer：可以把它定义为 ModelAndView 上下文的容器，它承担着 整个请求 过程中的数据传递工作 –> 保存着 Model 和View。官方 doc 对它的解释是这句话：

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

翻译成 ” 人话 ” 便是：记录 HandlerMethodArgumentResolver 和 HandlerMethodReturnValueHandler在处理 Controller 的 handler 方法时 使用的模型 model 和视图 view 相关信息.。

当然它除了保存 Model 和View外，还额外提供了一些其它功能。下面我们先来熟悉熟悉它的 API、源码：

// @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
}

直观的阅读过源码后，至少我能够得到如下结论，分享给大家：

  • 它维护了模型 model：包括 defaultModle 和redirectModel
  • defaultModel 是默认使用的 Model，redirectModel 是用于传递 redirect 时的 Model

  • 在 Controller 处理器入参写了 Model 或 ModelMap 类型时候，实际传入的是defaultModel。

        -     defaultModel 它实际是 `BindingAwareModel`，是个 `Map`。而且继承了 `ModelMap` 又实现了 `Model` 接口，所以在处理器中使用 `Model` 或 `ModelMap` 时，其实都是使用同一个对象~~~
    - 可参考 `MapMethodProcessor`，它最终调用的都是 `mavContainer.getModel()` 方法

  • 若处理器入参类型是 RedirectAttributes 类型，最终传入的是redirectModel。

        - 至于为何实际传入的是 `defaultModel`？？参考：`RedirectAttributesMethodArgumentResolver`，使用的是 `new RedirectAttributesModelMap(dataBinder)`。
  • 维护视图 view（兼容支持逻辑视图名称）
  • 维护是否 redirect 信息, 及根据这个判断 HandlerAdapter 使用的是 defaultModel 或 redirectModel
  • 维护 @SessionAttributes 注解信息 状态
  • 维护 handler 是否处理标记（重要）

下面我主要花笔墨重点介绍一下它的 requestHandled 这个属性的作用：

requestHandled 属性

1、首先看看 isRequestHandled() 方法的使用：
RequestMappingHandlerAdapter对 mavContainer.isRequestHandled() 方法的使用，或许你就能悟出点啥了：

这个方法的执行实际是：HandlerMethod完全调用执行完成后，就执行这个方法去拿 ModelAndView 了（传入了 request 和ModelAndViewContainer）

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);
            }
        }
    }

可以看到如果 ModelAndViewContainer 已经被处理过，此处直接返回 null，也就是不会再继续处理 Model 和 View 了~

2、setRequestHandled()方法的使用
作为设置方法，调用的地方有好多个，总结如下：

  • AsyncTaskMethodReturnValueHandler：处理返回值类型是 WebAsyncTask 的方法
// 若返回 null，就没必要继续处理了
if (returnValue == null) {mavContainer.setRequestHandled(true);
    return;
}
  • CallableMethodReturnValueHandler/DeferredResultMethodReturnValueHandler/StreamingResponseBodyReturnValueHandler：处理返回值类型是 Callable/DeferredResult/ListenableFuture/CompletionStage/StreamingResponseBody 的方法（原理同上）
  • HttpEntityMethodProcessor：返回值类型是 HttpEntity 的方法
// 看一看到，这种返回值的都会标注为已处理，这样就不再需要视图（渲染）了
    @Override
    public void handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {mavContainer.setRequestHandled(true); // 第一句就是这句代码
        if (returnValue == null) {return;}
        ... // 交给消息处理器去写        
        outputMessage.flush();}
  • 同上的原理的还有 HttpHeadersReturnValueHandler/RequestResponseBodyMethodProcessor/ResponseBodyEmitterReturnValueHandler 等等返回值处理器
  • ServletInvocableHandlerMethod/HandlerMethod在处理 Handler 方法时，有时也会标注 true 已处理（比如：get 请求 NotModified/ 已设置了 HttpStatus 状态码 /isRequestHandled()==true等等 case）。除了这些 case，method 方法执行完成后可都会显示设置 false 的（因为执行完 handlerMethod 后，还需要交给视图渲染~）
  • ServletResponseMethodArgumentResolver：这唯一一个是处理入参时候的。若入参类型是 ServletResponse/OutputStream/Writer，并且mavContainer != null，它就设置为 true 了（因为Spring MVC 认为既然你自己引入了 response，那你就自己做输出吧，因此使用时此处是需要特别注意的细节地方~）
resolveArgument()方法：if (mavContainer != null) {mavContainer.setRequestHandled(true); // 相当于说你自己需要 `ServletResponse`，那返回值就交给你自己处理吧~~~~
        }

本文最重要类：ModelAndViewContainer部分就介绍到这。接下来就介绍就很简单了，轻松且愉快

Model

org.springframework.ui.Model的概念不管是在 MVC 设计模式上，还是在 Spring MVC 里都是被经常提到的：它用于控制层给前端返回所需的数据（渲染所需的数据）

//  @since 2.5.1 它是一个接口
public interface Model {
    ...
    // addAttribute/addAllAttributes/mergeAttributes/containsAttribute
    ...
    // Return the current set of model attributes as a Map.
    Map<String, Object> asMap();}

它的继承树如下：

最重要的那必须是 ExtendedModelMap 啊，它留到介绍 ModelMap 的时候再详说，简单看看其余子类。

RedirectAttributes

从命名就能看出是和重定向有关的，它扩展了 Model 接口：

// @since 3.1
public interface RedirectAttributes extends Model {
    ...
    // 它扩展的三个方法，均和 flash 属性有关
    RedirectAttributes addFlashAttribute(String attributeName, @Nullable Object attributeValue);
    // 这里没指定 key，因为 key 根据 Conventions#getVariableName()自动生成
    RedirectAttributes addFlashAttribute(Object attributeValue);
    // Return the attributes candidate for flash storage or an empty Map.
    Map<String, ?> getFlashAttributes();}
RedirectAttributesModelMap

它实现了 RedirectAttributes 接口，同时也继承自 ModelMap，所以 ” 间接 ” 实现了Model 接口的所有方法。

public class RedirectAttributesModelMap extends ModelMap implements RedirectAttributes {
    @Nullable
    private final DataBinder dataBinder;
    private final ModelMap flashAttributes = new ModelMap();
    ...
    @Override
    public RedirectAttributesModelMap addAttribute(String attributeName, @Nullable Object attributeValue) {super.addAttribute(attributeName, formatValue(attributeValue));
        return this;
    }

    // 可见这里的 dataBinder 是用于数据转换的
    // 把所有参数都转换为 String 类型（因为 Http 都是 string 传参嘛）@Nullable
    private String formatValue(@Nullable Object value) {if (value == null) {return null;}
        return (this.dataBinder != null ? this.dataBinder.convertIfNecessary(value, String.class) : value.toString());
    }
    ...

    @Override
    public Map<String, Object> asMap() {return this;}
    @Override
    public RedirectAttributes addFlashAttribute(String attributeName, @Nullable Object attributeValue) {this.flashAttributes.addAttribute(attributeName, attributeValue);
        return this;
    }
    ...
}

我认为它唯一自己的做的有意义的事：借助 DataBinder 把添加进来的属性参数会转为 String 类型（为何是转换为 String 类型，你有想过吗？？？）~

ConcurrentModel

它是 Spring5.0 后才有的，是线程安全的Model，并没提供什么新鲜东西，略（运用于有线程安全问题的场景）

ModelMap

ModelMap继承自 LinkedHashMap，因此它的本质其实就是个 Map 而已。
它的特点是：借助 Map 的能力 间接的 实现了 org.springframework.ui.Model 的接口方法，这种设计技巧更值得我们参考学习的（曲线救国的意思有木有~）。

so，这里只需要看看 ExtendedModelMap 即可。它自己继承自ModelMap，没有啥特点，全部是调用父类的方法完成的接口方法复写，喵喵他的子类吧~

BindingAwareModelMap

注意：它和普通 ModelMap 的区别是：它能感知数据校验结果（如果放进来的 key 存在对应的绑定结果，并且你的 value 不是绑定结果本身。那就移除掉MODEL_KEY_PREFIX + key 这个 key 的键值对~）。

public class BindingAwareModelMap extends ExtendedModelMap {

    // 注解复写了 Map 的 put 方法，一下子就拦截了所有的 addAttr 方法。。。@Override
    public Object put(String key, Object value) {removeBindingResultIfNecessary(key, value);
        return super.put(key, value);
    }
    @Override
    public void putAll(Map<? extends String, ?> map) {map.forEach(this::removeBindingResultIfNecessary);
        super.putAll(map);
    }

    // 本类处理的逻辑：private void removeBindingResultIfNecessary(Object key, Object value) {
        // key 必须是 String 类型才会给与处理
        if (key instanceof String) {String attributeName = (String) key;
            if (!attributeName.startsWith(BindingResult.MODEL_KEY_PREFIX)) {
                String bindingResultKey = BindingResult.MODEL_KEY_PREFIX + attributeName;
                BindingResult bindingResult = (BindingResult) get(bindingResultKey);

                // 如果有校验结果，并且放进来的 value 值不是绑定结果本身，那就移除掉绑定结果（相当于覆盖掉）if (bindingResult != null && bindingResult.getTarget() != value) {remove(bindingResultKey);
                }
            }
        }
    }
}

Spring MVC 默认使用的就是这个ModelMap，但它提供的感知功能大多数情况下我们都用不着。不过反正也不用你管，乖乖用着呗

ModelAndView

顾名思义，ModelAndView指模型和视图的集合，既包含模型又包含视图；ModelAndView一般可以作为 Controller 的返回值，所以它的实例是开发者 自己手动创建的，这也是它和上面的主要区别（上面都是容器创建，然后注入给我们使用的~）。

因为这个类是直接面向开发者的，所以建议里面的一些 API 还是要熟悉点较好：

public class ModelAndView {
    @Nullable
    private Object view; // 可以是 View，也可以是 String
    @Nullable
    private ModelMap model;

    // 显然，你也可以自己就放置好一个 http 状态码进去
    @Nullable
    private HttpStatus status;    
    // 标记这个实例是否被调用过 clear()方法~~~
    private boolean cleared = false;

    // 总共这几个属性：它提供的构造函数非常的多  这里我就不一一列出
    public void setViewName(@Nullable String viewName) {this.view = viewName;}
    public void setView(@Nullable View view) {this.view = view;}
    @Nullable
    public String getViewName() {return (this.view instanceof String ? (String) this.view : null);
    }
    @Nullable
    public View getView() {return (this.view instanceof View ? (View) this.view : null);
    }
    public boolean hasView() {return (this.view != null);
    }
    public boolean isReference() {return (this.view instanceof String);
    }

    // protected 方法~~~
    @Nullable
    protected Map<String, Object> getModelInternal() {return this.model;}
    public ModelMap getModelMap() {if (this.model == null) {this.model = new ModelMap();
        }
        return this.model;
    }

    // 操作 ModelMap 的一些方法如下：// addObject/addAllObjects

    public void clear() {
        this.view = null;
        this.model = null;
        this.cleared = true;
    }
    // 前提是：this.view == null 
    public boolean isEmpty() {return (this.view == null && CollectionUtils.isEmpty(this.model));
    }
    
    // 竟然用的 was，歪果仁果然严谨  哈哈
    public boolean wasCleared() {return (this.cleared && isEmpty());
    }
}

很多人疑问：为何 Controller 的处理方法不仅仅可以返回 ModelAndView，还可以通过返回Map/Model/ModelMap 等来直接向页面传值呢？？？如果返回值是后三者，又是如何找到 view 完成渲染的呢？

这个问题我抛出来，本文不给答案。因为都聊到这了，此问题应该不算难的了，建议小伙伴 必须自行弄懂缘由（请不要放过有用的知识点）。若实在有不懂之处可以给留言我会帮你解答的~
答案参考提示：可参阅 ModelMethodProcessor 和ModelMethodProcessor对返回值的处理模块

绝大多数情况下，我都建议返回 ModelAndView，而不是其它那哥三。因为它哥三都没有指定视图名，所以通过DispatcherServlet.applyDefaultViewName() 生成的视图名一般都不是我们需要的。（除非你的目录、命名等等都 特别特别的规范，那顺便倒是可以省不少事~~~）

ModelFactory

关于 ModelFactory 它的介绍，这篇文章 里算是已经详细讲解过了，这里再简述两句它的作用。
ModelFactory是用来维护 Model 的，具体包含两个功能

  1. 初始化 Model
  2. 处理器执行后将 Mode l 中相应的参数更新到SessionAttributes 中（处理 @ModelAttribute 和@SessionAttributes）

总结

本以为本文不会很长的，没想到还是写成了超 10000 字的中篇文章。希望这篇文章能够帮助你对 Spring MVC 对模型、视图这块核心内容的理解，帮你扫除途中的一些障碍，共勉~
== 若对 Spring、SpringBoot、MyBatis 等源码分析感兴趣，可加我 wx：fsx641385712，手动邀请你入群一起飞 ==

退出移动版