@JsonFormat
spring将Java 数据类型的序列和反序列化为JSON字符串是依赖jackson(com.fasterxml.jackson.core:jackson-core)库来实现的,对于Java Bean中的Date类型字段,可以使用@JsonFormat
注释来指定日期格式,示例如下:
@NotNull
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
@JsonProperty("start_time")
private Date startTime;
但是对于非类Java Bean的字段,怎么指定日期格式呢?
比如一个value中有Date类型的Map<String,Object>
类型序列化时,如何控制jackson对Date类型的日期格式呢?
@Bean
可以通过如下方式配置一个bean,如下示例指定将所有Date类型序列化时生成ISO8601标准格式的字串串
/** ISO8601时间格式 */
private static final String ISO8601_FORMATTER_STR = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
@Bean
public Jackson2ObjectMapperBuilderCustomizer jacksonObjectMapperCustomization() {
return jacksonObjectMapperBuilder ->
jacksonObjectMapperBuilder.simpleDateFormat(ISO8601_FORMATTER_STR);
}
org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer
接口是spring为应用层配置jackson序列化参数而定义的。通过这个接口可以指定很多jackson的特性,其中就包括关于日期类型序列的参数。
下面的通过@Bean
返回一个指定了日期类型的ObjectMapper
实例也是同样的效果:
import org.springframework.context.annotation.Bean;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.TimeZone;
import com.fasterxml.jackson.databind.ObjectMapper;
/** ISO8601时间格式 */
private static final String ISO8601_FORMATTER_STR = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
@Bean
public ObjectMapper objectMapper() {
DateFormat dateFormat = new SimpleDateFormat(ISO8601_FORMATTER_STR );
ObjectMapper dateFormatMapper = new ObjectMapper();
dateFormatMapper.setDateFormat(dateFormat);
return dateFormatMapper;
}
配置文件(全局配置)
还可以通过在application.properties
中通过全局配置参数 spring.jackson.date-format
, spring.jackson.time-zone
来指定日期格式和时区
application.properties
spring.jackson.date-format=yyyy-MM-dd'T'HH:mm:ss.SSSZ
spring.jackson.time-zone=GMT+8
application.yml
spring:
jackson:
date-format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
time-zone: GMT+8
参考资料
《Spring Jackson custom date format》
《Spring boot date 序列化问题》