摘要：例如，服務(wù)端不支持這種，應(yīng)該返回。而當(dāng)使用或者其他等價(jià)方式進(jìn)行配置時(shí)，會(huì)把添加在最前面，優(yōu)先級(jí)最高。好了，到此就基本上說完了整個(gè)的匹配規(guī)則或者叫選擇過程。自己能力不是最大，卻大包大攬承擔(dān)最大責(zé)任，處理不了還返回，是甩鍋客戶端的行為。
以下內(nèi)容，如有問題，煩請(qǐng)指出，謝謝！
SpringMVC啟動(dòng)時(shí)會(huì)自動(dòng)配置一些HttpMessageConverter，接收到http請(qǐng)求時(shí)，從這些Converters中選擇一個(gè)符合條件的來進(jìn)行Http序列化/反序列化。在不覆蓋默認(rèn)的HttpMessageConverters的情況下，我們添加的Converter可能會(huì)與默認(rèn)的產(chǎn)生沖突，在某些場景中出現(xiàn)不符合預(yù)期的情況。
在上一篇文章的末尾已經(jīng)列舉了一個(gè)jsonConverter沖突的情況：添加一個(gè)最低優(yōu)先級(jí)的FastJsonConverter后會(huì)有兩個(gè)（實(shí)際上三個(gè)，有兩個(gè)jackson的）jsonConverter，直接使用瀏覽器訪問接口時(shí)使用的卻是低優(yōu)先級(jí)的FastJsonConverter來進(jìn)行序列化操作。
為了解決converters之間的沖突，或者直接叫優(yōu)先級(jí)問題，需要弄懂SpringMVC是如何選擇一個(gè)HttpMessageMessagerConverter來進(jìn)行Http序列化/反序列化的。這篇文章主要就根據(jù)相關(guān)的代碼來講解SpringMVC的這個(gè)內(nèi)部流程，這塊的邏輯比較清晰，貼貼代碼就基本上都明白了。
首先需要了解一些HTTP的基本知識(shí)（不是強(qiáng)制的而是一種建議與約定）：
1、決定resp.body的Content-Type的第一要素是對(duì)應(yīng)的req.headers.Accept屬性的值，又叫做MediaType。如果服務(wù)端支持這個(gè)Accept，那么應(yīng)該按照這個(gè)Accept來確定返回resp.body對(duì)應(yīng)的格式，同時(shí)把resp.headers.Content-Type設(shè)置成自己支持的符合那個(gè)Accept的MediaType。服務(wù)端不支持Accept指定的任何MediaType時(shí)，應(yīng)該返回錯(cuò)誤406 Not Acceptable .406 Not Acceptable 。
2、如果Accept指定了多個(gè)MediaType，并且服務(wù)端也支持多個(gè)MediaType，那么Accept應(yīng)該同時(shí)指定各個(gè)MediaType的QualityValue ，也就是q值，服務(wù)端根據(jù)q值的大小來決定這幾個(gè)MediaType類型的優(yōu)先級(jí)，一般是大的優(yōu)先。q值不指定時(shí)，默認(rèn)視為q=1.
3、一個(gè)HTTP請(qǐng)求沒有指定Accept，默認(rèn)視為指定 Accept: */*；沒有指定Content-Type，默認(rèn)視為 null，就是沒有。當(dāng)然，服務(wù)端可以根據(jù)自己的需要改變默認(rèn)值。
4、Content-Type必須是具體確定的類型，不能包含 *.
SpringMvc基本遵循上面這幾點(diǎn)。
然后是啟動(dòng)時(shí)默認(rèn)加載的Converter。在mvc啟動(dòng)時(shí)默認(rèn)會(huì)加載下面的幾種HttpMessageConverter，相關(guān)代碼在 org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport中的addDefaultHttpMessageConverters 方法中，代碼如下。
protected final void addDefaultHttpMessageConverters(List> messageConverters) {
StringHttpMessageConverter stringConverter = new StringHttpMessageConverter();
stringConverter.setWriteAcceptCharset(false);
messageConverters.add(new ByteArrayHttpMessageConverter());
messageConverters.add(stringConverter);
messageConverters.add(new ResourceHttpMessageConverter());
messageConverters.add(new SourceHttpMessageConverter());
messageConverters.add(new AllEncompassingFormHttpMessageConverter());
if (romePresent) {
messageConverters.add(new AtomFeedHttpMessageConverter());
messageConverters.add(new RssChannelHttpMessageConverter());
}
if (jackson2XmlPresent) {
messageConverters.add(new MappingJackson2XmlHttpMessageConverter(
Jackson2ObjectMapperBuilder.xml().applicationContext(this.applicationContext).build()));
}
else if (jaxb2Present) {
messageConverters.add(new Jaxb2RootElementHttpMessageConverter());
}
if (jackson2Present) {
messageConverters.add(new MappingJackson2HttpMessageConverter(
Jackson2ObjectMapperBuilder.json().applicationContext(this.applicationContext).build()));
}
else if (gsonPresent) {
messageConverters.add(new GsonHttpMessageConverter());
}
}
這段代碼后面還有兩個(gè)別的處理，一次是將Jaxb放在list最后面，第二次是將一個(gè)StringConverter和一個(gè)JacksonConverter添加到list中，所以打印出converter信息中這兩個(gè)有重復(fù)的（第二次的那兩個(gè)來自springboot-autoconfigure.web，重復(fù)了不影響后面的流程）。
接著我們?cè)谧约旱腗VC配置類覆蓋extendMessageConverters方法，使用converter.add(xxx)加上上次自定義Java序列化的那個(gè)的和FastJson的（把自己添加的放在優(yōu)先級(jí)低的位置）。最后的converters按順序展示如下（下面的已經(jīng)去掉重復(fù)的StringHttpMessageConverter和MappingJackson2HttpMessageConverter，后續(xù)的相應(yīng)MediaType也去重）
類名
支持的JavaType
支持的MediaType
ByteArrayHttpMessageConverter
byte[]
application/octet-stream, */*
StringHttpMessageConverter
String
text/plain, */*
ResourceHttpMessageConverter
Resource
*/*
SourceHttpMessageConverter
Source
application/xml, text/xml, application/*+xml
AllEncompassingFormHttpMessageConverter
Map>
application/x-www-form-urlencoded, multipart/form-data
MappingJackson2HttpMessageConverter
Object
application/json, application/*+json
Jaxb2RootElementHttpMessageConverter
Object
application/xml, text/xml, application/*+xml
JavaSerializationConverter
Serializable
x-java-serialization;charset=UTF-8
FastJsonHttpMessageConverter
Object
*/*
這里只列出重要的兩個(gè)屬性，詳細(xì)的可以去看org.springframework.http.converter 包中的代碼。
好了，開始說converter的選擇邏輯。主要的代碼在org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodProcessor 這個(gè)類以及它的父類中，這里根據(jù)我個(gè)人的理解簡明地說一下。
先說下寫操作的流程，也就是Http序列化。基本都集中在 writeWithMessageConverters 這個(gè)方法中。我們先以Accept = default(*/*)請(qǐng)求 http://localhost:8080/users/1 為例。
HttpServletRequest request = inputMessage.getServletRequest();
List requestedMediaTypes = getAcceptableMediaTypes(request);
List producibleMediaTypes = getProducibleMediaTypes(request, valueType, declaredType);
if (outputValue != null && producibleMediaTypes.isEmpty()) {
throw new IllegalArgumentException("No converter found for return value of type: " + valueType);
}
getAcceptableMediaTypes
getProducibleMediaTypes
第二步，把Accpet指定的MediaType具體化，意思就是req可以指定 * 這種通配符，但是服務(wù)端不應(yīng)該返回帶 * 的Content-Type，代碼如下：
Set compatibleMediaTypes = new LinkedHashSet();
for (MediaType requestedType : requestedMediaTypes) {
for (MediaType producibleType : producibleMediaTypes) {
if (requestedType.isCompatibleWith(producibleType)) {
compatibleMediaTypes.add(getMostSpecificMediaType(requestedType, producibleType));
}
}
}
if (compatibleMediaTypes.isEmpty()) {
if (outputValue != null) {
throw new HttpMediaTypeNotAcceptableException(producibleMediaTypes);
}
return;
}
List mediaTypes = new ArrayList(compatibleMediaTypes);
MediaType.sortBySpecificityAndQuality(mediaTypes);
MediaType selectedMediaType = null;
for (MediaType mediaType : mediaTypes) {
if (mediaType.isConcrete()) {
selectedMediaType = mediaType;
break;
}
else if (mediaType.equals(MediaType.ALL) || mediaType.equals(MEDIA_TYPE_APPLICATION)) {
selectedMediaType = MediaType.APPLICATION_OCTET_STREAM;
break;
}
}
第一個(gè)for循環(huán)，尋找出更具體的MediaType，isCompatibleWith 方法判斷是否兼容，getMostSpecificMediaType 方法取二者中更具體的那個(gè)。具體的判斷邏輯在MediaType類中，這里就不細(xì)說了，可以把更具體理解為找出 requestedMediaType 有 instanceof 關(guān)系的 producibleMediaType。因?yàn)?*/* 類似于 Object 所以這里一個(gè)都篩不掉，compatibleMediaTypes最后還是那四個(gè)MediaType。
后兩行代碼是排序，按照 q值 和 具體程度 來排序。因?yàn)槲覀儧]有指定q值，所以都是q=1。根據(jù)具體程度排序，帶 * 的會(huì)排到后面。注意那個(gè)LinkedHashSet ，先來的會(huì)排在前面，加上前面的都是list迭代，所以最后的順序?yàn)閇application/json, application/x-java-serialization;charset=UTF-8, application/*+json, */*]。
第二個(gè)是默認(rèn)值處理，application/json 是一個(gè)具體的類型，不用再處理，所以最后的produce = application/json 。
第三步，選擇一個(gè)能處理最后的produce的Converter，Jackson和FastJson都能處理，根據(jù)添加順序 ，此時(shí)選擇的是Jackson，也就是Jackson的優(yōu)先級(jí)更高。
if (selectedMediaType != null) {
selectedMediaType = selectedMediaType.removeQualityValue();
for (HttpMessageConverter messageConverter : this.messageConverters) {
if (messageConverter instanceof GenericHttpMessageConverter) {
if (((GenericHttpMessageConverter) messageConverter).canWrite(
declaredType, valueType, selectedMediaType)) {
outputValue = (T) getAdvice().beforeBodyWrite(outputValue, returnType, selectedMediaType,
(Class>) messageConverter.getClass(),
inputMessage, outputMessage);
if (outputValue != null) {
addContentDispositionHeader(inputMessage, outputMessage);
((GenericHttpMessageConverter) messageConverter).write(
outputValue, declaredType, selectedMediaType, outputMessage);
if (logger.isDebugEnabled()) {
logger.debug("Written [" + outputValue + "] as "" + selectedMediaType +
"" using [" + messageConverter + "]");
}
}
return;
}
}
else if (messageConverter.canWrite(valueType, selectedMediaType)) {
outputValue = (T) getAdvice().beforeBodyWrite(outputValue, returnType, selectedMediaType,
(Class>) messageConverter.getClass(),
inputMessage, outputMessage);
if (outputValue != null) {
addContentDispositionHeader(inputMessage, outputMessage);
((HttpMessageConverter) messageConverter).write(outputValue, selectedMediaType, outputMessage);
if (logger.isDebugEnabled()) {
logger.debug("Written [" + outputValue + "] as "" + selectedMediaType +
"" using [" + messageConverter + "]");
}
}
return;
}
}
}
上面的流程解釋了為什么通過在converters末尾添加FastJsonConverter時(shí)，F(xiàn)iddler的默認(rèn)請(qǐng)求（不帶Accept或者Accept: */*），使用的是Jackson序列化，序列化了createTime字段，并且返回的 Content-Type 為application/json。
但是使用瀏覽器直接請(qǐng)求時(shí)，Chrome的默認(rèn)請(qǐng)求的Accept為text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8.
而當(dāng)使用 converters.add(0, fastJsonConverter) （或者其他等價(jià)方式）進(jìn)行配置時(shí)，會(huì)把FastJsonConverter添加在最前面，優(yōu)先級(jí)最高。因?yàn)镕astJsonConverter的MediaType是 */*，所以它會(huì)在前面包攬所有請(qǐng)求的Http序列化和反序列化，就算它們不是json，也說了自己不是json、不要返回json，它還是一意孤行地當(dāng)成json處理。
下面再說下讀取的流程，也就是反序列化流程，主流程在父類的 readWithMessageConverters 方法中，代碼如下：
@SuppressWarnings("unchecked")
protected Object readWithMessageConverters(HttpInputMessage inputMessage, MethodParameter parameter,
Type targetType) throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException {
MediaType contentType;
boolean noContentType = false;
try {
contentType = inputMessage.getHeaders().getContentType();
}
catch (InvalidMediaTypeException ex) {
throw new HttpMediaTypeNotSupportedException(ex.getMessage());
}
if (contentType == null) {
noContentType = true;
contentType = MediaType.APPLICATION_OCTET_STREAM;
}
Class contextClass = (parameter != null ? parameter.getContainingClass() : null);
Class targetClass = (targetType instanceof Class ? (Class) targetType : null);
if (targetClass == null) {
ResolvableType resolvableType = (parameter != null ?
ResolvableType.forMethodParameter(parameter) : ResolvableType.forType(targetType));
targetClass = (Class) resolvableType.resolve();
}
HttpMethod httpMethod = ((HttpRequest) inputMessage).getMethod();
Object body = NO_VALUE;
try {
inputMessage = new EmptyBodyCheckingHttpInputMessage(inputMessage);
for (HttpMessageConverter converter : this.messageConverters) {
Class> converterType = (Class>) converter.getClass();
if (converter instanceof GenericHttpMessageConverter) {
GenericHttpMessageConverter genericConverter = (GenericHttpMessageConverter) converter;
if (genericConverter.canRead(targetType, contextClass, contentType)) {
if (logger.isDebugEnabled()) {
logger.debug("Read [" + targetType + "] as "" + contentType + "" with [" + converter + "]");
}
if (inputMessage.getBody() != null) {
inputMessage = getAdvice().beforeBodyRead(inputMessage, parameter, targetType, converterType);
body = genericConverter.read(targetType, contextClass, inputMessage);
body = getAdvice().afterBodyRead(body, inputMessage, parameter, targetType, converterType);
}
else {
body = getAdvice().handleEmptyBody(null, inputMessage, parameter, targetType, converterType);
}
break;
}
}
else if (targetClass != null) {
if (converter.canRead(targetClass, contentType)) {
if (logger.isDebugEnabled()) {
logger.debug("Read [" + targetType + "] as "" + contentType + "" with [" + converter + "]");
}
if (inputMessage.getBody() != null) {
inputMessage = getAdvice().beforeBodyRead(inputMessage, parameter, targetType, converterType);
body = ((HttpMessageConverter) converter).read(targetClass, inputMessage);
body = getAdvice().afterBodyRead(body, inputMessage, parameter, targetType, converterType);
}
else {
body = getAdvice().handleEmptyBody(null, inputMessage, parameter, targetType, converterType);
}
break;
}
}
}
}
catch (IOException ex) {
throw new HttpMessageNotReadableException("I/O error while reading input message", ex);
}
if (body == NO_VALUE) {
if (httpMethod == null || !SUPPORTED_METHODS.contains(httpMethod) ||
(noContentType && inputMessage.getBody() == null)) {
return null;
}
throw new HttpMediaTypeNotSupportedException(contentType, this.allSupportedMediaTypes);
}
return body;
}
因?yàn)樽x取時(shí)的ContentType必定是一個(gè)具體類型（帶有 * 號(hào)會(huì)拋出異常 java.lang.IllegalArgumentException: "Content-Type" cannot contain wildcard subtype "*"），所以步驟少了一些，匹配前就一個(gè)默認(rèn)值處理。
但是當(dāng)指定Content-Type: application/json 時(shí)，contentType = application/json，Jackson和FastJson都能處理，按照順序，輪到Jackson反序列化，所以就反序列化了createTime字段，打印信息user.toString()中createTime不為null。
改成使用 converters.add(0, fastJsonConverter) （或者其他等價(jià)方式）進(jìn)行配置時(shí)，會(huì)把FastJsonConverter添加在最前面，順序優(yōu)先級(jí)比Jackson高，指定Content-Type: application/json 時(shí)使用的就是FastJson來進(jìn)行反序列化。
好了，到此就基本上說完了整個(gè)HttpMessageConverter的匹配規(guī)則（或者叫選擇過程）。這次沒有新增代碼，也沒有演示，想要自己演示觀察的，可以在上一篇文章相關(guān)的代碼基礎(chǔ)上進(jìn)行，如下：
最后再次吐槽下FastJsonHttpMessageConverter，作為非springmvc自帶的組件，默認(rèn)設(shè)置 */* 這種MediaType，是非常不好的。上面也說了，存在掛羊頭賣狗肉、名實(shí)不副的行為，在REST已經(jīng)重新引起人們對(duì)HTTP原生規(guī)范的重視的今天，這是一個(gè)很不好的做法。自己能力不是最大，卻大包大攬承擔(dān)最大責(zé)任，處理不了還返回 HTTP 400，是甩鍋客戶端的行為。阿里作為國內(nèi)第一大開源陣營，其代碼設(shè)計(jì)、質(zhì)量，以及開源奉獻(xiàn)精神還是要進(jìn)一步提升啊。
自己寫代碼也要注意?。捍a中有順序遍歷匹配這種邏輯，或者叫責(zé)任鏈模式時(shí)，功能越具體的節(jié)點(diǎn)越是應(yīng)該放在前面，功能最廣最泛的節(jié)點(diǎn)應(yīng)該放在最后面；同時(shí)要按功能分配責(zé)任，千萬不要給功能單一的節(jié)點(diǎn)最大的責(zé)任（FastJsonConverter的功能單一，卻默認(rèn)分配了個(gè)最大的責(zé)任 MediaType = */*）。
