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即可實現。
程式碼如下:
Java程式碼- 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));
- }
- }
使用方式:
Java程式碼- @JsonSerialize(using = CustomDateSerializer.class)
- public Date getCreateDate() {
- return createDate;
- }
2、全域性修改(強烈推薦):
MappingJacksonHttpMessageConverter主要通過ObjectMapper來實現返回json字串。這裡我們繼承該類,註冊一個JsonSerializer<T>。然後在配置檔案中注入自定義的ObjectMapper。
程式碼如下:
Java程式碼- 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中配置:
Java程式碼- <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級別上。
2、因為springMVC沒有提供預設的日期轉換器,前段頁面傳遞過來日期字串怎麼轉換為日期型別,如果沒有提供全域性日期轉換器或者資料繫結的基礎上,可以使用@DatetimeFormat註解完成。