程序博客网 > 云计算ppt模板下载

Spring mvc 视图解析器 ContentNegotiatingViewResolver 源码分析

来源：互联网 发布：云计算ppt模板下载 编辑：程序博客网 时间：2024/04/29 07:50

参考文章：http://blog.csdn.NET/z69183787/article/details/41658489

http://blog.csdn.Net/z69183787/article/details/41693015

http://blog.csdn.net/z69183787/article/details/41693035

http://blog.csdn.net/z69183787/article/details/41654603

参考了上面几篇文章后，发现还不是了解的很透彻，比如defaultViews、contentType与匹配规则的关系、视图匹配原则，InternalResourceViewResolver为何无法匹配等等，之后将spring-webmvc的Java代码本地编译，并设了断点后一步步调试，才终于搞明白。

附上关键xml配置：

message-converter配置：

[html] view plain copy
print?在CODE上查看代码片派生到我的代码片
  1. <mvc:annotation-driven content-negotiation-manager="cnManager">  
  2.         <mvc:message-converters register-defaults="false">  
  3.             <bean class="org.springframework.http.converter.StringHttpMessageConverter"/>  
  4.             <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter"/>  
  5.             <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">  
  6.                 <!--<property name="supportedMediaTypes">-->  
  7.                     <!--<list>-->  
  8.                         <!--<value>text/html;charset=UTF-8</value>-->  
  9.                         <!--<value>application/json;charset=UTF-8</value>-->  
  10.                         <!--<value>application/javascript;charset=UTF-8</value>-->  
  11.                         <!--<value>text/plain;charset=UTF-8</value>-->  
  12.                     <!--</list>-->  
  13.                 <!--</property>-->  
  14.                 <property name="prettyPrint" value="true"></property>  
  15.                 <property name="objectMapper">  
  16.                     <bean class="com.fasterxml.jackson.databind.ObjectMapper">  
  17.                         <property name="dateFormat">  
  18.                             <bean class="java.text.SimpleDateFormat">  
  19.                                 <constructor-arg type="java.lang.String" value="yyyy-MM-dd HH:mm:ss" />  
  20.                             </bean>  
  21.                         </property>  
  22.                     </bean>  
  23.                 </property>  
  24.             </bean>  
  25.             <bean class="org.springframework.http.converter.xml.MarshallingHttpMessageConverter">  
  26.                 <property name="marshaller" ref="jaxb2Marshaller"></property>  
  27.             </bean>  
  28.         </mvc:message-converters>  
  29.     </mvc:annotation-driven>  

[html] view plain copy
print?在CODE上查看代码片派生到我的代码片
  1. <bean id="cnManager" class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">  
  2.         <property name="ignoreAcceptHeader" value="true"/>  
  3.         <property name="favorPathExtension" value="true"/>  
  4.         <property name="defaultContentType" value="text/html"/>  
  5.         <property name="favorParameter" value="true"/>  
  6.         <property name="mediaTypes">  
  7.             <map>  
  8.                 <entry key="xml" value="application/xml"/>  
  9.                 <entry key="json" value="text/plain"/>  
  10.                 <entry key="xls" value="application/vnd.ms-excel"/>  
  11.             </map>  
  12.         </property>  
  13.     </bean>  

[html] view plain copy
print?在CODE上查看代码片派生到我的代码片
  1. <bean id="viewResolver"  
  2.           class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">  
  3.         <property name="contentNegotiationManager" ref="cnManager"/>  
  4.         <property name="viewResolvers"><!-- 针对freemarker的视图配置 -->   
  5.             <list>  
  6.                 <bean class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">  
  7.                     <property name="viewClass" value="org.springframework.web.servlet.view.freemarker.FreeMarkerView"/>  
  8.                     <property name="viewNames" value=".ftl"/>  
  9.                     <property name="contentType" value="text/html; charset=utf-8"/>  
  10.                     <property name="cache" value="true" />  
  11.                     <property name="prefix" value="" />  
  12.                     <property name="suffix" value="" />  
  13.                     <property name="order" value="2"/>  
  14.                 </bean>  
  15.                 <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">  
  16.                     <property name="prefix" value="/WEB-INF/view/jsp/"></property><!-- 配置页面路径 -->  
  17.                     <property name="suffix" value=".jsp"></property><!-- 文件以value值结尾 -->  
  18.                 </bean>  
  19.             </list>  
  20.         </property>  
  21.         <property name="defaultViews">  
  22.             <list>  
  23.                 <bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView">  
  24.                     <!-- <property name="extractValueFromSingleKeyModel" value="true"/> -->  
  25.                     <property name="prettyPrint" value="true"/>  
  26.                     <property name="contentType" value="text/plain"/>  
  27.                 </bean>  
  28.                 <bean class="org.springframework.web.servlet.view.xml.MarshallingView">  
  29.                     <constructor-arg ref="jaxb2Marshaller">  
  30.   
  31.                     </constructor-arg>  
  32.                 </bean>  
  33.                 <bean class="com.wonders.stpt.bid.controller.JXLExcelView"/>  
  34.             </list>  
  35.         </property>  
  36.     </bean>  


步骤概要：

方法resolveViewName中根据方法getMediaTypes获取mediaType（由accept-header、请求参数或后缀名中获取，springmvc每个view的默认contenttype为text/html），根据访问的viewname与mediaType查找候选视图集合candidateViews，再根据方法getBestView获取最优视图并返回。

其中，ContentNegotiatingViewResolver 中包含2个属性：

ContentNegotiationManagerFactoryBean（XML中viewResolver）：使用ContentNegotiationStrateg解析策略构造ContentNegotiationManager（afterPropertiesSet方法中初始化）

ContentNegotiationManager（XML中cnManager）：包含List<ContentNegotiationStrategy> contentNegotiationStrategies属性记录匹配请求的解析策略，可能涉及的解析策略如下

1、org.springframework.web.accept.ServletPathExtensionContentNegotiationStrategy

后缀名，例：请求为 aaa.json

2、org.springframework.web.accept.ParameterContentNegotiationStrategy

参数，默认参数名称为format，例：请求为format=json

3、org.springframework.web.accept.HeaderContentNegotiationStrategy

通过accept-header匹配 content-type

4、org.springframework.web.accept.FixedContentNegotiationStrategy

通过设定defaultContentType content-type

[html] view plain copy
print?在CODE上查看代码片派生到我的代码片
  1. <span style="font-size:12px;"> <property name="ignoreAcceptHeader" value="true"/>  
  2.         <property name="favorPathExtension" value="true"/>  
  3.         <property name="defaultContentType" value="text/html"/>  
  4.         <property name="favorParameter" value="true"/>  
  5.         <property name="mediaTypes">  
  6.             <map>  
  7.                 <entry key="xml" value="application/xml"/>  
  8.                 <entry key="json" value="text/plain"/>  
  9.                 <entry key="xls" value="application/vnd.ms-excel"/>  
  10.             </map>  
  11.         </property></span>  
favorPathExtension表示支持后缀匹配，favorParameter表示支持参数匹配，属性ignoreAcceptHeader默认为fasle，表示accept-header匹配，defaultContentType开启默认匹配。

其中cnManager中的mediaTypes预设key对应后缀名及参数format的值， 与匹配策略1、2相关。

例如：请求aaa.xx，若设置<entry key="xx" value="application/xml"/> 也能匹配以xml返回。

根据以上条件进行一一匹配最终，得到相关并符合的策略初始化ContentNegotiationManager



1、getMediaTypes方法使用ContentNegotiationManager的resolveMediaTypes方法（使用上述匹配策略）得到需要的contenttype类型例：请求aaa.xx，若设置<entry key="xx" value="application/xml"/> ，返回application/xml的MediaType


2、getCandidateViews方法根据XML中预设的viewResolvers匹配1中的MediaType获取候选View，同时增加XML中defaultViews中的view。每个view都有对应的content-type，大部分的视图继承于AbstractView，默认值都是text/html;charset=ISO-8859-1。有些特定视图，比如MappingJackson2JsonView会重设contentType为application/json。每个view中的contentType在最后匹配中都会实际用到，所以很重要。

在此方法中，会调用每一个viewResolvers的resolveViewName方法创建view，需要传入的参数为viewname与locale，创建过程中，

会先从cache中查看是否已经匹配过，若存在，直接返回view；若不存在，继续创建view。

第一步：检测viewResolvers中的viewNames属性，<property name="viewNames" value=".ftl"/>（支持正则表达式 如*.ftl,），

表达式：return (viewNames == null || PatternMatchUtils.simpleMatch(viewNames, viewName));

若未设置viewNames属性，则默认为null，允许创建，进入第二步；若设置，会根据viewNames进行正则表达式的匹配，若匹配继续第二步，若不匹配，返回null view，跳出此viewResolver；继续与下一个viewresolvers进行匹配并获得view。

第二步：进行每个viewResolve都有的view的创建过程（初始化content-type,记录最终跳转页面prefix，postfix等），但诸如Freemarker，velocity 的 viewResolvers都会在view创建过程中的最后一步调用重写checkResource方法，查看最终跳转的ftl或vm文件是否存在？若不存在，则将创建的视图View重设成null并返回，故无法匹配并加入候选视图。

而InternalResourceView的checkResource没有重写，调用父类AbstractUrlBasedView的checkResource，默认返回true，为所有请求创建view，无论是否有最终文件。所以，InternalResourceView一般都作为springmvc最后的视图解析器，来处理一切请求。

[java] view plain copy
print?在CODE上查看代码片派生到我的代码片
  1. private List<View> getCandidateViews(String viewName, Locale locale, List<MediaType> requestedMediaTypes)  
  2.             throws Exception {  
  3.   
  4.         List<View> candidateViews = new ArrayList<View>();  
  5.         for (ViewResolver viewResolver : this.viewResolvers) {  
  6.             View view = viewResolver.resolveViewName(viewName, locale);  
  7.             if (view != null) {  
  8.                 candidateViews.add(view);  
  9.             }  
  10.             for (MediaType requestedMediaType : requestedMediaTypes) {  
  11.                 List<String> extensions = this.contentNegotiationManager.resolveFileExtensions(requestedMediaType);  
  12.                 for (String extension : extensions) {  
  13.                     String viewNameWithExtension = viewName + "." + extension;  
  14.                     view = viewResolver.resolveViewName(viewNameWithExtension, locale);  
  15.                     if (view != null) {  
  16.                         candidateViews.add(view);  
  17.                     }  
  18.                 }  
  19.             }  
  20.         }  
  21.         if (!CollectionUtils.isEmpty(this.defaultViews)) {  
  22.             candidateViews.addAll(this.defaultViews);  
  23.         }  
  24.         return candidateViews;  
  25.     }  


3、getBestView方法获取最符合条件的匹配视图

首先，如果是smartView，即redirectView则return

否则：筛选getMediaTypes返回的content-type类型，与candidateViews中的候选视图匹配，其中：

下面的contentType重写了MappingJackson2JsonView的contentType，用于匹配cnManager中的mediaTypes，若该视图可以解析此contenttype，则返回

例子：若访问localhost/xxx/a.json，匹配策略为后缀匹配（favorExtension开启），由于后缀为json，则匹配cnManager中的text/plain筛选view后发现匹配视图为MappingJackson2JsonView，返回json格式的数据；若访问localhost/xxx/a,由于无后缀及参数匹配，则匹配策略为accept-header匹配，由于content-type为text/html，则匹配InternalResourceView中的视图，返回jsp页面。

你可能注意到，上述viewResolvers中配置了两个视图，为什么匹配InternalResourceView,而不是freeMarker？这是因为进入候选试图的只有InternalResourceView视图解析器，具体原因参见getCandidateViews。


[html] view plain copy
print?在CODE上查看代码片派生到我的代码片
  1. <bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView">  
  2.                     <!-- <property name="extractValueFromSingleKeyModel" value="true"/> -->  
  3.                     <property name="prettyPrint" value="true"/>  
  4.                     <property name="contentType" value="text/plain"/>  
  5.                 </bean>  


[java] view plain copy
print?在CODE上查看代码片派生到我的代码片
  1. private View getBestView(List<View> candidateViews, List<MediaType> requestedMediaTypes, RequestAttributes attrs) {  
  2.         for (View candidateView : candidateViews) {  
  3.             if (candidateView instanceof SmartView) {  
  4.                 SmartView smartView = (SmartView) candidateView;  
  5.                 if (smartView.isRedirectView()) {  
  6.                     if (logger.isDebugEnabled()) {  
  7.                         logger.debug("Returning redirect view [" + candidateView + "]");  
  8.                     }  
  9.                     return candidateView;  
  10.                 }  
  11.             }  
  12.         }  
  13.         for (MediaType mediaType : requestedMediaTypes) {  
  14.             for (View candidateView : candidateViews) {  
  15.                 if (StringUtils.hasText(candidateView.getContentType())) {  
  16.                     MediaType candidateContentType = MediaType.parseMediaType(candidateView.getContentType());  
  17.                     if (mediaType.isCompatibleWith(candidateContentType)) {  
  18.                         if (logger.isDebugEnabled()) {  
  19.                             logger.debug("Returning [" + candidateView + "] based on requested media type '"  
  20.                                     + mediaType + "'");  
  21.                         }  
  22.                         attrs.setAttribute(View.SELECTED_CONTENT_TYPE, mediaType, RequestAttributes.SCOPE_REQUEST);  
  23.                         return candidateView;  
  24.                     }  
  25.                 }  
  26.             }  
  27.         }  
  28.         return null;  
  29.     }  
0 0
云计算ppt模板下载 云计算ppt模板下载
原创粉丝点击
热门IT博客
行者步行软件行者步行软件
基本款 知乎基本款 知乎
怎样做网络销售
超声波软件
linux驱动招聘
mac os 11 vmware镜像
淘宝账号怎么多个账号
网络关键词排名
通达信软件使用说明
java template
lgd官方淘宝店
千千静听 mac 5.0
淘宝如何秒杀成功
linux c 删除非空目录
水利软件
php连接mysql实例
mac 无法连接app store
射频用什么软件
mac os x 懒人版
网络推广员面试问什么
热门问题 老师的惩罚 人脸识别 我在镇武司摸鱼那些年 重生之率土为王 我在大康的咸鱼生活 盘龙之生命进化 天生仙种 凡人之先天五行 春回大明朝 姑娘不必设防，我是瞎子 渭城曲古诗 渭城区 咸阳渭城区邮编 苏州渭塘二手房 渭塘招聘信息 苏州渭塘 滦州 长安大学渭水校区宾馆 长生君 春风渭水 长安大学渭水吧 渭水之南 长安大学渭水校区附近的酒店 渭水自萦秦塞曲 渭水剑炉 渭水茗居 陕西渭河发电有限公司 渭河公园 渭河平原形成原因 渭河玉石种类图片 在河之洲渭七 饮于河渭的河的意思 渭滨区 宝鸡渭滨区邮编 宝鸡市渭滨区邮编 渮泽 营口港丰大酒店 营口港丰酒店 港丰 港丽餐厅 港丽岛报价 杭州港丽医疗美容 港丽岛攻略 香港港丽酒店 马尔代夫港丽岛怎么样 梧州丽港酒店 港丽酒店 丽港酒店 港丽 港式车仔面 港仔文艺男 港式鸡蛋仔

程序博客网，程序员的互联网技术博客家园。csdn论坛精品 msdn技术资料都在这里