1、問題排查
出現(xiàn)的場景:
服務(wù)端通過springmvc寫了一個對外的接口屿储,返回一個json字符串贿讹,其中該json帶有日期,格式為yyyy-MM-dd HH:mm:ss
客戶端通過feign調(diào)用該http接口扩所,指定返回值為一個Dto围详,Dto中日期的字段為Date類型
客戶端調(diào)用該接口后拋異常了。
報錯異常如下:
10:38:50 [ERROR] >> com.syt.firefly.cloud.service.cms.CmsManageController:35
feign.codec.DecodeException: JSON parse error: Can not deserialize value of type java.util.Date from String "2018-07-04 13:32:50": not a valid representation (error: Failed to parse Date value '2018-07-04 13:32:50': Can not parse date "2018-07-04 13:32:50": while it seems to fit format 'yy
yy-MM-dd'T'HH:mm:ss.SSS', parsing fails (leniency? null)); nested exception is com.fasterxml.jackson.databind.exc.InvalidFormatException: Can not
deserialize value of type java.util.Date from String "2018-07-04 13:32:50": not a valid representation (error: Failed to parse Date value '2018-
07-04 13:32:50': Can not parse date "2018-07-04 13:32:50": while it seems to fit format 'yyyy-MM-dd'T'HH:mm:ss.SSS', parsing fails (leniency? nul
l))
at [Source: java.io.PushbackInputStream@6fdf3c74; line: 1, column: 654] (through reference chain: java.util.ArrayList[0]->com.syt.firefly.cloud.
service.cms.bean.ClassicCaseVo["created"])
at feign.SynchronousMethodHandler.decode(SynchronousMethodHandler.java:169)
at feign.SynchronousMethodHandler.executeAndDecode(SynchronousMethodHandler.java:133)
at feign.SynchronousMethodHandler.invoke(SynchronousMethodHandler.java:76)
at feign.ReflectiveFeign$FeignInvocationHandler.invoke(ReflectiveFeign.java:103)
at com.sun.proxy.$Proxy146.getList(Unknown Source)
at com.syt.firefly.cloud.service.cms.CmsManageController.getList(CmsManageController.java:30)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
從異常信息中我們可以看出,是在AbstractJackson2HttpMessageConverter類中調(diào)用了readJavaType方法之后拋的異常
一步一步往下深入助赞,我們找到了最關(guān)鍵的地方买羞,在DeserializationContext類的_parseDate方法中,執(zhí)行了df.parse(dateStr)之后拋異常了
public Date parseDate(String dateStr) throws IllegalArgumentException
{
try {
DateFormat df = getDateFormat();
// 這行代碼報錯了
return df.parse(dateStr);
} catch (ParseException e) {
throw new IllegalArgumentException(String.format(
"Failed to parse Date value '%s': %s", dateStr, e.getMessage()));
}
}
- DeserializationContext是jackson的一個反序列化的一個上下文雹食,那么它的DateFormat是從哪來的呢?我們再來看下getDateFormat的源碼
protected DateFormat getDateFormat()
{
if (_dateFormat != null) {
return _dateFormat;
}
DateFormat df = _config.getDateFormat();
_dateFormat = df = (DateFormat) df.clone();
return df;
}
- DateFormat又是從MapperConfig而來畜普,我們再看下config.getDateFormat()的源碼
public final DateFormat getDateFormat() { return _base.getDateFormat(); }
2、問題處理
異常說的值服務(wù)器返回了一個帶有日期的json群叶,日期的形式是字符串2018-03-07 16:18:35吃挑,jackson無法將該字符串轉(zhuǎn)成一個Date對象,網(wǎng)上查資料街立,上面說的是jackson只支持以下幾種日期格式:
"yyyy-MM-dd'T'HH:mm:ss.SSSZ"舶衬;
"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
"yyyy-MM-dd";
"EEE, dd MMM yyyy HH:mm:ss zzz";
long類型的時間戳
去掉服務(wù)端的以下兩個配置赎离,讓日期返回時間戳逛犹,結(jié)果就沒報錯了
#spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
#spring.jackson.time-zone=Asia/Chongqing
由于服務(wù)端在其他的地方有可能和這里的配置耦合了,也就是說其他地方有可能要用到的是yyyy-MM-dd HH:mm:ss這一日期格式而不是時間戳的格式梁剔,所以這個配置肯定是不能修改的虽画。
jackson竟然不支持yyyy-MM-dd HH:mm:ss的這種格式,肯定很不爽啦荣病,所以下面就要開始來研究怎么讓jackson支持這種格式了码撰。
要讓jackson支持這種格式,那么就必須修改ObjectMapper中的DateFormat个盆,因為在ObjectMapper中脖岛,DateFormat的默認實現(xiàn)類是StdDateFormat,StdDateFormat也就只兼容了我們上述所說的幾種格
首先我們先使用裝飾模式來創(chuàng)建一個支持yyyy-MM-dd HH:mm:ss格式的DateFormat如下
import java.text.DateFormat;
import java.text.FieldPosition;
import java.text.ParseException;
import java.text.ParsePosition;
import java.text.SimpleDateFormat;
import java.util.Date;
public class MyDateFormat extends DateFormat {
private DateFormat dateFormat;
private SimpleDateFormat format1 = new SimpleDateFormat("yyy-MM-dd HH:mm:ss");
public MyDateFormat(DateFormat dateFormat) {
this.dateFormat = dateFormat;
}
@Override
public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) {
return dateFormat.format(date, toAppendTo, fieldPosition);
}
@Override
public Date parse(String source, ParsePosition pos) {
Date date = null;
try {
date = format1.parse(source, pos);
} catch (Exception e) {
date = dateFormat.parse(source, pos);
}
return date;
}
// 主要還是裝飾這個方法
@Override
public Date parse(String source) throws ParseException {
Date date = null;
try {
// 先按我的規(guī)則來
date = format1.parse(source);
} catch (Exception e) {
// 不行砾省,那就按原先的規(guī)則吧
date = dateFormat.parse(source);
}
return date;
}
// 這里裝飾clone方法的原因是因為clone方法在jackson中也有用到
@Override
public Object clone() {
Object format = dateFormat.clone();
return new MyDateFormat((DateFormat) format);
}
}
- DateFormat有了鸡岗,接下來的任務(wù)就是讓ObjectMapper使用我的這個DateFormat了,在config類中定義如下(本案例基于springboot)
@Configuration
public class WebConfig {
@Autowired
private Jackson2ObjectMapperBuilder jackson2ObjectMapperBuilder;
@Bean
public MappingJackson2HttpMessageConverter MappingJsonpHttpMessageConverter() {
ObjectMapper mapper = jackson2ObjectMapperBuilder.build();
// ObjectMapper為了保障線程安全性编兄,里面的配置類都是一個不可變的對象
// 所以這里的setDateFormat的內(nèi)部原理其實是創(chuàng)建了一個新的配置類
DateFormat dateFormat = mapper.getDateFormat();
mapper.setDateFormat(new MyDateFormat(dateFormat));
MappingJackson2HttpMessageConverter mappingJsonpHttpMessageConverter = new MappingJackson2HttpMessageConverter(
mapper);
return mappingJsonpHttpMessageConverter;
}
}
- 配置了上述代碼之后轩性,問題成功解決。
3狠鸳、為什么往spring容器中注入MappingJackson2HttpMessageConverter揣苏,springMvc就會用這個Converter呢?
- 查看springboot的源代碼如下:
@Configuration
class JacksonHttpMessageConvertersConfiguration {
@Configuration
@ConditionalOnClass(ObjectMapper.class)
@ConditionalOnBean(ObjectMapper.class)
@ConditionalOnProperty(name = HttpMessageConvertersAutoConfiguration.PREFERRED_MAPPER_PROPERTY, havingValue = "jackson", matchIfMissing = true)
protected static class MappingJackson2HttpMessageConverterConfiguration {
@Bean
@ConditionalOnMissingBean(value = MappingJackson2HttpMessageConverter.class, ignoredType = {
"org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter",
"org.springframework.data.rest.webmvc.alps.AlpsJsonHttpMessageConverter" })
public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter(
ObjectMapper objectMapper) {
return new MappingJackson2HttpMessageConverter(objectMapper);
}
}
默認配置為件舵,當(dāng)spring容器中沒有MappingJackson2HttpMessageConverter這個實例的時候才會被創(chuàng)建
springboot的思想是約定優(yōu)于配置卸察,也就是說,springboot默認幫我們配好了spring mvc的Converter铅祸,如果我們沒有自定義Converter的話坑质,那么框架就會幫我們創(chuàng)建一個合武,如果我們有自定義的話,那么springboot就直接使用我們所注冊的bean進行綁定
本文轉(zhuǎn)自黃雄杰的博文Spring Mvc使用Jackson進行json轉(zhuǎn)對象時涡扼,遇到的字符串轉(zhuǎn)日期的異常處理(Can not deserialize value of type Date from String) 稼跳,剛剛在調(diào)用過程發(fā)現(xiàn)這個問題,遂記錄一下吃沪,謝謝原作者汤善。