資訊專欄INFORMATION COLUMN
摘要：概述本章繼續(xù)學(xué)習(xí)另一個(gè)實(shí)現(xiàn)類解析器，該類的主要作用是根據(jù)同一請(qǐng)求的某些策略，選擇對(duì)應(yīng)的進(jìn)行渲染?？梢园牙斫鉃檫m配器，對(duì)不同類型進(jìn)行適配。值得注意的是處理的為同一個(gè)。本系列文章是基于。實(shí)戰(zhàn)需求目標(biāo)實(shí)現(xiàn)后綴名或參數(shù)控制，顯示不同的視圖。
概述
本章繼續(xù)學(xué)習(xí)ViewResolver另一個(gè)實(shí)現(xiàn)類ContentNegotiatingViewResolver解析器，該類的主要作用是根據(jù)同一請(qǐng)求的某些策略，選擇對(duì)應(yīng)的View進(jìn)行渲染。可以把ContentNegotiatingViewResolver理解為適配器，對(duì)不同類型View進(jìn)行適配。值得注意的是處理的handler為同一個(gè)。
ContentNegotiatingViewResolver本身不解析視圖，它將委托其他視圖解析器進(jìn)行視圖解析。
請(qǐng)求的策略包括：請(qǐng)求后綴、請(qǐng)求頭的Accept、使用參數(shù)等等。
本系列文章是基于Spring5.0.5RELEASE。
流程概述使用此視圖解析器時(shí)，調(diào)用resolverViewName(viewName,locale)方法，首先調(diào)用本類的getMediaType(reuqest)獲取請(qǐng)求的媒體類型mediaType（根據(jù)策略），然后調(diào)用getCandidateViews()方法解析歸并到View集合，最后調(diào)用getBestView()方法，根據(jù)contentType選擇出合適的視圖并返回。
源碼分析ContentNegotiatingViewResolver
該類主要完成
public class ContentNegotiatingViewResolver extends WebApplicationObjectSupport
implements ViewResolver, Ordered, InitializingBean {
// 判斷請(qǐng)求mediaType，內(nèi)部包含使用的策略集合
@Nullable
private ContentNegotiationManager contentNegotiationManager;
// 用于創(chuàng)建ContentNegotiationManager實(shí)例
private final ContentNegotiationManagerFactoryBean cnmFactoryBean = new ContentNegotiationManagerFactoryBean();
// 控制為查找到時(shí)的處理
private boolean useNotAcceptableStatusCode = false;
// 存儲(chǔ)View實(shí)例，可在此集合查詢符合條件的View實(shí)例進(jìn)行視圖渲染
@Nullable
private List defaultViews;
// 視圖解析器集合，用于解析視圖
@Nullable
private List viewResolvers;
// 排序?qū)傩?private int order = Ordered.HIGHEST_PRECEDENCE;
... ...
/**
*啟動(dòng)時(shí)從上下文中加載ViewResolver
*/
@Override
protected void initServletContext(ServletContext servletContext) {
// 從上下文中獲取所有視圖解析器
Collection matchingBeans =
BeanFactoryUtils.beansOfTypeIncludingAncestors(obtainApplicationContext(), ViewResolver.class).values();
if (this.viewResolvers == null) {
// 將上下文配置的視圖解析器添加到屬性viewResolvers中，以供后續(xù)使用
this.viewResolvers = new ArrayList<>(matchingBeans.size());
for (ViewResolver viewResolver : matchingBeans) {
if (this != viewResolver) {
this.viewResolvers.add(viewResolver);
}
}
}
else {
// 初始化viewResolvers屬性中配置的視圖解析器
for (int i = 0; i < this.viewResolvers.size(); i++) {
ViewResolver vr = this.viewResolvers.get(i);
if (matchingBeans.contains(vr)) {
continue;
}
String name = vr.getClass().getName() + i;
obtainApplicationContext().getAutowireCapableBeanFactory().initializeBean(vr, name);
}
}
if (this.viewResolvers.isEmpty()) {
logger.warn("Did not find any ViewResolvers to delegate to; please configure them using the " +
""viewResolvers" property on the ContentNegotiatingViewResolver");
}
// 排序視圖解析器
AnnotationAwareOrderComparator.sort(this.viewResolvers);
this.cnmFactoryBean.setServletContext(servletContext);
}
/*
*啟動(dòng)時(shí)調(diào)用，如果沒有配置ContentNegotiationManager，啟動(dòng)時(shí)進(jìn)行創(chuàng)建初始化該屬性
*/
@Override
public void afterPropertiesSet() {
if (this.contentNegotiationManager == null) {
this.contentNegotiationManager = this.cnmFactoryBean.build();
}
}
/*
*請(qǐng)求到來時(shí)匹配核實(shí)的View并返回
*/
@Override
@Nullable
public View resolveViewName(String viewName, Locale locale) throws Exception {
RequestAttributes attrs = RequestContextHolder.getRequestAttributes();
Assert.state(attrs instanceof ServletRequestAttributes, "No current ServletRequestAttributes");
// 獲取請(qǐng)求的mediaType
List requestedMediaTypes = getMediaTypes(((ServletRequestAttributes) attrs).getRequest());
if (requestedMediaTypes != null) {
// 解析出所有視圖View和配置的默認(rèn)View合并，供后面從中匹配選擇
List candidateViews = getCandidateViews(viewName, locale, requestedMediaTypes);
// 根據(jù)contentType匹配選擇出合適的View
View bestView = getBestView(candidateViews, requestedMediaTypes, attrs);
// 返回
if (bestView != null) {
return bestView;
}
}
// 未匹配到合適的View，并且把參數(shù)useNotAcceptableStatusCode設(shè)置為true時(shí)，返回406
if (this.useNotAcceptableStatusCode) {
if (logger.isDebugEnabled()) {
logger.debug("No acceptable view found; returning 406 (Not Acceptable) status code");
}
return NOT_ACCEPTABLE_VIEW;
}
else {
logger.debug("No acceptable view found; returning null");
return null;
}
... ...
}
以上是ContentNegotiatingViewResolver類的主要代碼，具體調(diào)用的方法再此不再展開，有興趣的童鞋可以自行查看，下面我們來使用這個(gè)解析器做個(gè)例子，通過例子再加深下理解。
實(shí)戰(zhàn)需求目標(biāo)
實(shí)現(xiàn)后綴名或參數(shù)控制，顯示不同的視圖。如：
http://localhost:8088/user jsp視圖顯示
http://localhost:8088/user.json(http://localhost:8088/user?format=json) json視圖顯示
http://localhost:8088/user.xml(http://localhost:8088/user?format=xml) xml視圖顯示
項(xiàng)目結(jié)構(gòu)
新建maven web項(xiàng)目，最終目錄結(jié)構(gòu)如下：
pom文件
通過maven引入jar依賴，代碼如下：
4.0.0 com.github.dalianghe spring-mvc-viewresolver-03 1.0-SNAPSHOT war spring-mvc-viewresolver-03 Maven Webapp http://www.example.com UTF-8 1.8 1.8 org.springframework spring-webmvc 5.0.5.RELEASE javax.servlet javax.servlet-api 3.1.0 provided javax.servlet jstl 1.2 com.fasterxml.jackson.core jackson-core 2.9.5 com.fasterxml.jackson.core jackson-databind 2.9.5 com.fasterxml.jackson.dataformat jackson-dataformat-xml 2.9.5 spring-mvc-viewresolver-03 org.apache.tomcat.maven tomcat7-maven-plugin 2.2 / 8088
spring配置文件
配置視圖解析器等，代碼如下：
