SpringMVC使用@ResponseBody时返回json的日期格式、@DatetimeFormat使用注意

一、SpringMVC使用@ResponseBody时返回json的日期格式

前提了解：@ResponseBody 返回json字符串的核心类是org.springframework.http.converter.json.MappingJacksonHttpMessageConverter，它使用了Jackson 这个开源的第三方类库。主要是以下两个jar包：jackson-core-asl-1.6.4.jar；jackson-mapper-asl-1.6.4.jar。

出现问题： 使用@ResponseBody时返回json字符串的日期格式。Date类型属性默认返回一个Long型的时间戳，怎样能够返回自定义的日期格式？

解决方案：目前有两种方式实现,

1、局部修改(网上较多，但不推荐)；

继承Jackson的抽象类：JsonSerializer，然后在javabean的属性getter()上添加注解@JsonSerialize即可实现。

代码如下：

import java.io.IOException;  
import java.text.SimpleDateFormat;  
import java.util.Date;  

import org.codehaus.jackson.JsonGenerator;  
import org.codehaus.jackson.JsonProcessingException;  
import org.codehaus.jackson.map.JsonSerializer;  
import org.codehaus.jackson.map.SerializerProvider;  

/** 
 *
 */  
public class CustomDateSerializer extends JsonSerializer<Date> {  

    @Override  
    public void serialize(Date value,   
            JsonGenerator jsonGenerator,   
            SerializerProvider provider)  
            throws IOException, JsonProcessingException {  
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  
        jsonGenerator.writeString(sdf.format(value));  
    }  
}  

使用方式：

@JsonSerialize(using = CustomDateSerializer.class)  
public Date getCreateDate() {  
    return createDate;  
}  

2、全局修改(强烈推荐)：

MappingJacksonHttpMessageConverter主要通过ObjectMapper来实现返回json字符串。这里我们继承该类，注册一个JsonSerializer。然后在配置文件中注入自定义的ObjectMapper。

代码如下：

package com.yd.njmz.converter;

import java.io.IOException;
import java.sql.SQLException;
import java.text.SimpleDateFormat;
import java.util.Date;

import org.apache.log4j.Logger;
import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonProcessingException;
import org.codehaus.jackson.map.JsonSerializer;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializerProvider;
import org.codehaus.jackson.map.ser.CustomSerializerFactory;
import org.springframework.stereotype.Component;

import oracle.sql.TIMESTAMP;

/**
 * springmvc返回视图前统一格式化oracle.sql.TIMESTAMP类型的时间
 * @author 張丶張張張某人
 *
 */
@Component
public class DateFormatMapper extends ObjectMapper {

    Logger log = Logger.getLogger(DateFormatMapper.class);

    public DateFormatMapper(){
        CustomSerializerFactory factory = new CustomSerializerFactory();

        factory.addGenericMapping(TIMESTAMP.class, new JsonSerializer<TIMESTAMP>() {

            @Override
            public void serialize(TIMESTAMP value, JsonGenerator jsonGenerator, SerializerProvider provider)
                    throws IOException, JsonProcessingException {
                // TODO Auto-generated method stub
                SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
                try {
                    jsonGenerator.writeString(sdf.format(new Date(value.timestampValue().getTime())));
                } catch (SQLException e) {
                    log.error(e.getMessage());
                }

            }
        });

        this.setSerializerFactory(factory);
    }
}

springMVC-servlet.xml中配置：

   <mvc:annotation-driven>
        <!-- 格式化返回视图 -->
        <mvc:message-converters register-defaults="true">
            <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
                <!-- 格式化Oracle时间 -->
                <property name="objectMapper" ref="dateFormatMapper"/>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

注意：以上的时间类型转换可随意切换到你使用的类型直接的转换

二、@DatetimeFormat使用注意

1、 使用@DatetimeFormat很简单，这里需要注意的是：使用时要引入一个类库joda-time-1.3.jar，否则会无法访问相应路径(400错误)。

ps：该注解可以作用在METHOD，FIELD以及PARAMETER级别上。

2、因为springMVC没有提供默认的日期转换器，前段页面传递过来日期字符串怎么转换为日期类型，如果没有提供全局日期转换器或者数据绑定的基础上，可以使用@DatetimeFormat注解完成。