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