Spring HttpMessageConverter 之 Jackson

我们在使用Spring MVC 是都有这样的经历，@ResponseBody返回一个JSON格式字符串到前端，或者使用@RequestBody获取前端REST提交的对象，那么Spring MVC 中是如何处理的呢？大体的流程如下：

 

 

 

  在Spring Web中使用 jackson处理，具体实现类是MappingJackson2HttpMessageConverter. 具体的JSON系列化和反序列化都是有jackson实现的。下面主要介绍一下jackson的使用。

     对日期进行JSON序列化：

Java代码  

1. /** 
2.  *  
3.  * @author zhangwei<[e-mail]> 
4.  * @since 2015年9月18日 下午4:08:08 
5.  * @version v 0.1 
6.  */  
7. public class ContainDateObject {  
8.   
9.     private Date startTime;  
10.   
11.     private Date endTime;  
12.   
13.     public Date getStartTime() {  
14.         return startTime;  
15.     }  
16.   
17.     public void setStartTime(Date startTime) {  
18.         this.startTime = startTime;  
19.     }  
20.   
21.     public Date getEndTime() {  
22.         return endTime;  
23.     }  
24.   
25.     public void setEndTime(Date endTime) {  
26.         this.endTime = endTime;  
27.     }  
28.   
29. }  

 

Java代码  

1. @Test  
2. public void testDate() throws JsonProcessingException {  
3.     ContainDateObject cdo = new ContainDateObject();  
4.     cdo.setStartTime(new Date());  
5.     cdo.setEndTime(new Date());  
6.     System.out.println(objectMapper.writeValueAsString(cdo));  
7. }  

 
 结果是:

Java代码  

1. {"startTime":1442563815734,"endTime":1442563815734}  

 

    这样的结果有的时候是无法接受的，我们有的时候需要一个yyyy-MM-dd HH:mm:ss这样格式的字符串改如何处理呢？这个时候我们就需要制定一个自定义的序列化类；

 

Java代码  

1. /** 
2.  * Desc:自定义日期类型序列化类 
3.  *  
4.  * @author zhangwei<[e-mail]> 
5.  * @since 2015年9月18日 下午4:12:51 
6.  * @version v 0.1 
7.  */  
8. public class DateJsonSerializer extends JsonSerializer<Date> {  
9.   
10.     /** 
11.      * @see com.fasterxml.jackson.databind.JsonSerializer#serialize(java.lang.Object, 
12.      *      com.fasterxml.jackson.core.JsonGenerator, 
13.      *      com.fasterxml.jackson.databind.SerializerProvider) 
14.      */  
15.     @Override  
16.     public void serialize(Date date, JsonGenerator generator, SerializerProvider provider)  
17.             throws IOException, JsonProcessingException {  
18.         ObjectMapper om = new ObjectMapper();  
19.         SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  
20.         om.writeValue(generator, sdf.format(date));  
21.     }  
22.   
23. }  

 

   在需要按照指定格式进行序列化的日期属性上添加注解

Java代码  

1. @JsonSerialize(using = DateJsonSerializer.class)  
2. private Date startTime;  
3.   
4. @JsonSerialize(using = DateJsonSerializer.class)  
5. private Date endTime;  

 

测试的结果是：

Java代码  

1. {"startTime":"2015-09-18 16:23:23","endTime":"2015-09-18 16:23:23"}  

 这样的结果就比较符合预期了

   反过来，使用这个JSON转换为一个对象时的结果怎样呢？

Java代码  

1. @Test  
2. public void testDate() throws Exception {  
3.     ContainDateObject cdo = new ContainDateObject();  
4.     cdo.setStartTime(new Date());  
5.     cdo.setEndTime(new Date());  
6.     String serializerResult = objectMapper.writeValueAsString(cdo);  
7.   
8.     cdo = objectMapper.readValue(serializerResult, ContainDateObject.class);  
9. }  

 结果却是：

Java代码  

1. com.fasterxml.jackson.databind.exc.InvalidFormatException: Can not construct instance of java.util.Date from String value '2015-09-18 16:26:58': not a valid representation (error: Failed to parse Date value '2015-09-18 16:26:58': Can not parse date "2015-09-18 16:26:58": not compatible with any of standard forms ("yyyy-MM-dd'T'HH:mm:ss.SSSZ", "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "EEE, dd MMM yyyy HH:mm:ss zzz", "yyyy-MM-dd"))  
2.  at [Source: {"startTime":"2015-09-18 16:26:58","endTime":"2015-09-18 16:26:58"}; line: 1, column: 2] (through reference chain: com.david.demo.jackson.ContainDateObject["startTime"])  
3.     at com.fasterxml.jackson.databind.exc.InvalidFormatException.from(InvalidFormatException.java:55)  
4.     at com.fasterxml.jackson.databind.DeserializationContext.weirdStringException(DeserializationContext.java:883)  
5.     at com.fasterxml.jackson.databind.deser.std.StdDeserializer._parseDate(StdDeserializer.java:750)  
6.     at com.fasterxml.jackson.databind.deser.std.DateDeserializers$DateBasedDeserializer._parseDate(DateDeserializers.java:176)  
7.     at com.fasterxml.jackson.databind.deser.std.DateDeserializers$DateDeserializer.deserialize(DateDeserializers.java:262)  
8.     at com.fasterxml.jackson.databind.deser.std.DateDeserializers$DateDeserializer.deserialize(DateDeserializers.java:246)  
9.     at com.fasterxml.jackson.databind.deser.SettableBeanProperty.deserialize(SettableBeanProperty.java:523)  
10.     at com.fasterxml.jackson.databind.deser.impl.MethodProperty.deserializeAndSet(MethodProperty.java:95)  
11.     at com.fasterxml.jackson.databind.deser.impl.BeanPropertyMap.findDeserializeAndSet(BeanPropertyMap.java:285)  
12.     at com.fasterxml.jackson.databind.deser.BeanDeserializer.vanillaDeserialize(BeanDeserializer.java:248)  
13.     at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserialize(BeanDeserializer.java:136)  
14.     at com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.java:3562)  
15.     at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:2578)  

  反序列化失败了，这又改如何处理呢？我们同样指定反序列化类

Java代码  

1. /** 
2.  * Desc:日期类型的反序列化类 
3.  *  
4.  * @author zhangwei<[e-mail]> 
5.  * @since 2015年9月18日 下午4:31:02 
6.  * @version v 0.1 
7.  */  
8. public class DateJsonDeserializer extends JsonDeserializer<Date> {  
9.   
10.     /** 
11.      * @see com.fasterxml.jackson.databind.JsonDeserializer#deserialize(com.fasterxml.jackson.core.JsonParser, 
12.      *      com.fasterxml.jackson.databind.DeserializationContext) 
13.      */  
14.     @Override  
15.     public Date deserialize(JsonParser parser, DeserializationContext context)  
16.             throws IOException, JsonProcessingException {  
17.         try {  
18.             SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  
19.             return sdf.parse(parser.getValueAsString());  
20.         } catch (Exception e) {  
21.             e.printStackTrace();  
22.         }  
23.         return null;  
24.     }  
25.   
26. }  

 

Java代码  

1. @JsonSerialize(using = DateJsonSerializer.class)  
2. @JsonDeserialize(using = DateJsonDeserializer.class)  
3. private Date startTime;  
4.   
5. @JsonSerialize(using = DateJsonSerializer.class)  
6. @JsonDeserialize(using = DateJsonDeserializer.class)  
7. private Date endTime;  

 这样反序列化问题也可以很好地解决了。

    我们再想对象中添加一个个人隐私信息字段 phone;

Java代码  

1. @JsonSerialize(using = DateJsonSerializer.class)  
2. @JsonDeserialize(using = DateJsonDeserializer.class)  
3. private Date startTime;  
4.   
5. @JsonSerialize(using = DateJsonSerializer.class)  
6. @JsonDeserialize(using = DateJsonDeserializer.class)  
7. private Date endTime;  
8.   
9. private String phone;  

 

Java代码  

1. @Test  
2.     public void testDate() throws Exception {  
3.         ContainDateObject cdo = new ContainDateObject();  
4.         cdo.setStartTime(new Date());  
5.         cdo.setEndTime(new Date());  
6.         cdo.setPhone("13919309243");  
7.         String serializerResult = objectMapper.writeValueAsString(cdo);  
8.         System.out.println(serializerResult);  
9.         objectMapper.readValue(serializerResult, ContainDateObject.class);  
10.     }  

 这样序列化的结果是：

Java代码  

1. {"startTime":"2015-09-18 16:37:34","endTime":"2015-09-18 16:37:34","phone":"13919309243"}  

 phone是一个个人隐私信息，如果不想被序列化改如何处理？只需要在该属性上添加一个注解

Java代码  

1. @JsonIgnore  
2. private String phone;  

 再次序列化的结果是：

Java代码  

1. {"startTime":"2015-09-18 16:43:15","endTime":"2015-09-18 16:43:15"}