时间戳

首页 > 技术文章 > SpringMVC 设置全局DateTime json返回格式

SpringMVC 设置全局DateTime json返回格式

cmlblog 2015-04-30 16:25 原文

对于部分返回DateTime的项目，只需要在指定属性上添加@JsonSerialize 使用自定义的json转换格式即可自定义返回DateTime格式

但是对于项目中返回有多个DateTime字段来说，上面的方法明显不适用，这时需要自定义全局的DateTime转换器：

1、配置文件：

	<!-- 采用SpringMVC自带的JSON转换工具，支持@ResponseBody注解 -->
	<bean
		class=" org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
	
		<property name="messageConverters">
			<list>
				<ref bean="mappingJacksonHttpMessageConverter" />
			</list>
		</property>
		
	</bean>
   <!-- 避免IE执行AJAX时,返回JSON出现下载文件 -->
	<bean id="mappingJacksonHttpMessageConverter"
		class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
		<property name="supportedMediaTypes">
			<list>
				<value>application/json;charset=UTF-8</value>
				<value>text/html;charset=UTF-8</value>
			</list>
		</property>
		<property name="objectMapper">
			<bean class="com.cml.mvc.framework.converter.DateTimeConverter"></bean>
		</property>
	</bean>

主要是在mappingJacksonHttpMessageConverter中自定义objectMapper


2、下载需要的jar

               <dependency>
			<groupId>com.fasterxml.jackson.datatype</groupId>
			<artifactId>jackson-datatype-joda</artifactId>
			<version>${jackson.mapper}</version>
		</dependency>

3、自己实现ObjectMapper 

public class DateTimeConverter extends ObjectMapper {

	private static final long serialVersionUID = 1L;

	public DateTimeConverter() {
		this.registerModule(new BaseJodaModule());
		this.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
	}
}

BaseJodaModule主要是修改com.fasterxml.jackson.datatype.joda.JodaModule代码，只需要在DateTime注册转换器上传入自定义日期格式即可

4、BaseJodaModule

package com.cml.mvc.framework.converter.datetime;

import org.joda.time.DateMidnight;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.joda.time.Duration;
import org.joda.time.Instant;
import org.joda.time.Interval;
import org.joda.time.LocalDate;
import org.joda.time.LocalDateTime;
import org.joda.time.LocalTime;
import org.joda.time.MonthDay;
import org.joda.time.Period;
import org.joda.time.ReadableDateTime;
import org.joda.time.ReadableInstant;
import org.joda.time.ReadablePeriod;
import org.joda.time.YearMonth;
import org.joda.time.format.DateTimeFormat;

import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import com.fasterxml.jackson.datatype.joda.PackageVersion;
import com.fasterxml.jackson.datatype.joda.cfg.JacksonJodaDateFormat;
import com.fasterxml.jackson.datatype.joda.deser.DateMidnightDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.DateTimeDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.DateTimeZoneDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.DurationDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.InstantDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.IntervalDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.LocalDateDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.LocalTimeDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.MonthDayDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.PeriodDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.YearMonthDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.key.DateTimeKeyDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.key.LocalDateKeyDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.key.LocalDateTimeKeyDeserializer;
import com.fasterxml.jackson.datatype.joda.deser.key.LocalTimeKeyDeserializer;
import com.fasterxml.jackson.datatype.joda.ser.DateMidnightSerializer;
import com.fasterxml.jackson.datatype.joda.ser.DateTimeSerializer;
import com.fasterxml.jackson.datatype.joda.ser.DateTimeZoneSerializer;
import com.fasterxml.jackson.datatype.joda.ser.DurationSerializer;
import com.fasterxml.jackson.datatype.joda.ser.InstantSerializer;
import com.fasterxml.jackson.datatype.joda.ser.IntervalSerializer;
import com.fasterxml.jackson.datatype.joda.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.joda.ser.LocalDateTimeSerializer;
import com.fasterxml.jackson.datatype.joda.ser.LocalTimeSerializer;
import com.fasterxml.jackson.datatype.joda.ser.PeriodSerializer;

@SuppressWarnings("deprecation")
public class BaseJodaModule extends SimpleModule {

	private static final long serialVersionUID = 1L;

	public static final String DATE_TIME_PATTERN = "yyyyMMddHHmmss";
	private static final JacksonJodaDateFormat DATE_TIME_FORMATTER = new JacksonJodaDateFormat(
			DateTimeFormat.forPattern(DATE_TIME_PATTERN).withZoneUTC());

	@SuppressWarnings({ "unchecked" })
	public BaseJodaModule() {

		super(PackageVersion.VERSION);
		// first deserializers
		addDeserializer(DateMidnight.class, new DateMidnightDeserializer());
		addDeserializer(DateTime.class,
				DateTimeDeserializer.forType(DateTime.class));
		addDeserializer(DateTimeZone.class, new DateTimeZoneDeserializer());

		addDeserializer(Duration.class, new DurationDeserializer());
		addDeserializer(Instant.class, new InstantDeserializer());
		addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer());
		addDeserializer(LocalDate.class, new LocalDateDeserializer());
		addDeserializer(LocalTime.class, new LocalTimeDeserializer());
		JsonDeserializer<?> deser = new PeriodDeserializer(true);
		addDeserializer(Period.class, (JsonDeserializer<Period>) deser);
		addDeserializer(ReadablePeriod.class, new PeriodDeserializer(false));
		addDeserializer(ReadableDateTime.class,
				DateTimeDeserializer.forType(ReadableDateTime.class));
		addDeserializer(ReadableInstant.class,
				DateTimeDeserializer.forType(ReadableInstant.class));
		addDeserializer(Interval.class, new IntervalDeserializer());
		addDeserializer(MonthDay.class, new MonthDayDeserializer());
		addDeserializer(YearMonth.class, new YearMonthDeserializer());

		// then serializers:
		final JsonSerializer<Object> stringSer = ToStringSerializer.instance;
		addSerializer(DateMidnight.class, new DateMidnightSerializer());
               //主要是修改这里，自定义日期格式
		addSerializer(DateTime.class, new DateTimeSerializer(
				DATE_TIME_FORMATTER));
		addSerializer(DateTimeZone.class, new DateTimeZoneSerializer());
		addSerializer(Duration.class, new DurationSerializer());
		addSerializer(Instant.class, new InstantSerializer());
		addSerializer(LocalDateTime.class, new LocalDateTimeSerializer());
		addSerializer(LocalDate.class, new LocalDateSerializer());
		addSerializer(LocalTime.class, new LocalTimeSerializer());
		addSerializer(Period.class, new PeriodSerializer());
		addSerializer(Interval.class, new IntervalSerializer());
		addSerializer(MonthDay.class, stringSer);
		addSerializer(YearMonth.class, stringSer);

		// then key deserializers
		addKeyDeserializer(DateTime.class, new DateTimeKeyDeserializer());
		addKeyDeserializer(LocalTime.class, new LocalTimeKeyDeserializer());
		addKeyDeserializer(LocalDate.class, new LocalDateKeyDeserializer());
		addKeyDeserializer(LocalDateTime.class,
				new LocalDateTimeKeyDeserializer());
	}

	// yes, will try to avoid duplicate registations (if MapperFeature enabled)
	@Override
	public String getModuleName() {
		return getClass().getSimpleName();
	}

	@Override
	public int hashCode() {
		return getClass().hashCode();
	}

	@Override
	public boolean equals(Object o) {
		return this == o;
	}

}
 自定义全局DateTime json格式ok，但是个人感觉太复杂了，设置个日期格式而已，要配置，自己实现这么多步骤！期待更简单的全局配置方式。。。




推荐阅读