視圖框架：Spring MVC 4.0（2）

在 《springMVC4(7)模型視圖方法源碼綜合分析》 一文中，我們介紹了ModelAndView的用法，它會在控制層方法調用完畢后作為返回值返回，里面封裝好了我們的業務邏輯數據和視圖對象或視圖名 
。下一步，視圖對象往往會對模型進一步渲染，再由視圖解析器進一步解析並向前端發出響應。在下面，我們詳細介紹視圖和視圖解析器的各種分類。 
在View接口中，定義了一個核心方法是：

void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) throws Exception;

它的作用主要是渲染模型數據，整合web資源，並以特定形式響應給客戶，這些形式可以是復雜JSP頁面，也可以是簡單的json、xml字符串。 
針對不同的響應形式，spring為我們設計了不同的View實現類：

針對不同的視圖對象，我們使用不同的視圖解析器來完成實例化工作。我們可以在spring上下文配置多個視圖解析器，並通過order屬性來指定他們之間的解析優先級順序，order 越小，對應的 ViewResolver 將有越高的解析視圖的權利。當一個 ViewResolver 在進行視圖解析后返回的 View 對象是 null 的話就表示該 ViewResolver 不能解析該視圖，這時候就交給優先級更低的進行解析，直到解析工作完成，如果所有視圖解析器都不能完成將解析，則會拋出異常。 
類似於視圖，Spring也為我們提供了眾多的視圖解析器實現類： 

 

Spring MVC 處理流程

重要接口和類介紹

1. View接口

　　視圖基礎接口，它的各種實現類是無狀態的，因此是線程安全的。 該接口定義了兩個方法：　

2. AbstractView抽象類

　　View接口的基礎實現類。我們稍微介紹一下這個抽象類。

　　首先看下這個類的屬性：

　　再看下抽象類中接口方法的實現：

　　getContentType方法直接返回contentType屬性即可。

 　　render方法：

3. AbstractUrlBasedView抽象類

　　繼承自AbstractView抽象類，增加了1個類型為String的url參數。

4. InternalResourceView類

　　繼承自AbstractUrlBasedView抽象類的類，表示JSP視圖。

　　我們看下這個類的renderMergedOutputModel方法(AbstractView抽象類定義的抽象方法，為View接口提供的render方法服務)。

5. JstlView類

　　JSTL視圖，繼承自InternalResourceView，該類大致上與InternalResourceView類一致。

6. AbstractTemplateView抽象類

　　繼承自AbstractUrlBasedView抽象類，重寫了renderMergedOutputModel方法，在該方法中會調用renderMergedTemplateModel方法，renderMergedTemplateModel方法為新定義的抽象方法。

　　該抽象類有幾個boolean屬性exposeSessionAttributes，exposeRequestAttributes。 設置為true的話會將request和session中的鍵值和值丟入到renderMergedTemplateModel方法中的model這個Map參數中。

　　這個類是某些模板引擎視圖類的父類。 比如FreemarkerView，VelocityView。

7. FreeMarkerView類

　　繼承自AbstractTemplateView抽象類。

　　直接看renderMergedTemplateModel方法，renderMergedTemplateModel內部會調用doRender方法：

8. RedirectView類

　　繼承自AbstractUrlBasedView，並實現SmartView接口。SmartView接口定義了1個boolean isRedirectView();方法。

　　該視圖的renderMergedOutputModel方法主要就是通過response.sendRedirect進行重定向。

　　有關RedirectView方面的知識樓主另外寫了1篇博客。http://www.cnblogs.com/fangjian0423/p/springMVC-redirectView-analysis.html

9. ViewResolver接口

　　視圖解釋器，用來解析視圖View，與View接口配合使用。

　　該接口只有1個方法，通過視圖名稱viewName和Locale對象得到View接口實現類：

 View resolveViewName(String viewName, Locale locale) throws Exception;

10. AbstractCachingViewResolver抽象類

　　帶有緩存功能的ViewResolver接口基礎實現抽象類，該類有個屬性名為viewAccessCache的以 "viewName_locale" 為key， View接口為value的Map。

　　該抽象類實現的resolveViewName方法內部會調用createView方法，方法內部會調用loadView抽象方法。

11. UrlBasedViewResolver類

　　繼承自AbstractCachingViewResolver抽象類、並實現Ordered接口的類，是ViewResolver接口簡單的實現類。

　　該類復寫了createView方法：

　　父類(AbstractCachingViewResolver)的createView方法內部會調用loadView抽象方法，UrlBasedViewResolver實現了這個抽象方法：

　　下面對UrlBasedViewResolver做1個test，配置如下：

<bean class="org.springframework.web.servlet.view.UrlBasedViewResolver"> <property name="prefix" value="/WEB-INF/view/"/> <property name="suffix" value=".jsp"/> <property name="viewClass" value="org.springframework.web.servlet.view.InternalResourceView"/> <property name="viewNames"> <array> <value type="java.lang.String">*</value> </array> </property> <property name="contentType" value="text/html;charset=utf-8"/> <property name="attributesMap"> <map> <entry key="mytest" value="mytestvalue"/> </map> </property> <property name="attributes"> <props> <prop key="test">testvalue</prop> </props> </property> </bean> 

　　我們看到：以InternalResourceView這個JSP視圖作為視圖；viewNames我們設置了*，這里的*代表全部視圖名(這個viewNames屬性不設置也可以，代表全部視圖名都處理)；http響應頭部contentType信息：text/html;charset=utf-8；attributesMap和attributes傳入的Map和Properties參數都會被丟入到staticAttributes屬性中，這個staticAttributes會被設置成AbstractView的staticAttributes屬性，也就是request域中的參數。

 

 

　　我們看到request域中沒有設置mytest和testvalue值。但是頁面中會顯示，因為我們配置了attributesMap和attributes參數。

　　如果我們把viewNames中的"*"改成"index1"。那么就報錯了，因為處理視圖名的時候index匹配不上index1。

12. InternalResourceViewResolver類

　　繼承自UrlBasedViewResolver，以InternalResourceView作為視圖，若項目中存在“javax.servlet.jsp.jstl.core.Config”該類，那么會以JstlView作為視圖。重寫了buildView方法，主要就是為了給InternalResourceView視圖設置屬性。

13. AbstractTemplateViewResolver類

　　繼承自UrlBasedViewResolver，重寫了buildView方法，主要就是構造AbstractTemplateView以及為它設置相應的屬性。

14. FreeMarkerViewResolver類

　　繼承自AbstractTemplateViewResolver，將視圖設置為FreeMarkerView。

15. ModelAndView對象

　　顧名思義，帶有視圖和Model屬性的一個模型和視圖類。

　　值得注意的是，這個視圖屬性是一個Object類型的數據，可以直接是View接口的實現類或者視圖名(字符串)。

 

源碼分析

下面我們來分析SpringMVC處理視圖的源碼。

SpringMVC在處理請求的時候，通過RequestMappingHandlerMapping得到HandlerExecutionChain，然后通過RequestMappingHandlerAdapter得到1個ModelAndView對象，之后通過processDispatchResult方法處理。

processDispatchResult方法如下：

如果配置的ViewResolver如下：

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/view/"/> <property name="suffix" value=".jsp"/> </bean> 

那么就是使用InternalResourceViewResolver來解析視圖。

之前分析過，InternalResourceViewResolver重寫了UrlBasedViewResolver的buildView方法。但是還是會調用UrlBasedViewResolver的buildView方法。

最終得到InternalResourceView或JstlView視圖。這兩個視圖的render方法本文介紹重要接口及類的時候已分析。

 

PS：DispathcerServlet中的viewResolvers屬性是個集合，如果存在多個ViewResolver對象，必定會有優先級的問題，這部分的內容請參考樓主的另一篇博客：

http://www.cnblogs.com/fangjian0423/p/spring-Ordered-interface.html

編碼自定義的ViewResolver

下面，我們就來編寫自定義的ViewResolver。

自定義的ViewResolver處理視圖名的時候，遇到 "jsp:" 開頭的會找jsp頁面，遇到 "freemarker:" 開頭的找freemarker頁面。

public class CustomViewResolver extends UrlBasedViewResolver { public static final String JSP_URL_PREFIX = "jsp:"; public static final String FTL_URL_PREFIX = "freemarker:"; private static final boolean jstlPresent = ClassUtils.isPresent( "javax.servlet.jsp.jstl.core.Config", CustomViewResolver.class.getClassLoader()); private Boolean exposePathVariables = false; private boolean exposeRequestAttributes = false; private boolean allowRequestOverride = false; private boolean exposeSessionAttributes = false; private boolean allowSessionOverride = false; private boolean exposeSpringMacroHelpers = true; public CustomViewResolver() { this.setViewClass(FreeMarkerView.class); } @Override protected AbstractUrlBasedView buildView(String viewName) throws Exception { if(viewName.startsWith(FTL_URL_PREFIX)) { return buildFreemarkerView(viewName.substring(FTL_URL_PREFIX.length())); } else if(viewName.startsWith(JSP_URL_PREFIX)) { Class viewCls = jstlPresent ? JstlView.class : InternalResourceView.class; return buildView(viewCls, viewName.substring(JSP_URL_PREFIX.length()), getPrefix(), ".jsp"); } else { //默認以freemarker處理 return buildFreemarkerView(viewName); } } private AbstractUrlBasedView build(Class viewClass, String viewName, String prefix, String suffix) { AbstractUrlBasedView view = (AbstractUrlBasedView) BeanUtils.instantiateClass(viewClass); view.setUrl(prefix + viewName + suffix); String contentType = getContentType(); if (contentType != null) { view.setContentType(contentType); } view.setRequestContextAttribute(getRequestContextAttribute()); view.setAttributesMap(getAttributesMap()); if (this.exposePathVariables != null) { view.setExposePathVariables(exposePathVariables); } return view; } private AbstractUrlBasedView buildFreemarkerView(String viewName) throws Exception { AbstractTemplateView view = (AbstractTemplateView) build(FreeMarkerView.class, viewName, "", getSuffix()); view.setExposeRequestAttributes(this.exposeRequestAttributes); view.setAllowRequestOverride(this.allowRequestOverride); view.setExposeSessionAttributes(this.exposeSessionAttributes); view.setAllowSessionOverride(this.allowSessionOverride); view.setExposeSpringMacroHelpers(this.exposeSpringMacroHelpers); return view; } //get set方法省略 } 

xml配置：

<bean class="org.format.demo.support.viewResolver.CustomViewResolver"> <property name="prefix" value="/WEB-INF/view/"/> <property name="suffix" value=".ftl"/> <property name="contentType" value="text/html;charset=utf-8"/> <property name="exposeRequestAttributes" value="true"/> <property name="exposeSessionAttributes" value="true"/> <property name="exposeSpringMacroHelpers" value="true"/> <property name="requestContextAttribute" value="request"/> </bean> 

<bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer"> <property name="templateLoaderPath" value="/WEB-INF/view/"/> <property name="defaultEncoding" value="utf-8"/> <property name="freemarkerSettings"> <props> <prop key="template_update_delay">10</prop> <prop key="locale">zh_CN</prop> <prop key="datetime_format">yyyy-MM-dd</prop> <prop key="date_format">yyyy-MM-dd</prop> <prop key="number_format">#.##</prop> </props> </property> </bean> 

簡單解釋一下：CustomViewResolver解析視圖名的時候，判斷 "jsp:" 和 "freemarker:" 開頭的名字，如果是 "jsp:" 開頭的，如果有JSTL依賴，構造JSTLView視圖，否則構造InternalResourceView視圖。如果是 "freemarker:" 構造FreemarkerView。在構造視圖之前分別會設置一些屬性。

xml配置：配置prefix是為了給jsp視圖用的，freemarker視圖不需要prefix，因為FreemarkerView內部會使用配置的FreeMarkerConfigurer，並用FreeMarkerConfigurer內部的templateLoaderPath屬性作為前綴，配置的suffix是為了讓FreemarkerView使用，當后綴。

最后附上Controller代碼：

@Controller @RequestMapping(value = "/tvrc") public class TestViewResolverController { @RequestMapping("jsp") public ModelAndView jsp(ModelAndView view) { view.setViewName("jsp:trvc/index"); return view; } @RequestMapping("/ftl") public ModelAndView freemarker(ModelAndView view) { view.setViewName("freemarker:trvc/index"); return view; } }

視圖 /WEB-INF/view/trvc/index.jsp 中的的內容是輸出<h2>This is jsp page</h2>

視圖 /WEB-INF/view/trvc/index.ftl 中的的內容是輸出<h2>This is freemarker page</h2>

總結

本文分析了SpringMVC中的視圖機制，View和ViewResolver這兩個接口是視圖機制的核心，並分析了幾個重要的View和ViewResolver接口實現類，最終寫了一個區別jsp和freemarker視圖的ViewResolver實現類，讓讀者更加理解視圖機制。