分析Jackson配置JSON日期格式转换器与@JsonIgnore和@JsonFormat注解之间的冲突导致的注解失效问题的原因

最新推荐文章于 2024-09-25 17:20:24 发布

atguigushaobo

最新推荐文章于 2024-09-25 17:20:24 发布

阅读量1k

点赞数 23

文章标签： json springboot 后端 postman

本文链接：https://blog.csdn.net/2403_85029987/article/details/141428719

版权

前情提要：我们这里只探讨这两个Jackson相关依赖提供的注解标识在我们的实体类的日期属性上，与Jackson相关API实现的全局JSON日期格式转换器一起使用会导致的问题。
Jackson相关的依赖
jackson-annotations-2.16.1.jar
jackson-core-2.16.1.jar
jackson-databind-2.17.0.jar

首先JSON日期类型格式转换器的创建和配置以及@JsonFormat和@JsonIgnore的作用简介介绍

创建和配置JSON日期格式转换器

@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {
	@Override
    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        converter.setObjectMapper(new JacksonObjectMapper());
        converters.add(0,converter);//因为mvc内部配置有多个信息对象转换器，我们尽量将我们的JSON对象转换器放得靠前一点
        //同时我们当时看内部方法时，也看到了final修饰的配置默认信息对象转换器的方法
    }   
}

package com.sky.json;

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
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 java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;

import static com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES;

/**
 * 对象映射器:基于jackson将Java对象转为json，或者将json转为Java对象
 * 将JSON解析为Java对象的过程称为 [从JSON反序列化Java对象]
 * 从Java对象生成JSON的过程称为 [序列化Java对象到JSON]
 */
public class JacksonObjectMapper extends ObjectMapper {

    public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
    //public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
    //这里其实可以修改反序列化JSON的转变格式
    public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm";
    public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";

    public JacksonObjectMapper() {
        super();
        //收到未知属性时不报异常
        this.configure(FAIL_ON_UNKNOWN_PROPERTIES, false);

        //反序列化时，属性不存在的兼容处理
        this.getDeserializationConfig().withoutFeatures(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
		//添加对应的日期格式的序列化和反序列化格式，我们可以修改不同的序列化和反序列化格式
        SimpleModule simpleModule = new SimpleModule()
                .addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))
                .addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
                .addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)))
                .addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))
                .addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
                .addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));

        //注册功能模块 例如，可以添加自定义序列化器和反序列化器
        this.registerModule(simpleModule);
    }
}

从导入的包可以看出，该转换器是由jackson相关依赖实现的
这种方式是全局的对象扫描，并处理信息转换
- 需要注意的是我们下面这个对象日期格式转换器并没有处理java.util.Date类型和其JSON格式之间的转换，如果没有声明日期格式转换类型的话，我们java.util.Date日期类型默认序列化成的JSON字符串为时间戳数字
  - 所以如果我们需要用java.util.Date去处理我们的日期数据，我们可以使用@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone="GMT+8")，来指明java.util.Date日期的转换形式