## 1. 問題復現 話不多說,先貼出問題代碼:這裡的`GetUserInfoByAccessToken`是我自定義的一個實體類。 ``` GetUserInfoByAccessToken getUserInfoByAccessTokenString = restTemplate.getForObj ...
1. 問題復現
話不多說,先貼出問題代碼:這裡的GetUserInfoByAccessToken
是我自定義的一個實體類。
GetUserInfoByAccessToken getUserInfoByAccessTokenString = restTemplate.getForObject(userInfoByAccessCodeURL, GetUserInfoByAccessToken.class);
異常信息:Could not extract response: no suitable HttpMessageConverter
found for response type [class wechat.wxRes.GetUserInfoByAccessToken] and content type [text/plain],很明顯這段異常的意思是在指定返回類型為GetUserInfoByAccessToken,並且服務端響應報文的content-type為text/plain的情況下找不到一個合適的HttpMessageConverter
來處理這種情況
2. 處理方法
這裡舉例兩種處理請求
1.首先StringHttpMessageConverter
這個處理器是可以處理content-type為text/plain的響應報文的。但閱讀源碼知道必須放回類型是String才可以使用它,所有我們需要改寫下代碼,將放回類型改為String。需要的時候可以利用JSON
工具類將其轉為你需要的類型。
GetUserInfoByAccessToken getUserInfoByAccessTokenString = restTemplate.getForObject(userInfoByAccessCodeURL, String.class);
需要註意的是使用StringHttpMessageConverter
容易出現中文亂碼的情況,因為它預設支持的字元集是ISO-8859-1
,這種時候可以參考以下代碼更改StringHttpMessageConverter
的預設字元集,我這裡將其改為utf-8
了。
RestTemplate customRestTemplate = new RestTemplate();
List<HttpMessageConverter<?>> list = customRestTemplate.getMessageConverters();
for (HttpMessageConverter<?> httpMessageConverter : list) {
if(httpMessageConverter instanceof StringHttpMessageConverter) {
((StringHttpMessageConverter) httpMessageConverter).setDefaultCharset(Charset.forName("utf-8"));
break;
}
}
2.往restTemplate
的轉換器里再加一個支持JSON
轉換的轉換器,比如MappingJackson2HttpMessageConverter
。
RestTemplate customRestTemplate = new RestTemplate();
MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();
mappingJackson2HttpMessageConverter.setSupportedMediaTypes(Arrays.asList(MediaType.TEXT_HTML,MediaType.TEXT_PLAIN));
restTemplate.getMessageConverters().add(mappingJackson2HttpMessageConverter);
GetUserInfoByAccessToken getUserInfoByAccessTokenString = restTemplate.getForObject(userInfoByAccessCodeURL, GetUserInfoByAccessToken.class);
3. 源碼分析問題
3.1 關鍵代碼extractData
方法
extractData
方法將介面請求拿到的響應報文拿來給HttpMessageConverter
解析,這裡會找到合適的解析器來解析響應報文,解析成我們指定的返回類型的數據,如果找不到或者處理出現異常就會拋出異常。
// 這裡的入參是請求之後的響應體
public T extractData(ClientHttpResponse response) throws IOException {
//創建一個名為responseWrapper的MessageBodyClientHttpResponseWrapper,用於包裝響應對象response,方便操作響應數據。
MessageBodyClientHttpResponseWrapper responseWrapper = new MessageBodyClientHttpResponseWrapper(response);
// 檢查響應是否有消息體,並且消息體不為空。如果不滿足條件,則返回null。
if (!responseWrapper.hasMessageBody() || responseWrapper.hasEmptyMessageBody()) {
return null;
}
// 獲取響應內容類型contentType。
MediaType contentType = getContentType(responseWrapper);
try {
// 遍歷已註冊的HttpMessageConverter列表。
for (HttpMessageConverter<?> messageConverter : this.messageConverters) {
// 對於實現了GenericHttpMessageConverter介面的轉換器,檢查是否可以讀取responseType對應的類型,並且內容類型匹配。
if (messageConverter instanceof GenericHttpMessageConverter) {
GenericHttpMessageConverter<?> genericMessageConverter =
(GenericHttpMessageConverter<?>) messageConverter;
if (genericMessageConverter.canRead(this.responseType, null, contentType)) {
if (logger.isDebugEnabled()) {
ResolvableType resolvableType = ResolvableType.forType(this.responseType);
logger.debug("Reading to [" + resolvableType + "]");
}
return (T) genericMessageConverter.read(this.responseType, null, responseWrapper);
}
}
// 如果沒有找到合適的GenericHttpMessageConverter,則檢查是否指定了responseClass。
if (this.responseClass != null) {
// 如果指定了responseClass,則檢查是否有轉換器可以讀取該類型,並且內容類型匹配。見相關代碼`canRead`方法中的代碼清單1-2
if (messageConverter.canRead(this.responseClass, contentType)) {
if (logger.isDebugEnabled()) {
String className = this.responseClass.getName();
logger.debug("Reading to [" + className + "] as \"" + contentType + "\"");
}
// 如果匹配成功,使用該轉換器讀取響應數據,並返回結果。
return (T) messageConverter.read((Class) this.responseClass, responseWrapper);
}
}
}
}
catch (IOException | HttpMessageNotReadableException ex) {
throw new RestClientException("Error while extracting response for type [" +
this.responseType + "] and content type [" + contentType + "]", ex);
}
throw new UnknownContentTypeException(this.responseType, contentType,
response.getRawStatusCode(), response.getStatusText(), response.getHeaders(),
getResponseBody(response));
}
3.2 相關代碼messageConverter.canRead(this.responseClass, contentType)
方法
canRead(java.lang.Class, org.springframework.http.MediaType)
方法判斷當前的HttpMessageConverter
是否可以讀取響應報文ContentType
為服務端指定的數據,並且內容和你指定的返回值類型匹配。
// 判斷`HttpMessageConverter`轉換器是否可以讀取該ContentType的數據,並且內容和你指定的返回值類型匹配
public boolean canRead(Class<?> clazz, @Nullable MediaType mediaType) {
// supports判斷HttpMessageConverter轉換器是否支持你指定的返回類型,參考代碼清單1-3。canRead
return supports(clazz) && canRead(mediaType);
}
這是StringHttpMessageConverter
的supports方法,可以看出他可以處理返回類型為String的數據。
public boolean supports(Class<?> clazz) {
return String.class == clazz;
}
上面代碼supports方法返回true會調用canRead(org.springframework.http.MediaType)
方法,這段代碼主要就是判斷當前的HttpMessageConverter
是否可以處理content-type為服務端指定類型的響應報文,比如content-type為text/plain。
protected boolean canRead(@Nullable MediaType mediaType) {
if (mediaType == null) {
return true;
}
for (MediaType supportedMediaType : getSupportedMediaTypes()) {
if (supportedMediaType.includes(mediaType)) {
return true;
}
}
return false;
}
4.關鍵點截圖
以下是我在調試中截取的一些圖片。
這裡可以看到響應體的contentType
為text/plain,接下來就要找可以處理這種響應類型的HttpMessageConverter
。
這裡可以看到已註冊的HttpMessageConverter
列表裡面有九個元素,並且通過他們的supportedMediaTypes
屬性看到他們可以處理的contentType
。
首先判斷HttpMessageConverter
是否可以讀取我們指定的返回類,這裡我指定的是我自定義的一個返回類GetUserInfoByAccessToken.class
在這裡是在判斷當前HttpMessageConverter
是否可以處理當前響content-type為text/plain的響應報文。