SpringMVC源码解析 - HandlerAdater - ModelAndViewContainer上下文容器

HandlerAdapter在处理请求时上下文数据的传递工作是由ModelAndViewContainer负责的.

源码注释是这样描述的:

Records model and view related decisions made by HandlerMethodArgumentResolvers and HandlerMethodReturnValueHandlers during the course of invocation of a controller method.

翻译下: 记录HandlerMethodArgumentResolver 和 HandlerMethodReturnValueHandler 在处理handler时 使用的模型model和视图view相关信息.

ModelAndViewContainer主要职责:

　　1. 维护模型model,包括defaultModle和redirectModel

　　2. 维护视图view

　　3. 维护是否redirect信息,及根据这个判断HandlerAdapter使用的是defaultModel或redirectModel(判断规则详见下文)

　　4. 维护@SessionAttributes注解信息状态

　　5. 维护handler是否处理标记

 

目录:

1. ModelAndViewContainer属性

2. 科普ModelMap继承体系

3. ModelAndView提供的api,复杂的还是model相关的属性设置,其他主要是简单的getter,setter

 

ModelAndViewContainer属性

先来看看ModelAndViewContainer的属性,这样就比较清晰:

package org.springframework.web.method.support;
public class ModelAndViewContainer {
    // 视图,实际使用时可能是String类型的逻辑视图
    private Object view;
    // 标记handler是否已经完成请求处理
    private boolean requestHandled = false;
    // 默认模型,下文我们可以简单科普下ModelMap继承体系
    private final ModelMap defaultModel = new BindingAwareModelMap();
    // redirect时使用的模型,实际使用的是RedirectAttributesModelMap
    private ModelMap redirectModel;
    // 标记处理器返回redirect视图
    private boolean redirectModelScenario = false;
    // redirect时,是否忽略defaultModel
    private boolean ignoreDefaultModelOnRedirect = false;
    // @SessionAttributes注解使用状态标记,就是是否处理完毕
    private final SessionStatus sessionStatus = new SimpleSessionStatus();
}

 顺便学个英语单词,Scenario 方案

 

 

科普ModelMap继承体系

继续往下分析之前,我们先来简单科普下ModelMap的继承体系:

各个类的职责与使用场景:

　　ModelMap是LinkedHashMap的子类,主要是封装attribute概念,实际处理还是委托给map

　　ExtendedModelMap添加链调用chained calls,并实现Model接口

　　BindingAwareModelMap,BindingResult相关属性被设置时,自动清除BindingResult.defaultModel使用的该类.

　　RedirectAttributesModelMap 通过DataBinder做参数类型转换,redirect时使用的flash attributes

 

各有侧重地看下源码吧

　　2.1 ModelMap,是继承LinkedHashMap,添加mergeAttributes 

package org.springframework.ui;
public class ModelMap extends LinkedHashMap<String, Object> {
    public ModelMap mergeAttributes(Map<String, ?> attributes) {
        if (attributes != null) {
            for (String key : attributes.keySet()) {
                if (!containsKey(key)) {
                    put(key, attributes.get(key));
                }
            }
        }
        return this;
    }
    // ...
}

　　2.2 ExtendedModelMap添加链调用chained calls

package org.springframework.ui;
public class ExtendedModelMap extends ModelMap implements Model {
    @Override
    public ExtendedModelMap addAttribute(String attributeName, Object attributeValue) {
        super.addAttribute(attributeName, attributeValue);
        return this;// 看这里
    }
    // ...
}

　　2.3 BindingAwareModelMap,BindingResult相关属性被设置时,自动清除BindingResult.defaultModel使用的该类.

　　看的就是removeBindingResultIfNecessary.这边put和putAll都会调用removeBindingResultIfNecessary

package org.springframework.validation.support;
public class BindingAwareModelMap extends ExtendedModelMap {

    @Override
    public Object put(String key, Object value) {
        removeBindingResultIfNecessary(key, value);
        return super.put(key, value);
    }
    // ...
    private void removeBindingResultIfNecessary(Object key, Object value) {
        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);
                if (bindingResult != null && bindingResult.getTarget() != value) {
                    remove(bindingResultKey);
                }
            }
        }
    }

}

　　2.4 RedirectAttributesModelMap 通过DataBinder做参数类型转换,redirect时使用的flash attributes

　　这样主要就是添加了dataBinder和flashAttributes属性相关的api

package org.springframework.web.servlet.mvc.support;
public class RedirectAttributesModelMap extends ModelMap implements RedirectAttributes {

 4     private final DataBinder dataBinder;

 6     private final ModelMap flashAttributes = new ModelMap();

    private String formatValue(Object value) {
        if (value == null) {
            return null;
        }
12         return (dataBinder != null) ? dataBinder.convertIfNecessary(value, String.class) : value.toString();
    }
    // ...
}

 

ModelAndView提供的api

主要是两类api,view相关和model相关.

　　3.1 view相关其实就一个api,是否类应用(通过是否是string类型判断):

package org.springframework.web.method.support;
public class ModelAndViewContainer {
    // ...
    /**
     * Whether the view is a view reference specified via a name to be
     * resolved by the DispatcherServlet via a ViewResolver.
     */
    public boolean isViewReference() {
        return (this.view instanceof String);
    }
}

　　3.2 model相关的api就比较多了,主要是设置模型值.

　　在设置模型值的时候,这边涉及到一个问题,就是container里有两个model,往哪个里设置?

　　container索性抽象一个getModel()的api进行判断.

　　我们来说说判断的逻辑吧:

　　　　使用defaultModel的场景:

　　　　a,不是redirect　　

　　　　b,redirect场景下,redirectModel为null,同时ignoreDefaultModelOnRedirect为false

　　　　剩下的就是使用redirectModel的场景了,不细说

　　model相关属性操作的类都是跟addAttribute类似的逻辑,使用getModel获取model后直接委托.所以篇幅缘故下面的源码以addAttribute为例,其他都只是展现api 的signature

package org.springframework.web.method.support;
public class ModelAndViewContainer {
    // ...
    /**
     * Return the model to use: the "default" or the "redirect" model.
     * <p>The default model is used if {@code "redirectModelScenario=false"} or
     * if the redirect model is {@code null} (i.e. it wasn't declared as a
     * method argument) and {@code ignoreDefaultModelOnRedirect=false}.
     */
    public ModelMap getModel() {
        if (useDefaultModel()) {
            return this.defaultModel;
        }
        else {
            return (this.redirectModel != null) ? this.redirectModel : new ModelMap();
        }
    }
    /**
     * Whether to use the default model or the redirect model.
     * 不是redirect || redirect时redirectModel为空同时不忽略defaultModel
     */
    private boolean useDefaultModel() {
        return !this.redirectModelScenario || ((this.redirectModel == null) && !this.ignoreDefaultModelOnRedirect);
    }
    public ModelAndViewContainer addAttribute(String name, Object value) {
        getModel().addAttribute(name, value);
        return this;
    }
    public ModelAndViewContainer addAttribute(Object value){};
    public ModelAndViewContainer addAllAttributes(Map<String, ?> attributes){};
    public ModelAndViewContainer removeAttributes(Map<String, ?> attributes){};
    public boolean containsAttribute(String name){};
}