SpringBoot中统一/单独处理日期格式（Http请求返回JSON格式数据中的日期格式）

原理

• 默认情况：SpringBoot中，默认使用Jackson进行格式化返回数据（将返回数据格式化为JSON字符串），故设置Jackson格式化时对日期的处理格式即可。
• fastJson：当使用fastJson作为Http请求返回数据格式化时，需要单独对fastJson进行配置

特别说明

• 由于设置 Jackson 或 fastJson 作为Http请求数据格式化类，故：不论是返回数据中的日期格式化，还是将请求入参中的String类型的yyyy-MM-dd HH:mm:ss转为java.util.Date类型，都会使用配置的日期格式。比如：
  • 当请求参数 {“createTime”:“2001-02-21 13:05:21”} 中的createTime为yyyy-MM-dd HH:mm:ss格式，故可以通过配置Jackson的时间格式，将其转化为java.util.Date类型
  • 当返回值中 private Date createTime 的 createTime为java.util.Date类型，故可以通过配置Jackson的时间格式，将其转为yyyy-MM-dd HH:mm:ss格式的字符串
• 简单来说：配置后，可以很方便的在java.util.Date与时间字符串之间进行自动转换

统一处理

默认情况

• 由于默认情况下，使用Jackson格式化数据，故只需要进行简单配置即可，如下：

# spring boot默认使用jackson格式化输出数据，故只需要修改Jackson的格式化日期格式即可
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss # 格式化日期格式
spring.jackson.time-zone=GMT+8 # 时区

fastJson作为HttpMessageConverters时

• 在将fastJsonHttpMessageConverter添加到HttpMessageConverters前，就需要对fastJsonHttpMessageConverter进行配置
• fastjson SerializerFeature详解

package gk.springboot.preheat.config;

import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import org.springframework.boot.autoconfigure.http.HttpMessageConverters;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;

import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.List;

@Configuration
public class HttpMessageConverterConfig {
	// 自定义Spring容器中HttpMessageConverters对象，并行相关配置
    @Bean
    public HttpMessageConverters fastJsonHttpMessageConverter() {
        FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
        // 设置FastJsonHttpMessageConverter支持的MediaType
        converter.setSupportedMediaTypes(Arrays.asList(MediaType.APPLICATION_JSON));
        FastJsonConfig config = new FastJsonConfig();
        // 配置统一日期格式化格式
        config.setDateFormat("yyyy-MM-dd HH:mm:ss");
        config.setCharset(Charset.forName("UTF-8"));
        config.setSerializerFeatures(
                SerializerFeature.WriteMapNullValue // 配置返回值中null值时，不允许删除key
        );
        converter.setFastJsonConfig(config);
        
        // 将FastJsonHttpMessageConverter添加到HttpMessageConverters中
        HttpMessageConverters messageConverters = new HttpMessageConverters(converter);
        List<HttpMessageConverter<?>> converters = messageConverters.getConverters();
        System.out.println("包含的消息转换器 => " + converters);
        return messageConverters;
    }
}

单独处理

• 当需要单独处理时，就需要针对字段进行加注解即可

默认情况

• 即：使用Jackson进行JSON格式化时
• 直接使用@JsonFormat注解，进行单独处理
• @JsonFormat注解优先级要高于全局配置

package gk.springboot.preheat.model;

import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;

import java.util.Date;
import java.util.List;

@Data
public class UserInfo {
    private Integer id;
    private String name;
    private Integer age;
    private Character sex;
    @JsonFormat(pattern = "yy-M-d HH:mm:ss", locale = "GMT+8")
    private Date createTime = new Date();
    // 该字段没有单独配置，使用的是默认全局配置
    private Date updateTime = new Date();
    private List<Account> account;
}

fastJson作为HttpMessageConverters时

• 使用fastJson提供的注解@JSONField进行单独配置
• 同样，@JSONField注解优先级高于全局配置

package gk.springboot.preheat.model;

import com.alibaba.fastjson.annotation.JSONField;
import lombok.Data;

import java.util.Date;
import java.util.List;

@Data
public class UserInfo {
    private Integer id;
    private String name;
    private Integer age;
    private Character sex;
    @JSONField(format = "yy-M-d HH:mm:ss")
    private Date createTime = new Date();
    // 该字段使用全局配置
    private Date updateTime = new Date();
    private List<Account> account;
}

测试