SpringBoot设置全局Json请求响应的日期格式化

针对场景

优化SpringBoot项目中实体类的日期属性使用相同的格式化注解的问题。

• 避免注解的重复性编写
• @JsonFormat(pattern = “yyyy-MM-dd HH:mm:ss”)

解决方案

添加配置类：

import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalTimeSerializer;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;

/**
 * 时间序列化配置
 *
 * @author Ara
 * @since 2022/5/17
 */
@Configuration
public class DateSerializerAndDeserializerConfig {

	//可采用配置文件的方式配置格式
    @Value("${custom.jackson.format.local-date-time:yyyy-MM-dd HH:mm:ss}")
    private String localDateTimePattern;

    @Value("${custom.jackson.format.local-date:yyyy-MM-dd}")
    private String localDatePattern;

    @Value("${custom.jackson.format.local-time:HH:mm:ss}")
    private String localTimePattern;

    @Value("${custom.jackson.format.date:yyyy-MM-dd HH:mm:ss}")
    private String datePattern;

    /**
     * LocalDateTime序列化器
     *
     * @return LocalDateTime序列化器
     */
    @Bean
    public LocalDateTimeSerializer localDateTimeSerializer() {
        return new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(localDateTimePattern));
    }

    /**
     * LocalDateTime反序列化器
     *
     * @return LocalDateTime反序列化器
     */
    @Bean
    public LocalDateTimeDeserializer localDateTimeDeserializer() {
        return new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(localDateTimePattern));
    }

    /**
     * LocalDate序列化器
     *
     * @return LocalDate序列化器
     */
    @Bean
    public LocalDateSerializer localDateSerializer() {
        return new LocalDateSerializer(DateTimeFormatter.ofPattern(localDatePattern));
    }

    /**
     * LocalDate反序列化器
     *
     * @return LocalDate反序列化器
     */
    @Bean
    public LocalDateDeserializer localDateDeserializer() {
        return new LocalDateDeserializer(DateTimeFormatter.ofPattern(localDatePattern));
    }

    /**
     * LocalTime序列化器
     *
     * @return LocalTime序列化器
     */
    @Bean
    public LocalTimeSerializer localTimeSerializer() {
        return new LocalTimeSerializer(DateTimeFormatter.ofPattern(localTimePattern));
    }

    /**
     * LocalTime反序列化器
     *
     * @return LocalTime反序列化器
     */
    @Bean
    public LocalTimeDeserializer localTimeDeserializer() {
        return new LocalTimeDeserializer(DateTimeFormatter.ofPattern(localTimePattern));
    }

    /**
     * 添加序列化和反序列化器（Date只需要设置SimpleDateFormat即可）
     *
     * @return 自定义Jackson的对象映射builder
     */
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer localDateTimeMapperBuilder() {
        return builder -> builder
                .serializerByType(LocalDateTime.class, localDateTimeSerializer())
                .deserializerByType(LocalDateTime.class, localDateTimeDeserializer())
                .serializerByType(LocalDate.class, localDateSerializer())
                .deserializerByType(LocalDate.class, localDateDeserializer())
                .serializerByType(LocalTime.class, localTimeSerializer())
                .deserializerByType(LocalTime.class, localTimeDeserializer())
                .simpleDateFormat(datePattern);
    }

}

• 如果某些实体类中需要特殊的格式，可以使用@JsonFormat注解来进行设置。