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<T>，然后在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;

/**
 * @description 自定義返回JSON 數據格中日期格式化處理
 * @author aokunsang
 * @date 2013-5-28
 */
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<T>。然后在配置文件中注入自定義的ObjectMapper。

        代碼如下：

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.ObjectMapper;
import org.codehaus.jackson.map.SerializerProvider;
import org.codehaus.jackson.map.ser.CustomSerializerFactory;

/**
 * @description 解決Date類型返回json格式為自定義格式
 * @author aokunsang
 * @date 2013-5-28
 */
public class CustomObjectMapper extends ObjectMapper {

    public CustomObjectMapper(){
        CustomSerializerFactory factory = new CustomSerializerFactory();
        factory.addGenericMapping(Date.class, new 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));
            }
        });
        this.setSerializerFactory(factory);
    }
}

   spring-servlet.xml中配置：

<mvc:annotation-driven>
        <mvc:message-converters>
            <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
                <property name="objectMapper" ref="customObjectMapper"></property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>
    <bean id="customObjectMapper" class="com.pmc.dwa.common.custom.CustomObjectMapper"></bean>

 二、@DatetimeFormat使用注意

     1、 使用@DatetimeFormat很簡單，這里需要注意的是：使用時要引入一個類庫joda-time-1.3.jar，否則會無法訪問相應路徑(400錯誤)。 

ps：該注解可以作用在METHOD，FIELD以及PARAMETER級別上。

使用介紹參考：http://www.captaindebug.com/2011/08/using-spring-3-datetimeformat.html#.UaR3mWWZk0k

   2、因為springMVC沒有提供默認的日期轉換器，前段頁面傳遞過來日期字符串怎么轉換為日期類型，如果沒有提供全局日期轉換器或者數據綁定的基礎上，可以使用@DatetimeFormat注解完成。