我的编程空间,编程开发者的网络收藏夹
学习永远不晚

一文了解Jackson注解@JsonFormat及失效解决

短信预约 -IT技能 免费直播动态提醒
省份

北京

  • 北京
  • 上海
  • 天津
  • 重庆
  • 河北
  • 山东
  • 辽宁
  • 黑龙江
  • 吉林
  • 甘肃
  • 青海
  • 河南
  • 江苏
  • 湖北
  • 湖南
  • 江西
  • 浙江
  • 广东
  • 云南
  • 福建
  • 海南
  • 山西
  • 四川
  • 陕西
  • 贵州
  • 安徽
  • 广西
  • 内蒙
  • 西藏
  • 新疆
  • 宁夏
  • 兵团
手机号立即预约

请填写图片验证码后获取短信验证码

看不清楚,换张图片

免费获取短信验证码

一文了解Jackson注解@JsonFormat及失效解决

背景

项目中使用WRITE_DATES_AS_TIMESTAMPS: true转换日期格式为时间戳未生效。如下:

spring:  jackson:    time-zone: Asia/Shanghai    serialization:      WRITE_DATES_AS_TIMESTAMPS: true

尝试是否关于时间的注解是否会生效,使用@JsonForma@JsonFiled均失效。

常见失效原因及解决方法

@JsonFormat是用于指定Java对象序列化为JSON字符串时的格式化方式的注解。如果@JsonFormat失效,可能是以下原因:

  1. 未正确导入Jackson库
  2. 注解位置不正确
  3. 注解参数设置错误

解决方法:

  1. 确认是否正确导入了Jackson库,可以在pom.xml文件中添加以下依赖:
<dependency>    <groupId>com.fasterxml.jackson.coregroupId>    <artifactId>jackson-databindartifactId>    <version>2.12.3version>dependency>

确认注解位置是否正确,例如:

public class User {    @JsonFormat(pattern = "yyyy-MM-dd")    private Date birthday;    // ...}

确认注解参数是否正确设置,例如:

@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSSZ")public Date getCreatedDate() {    return createdDate;}

以上是常见的解决方法,如果还有问题可以提供更具体的错误信息进行排查。

本次问题解决

失效原因

因为项目中使用了Gson替换Jackson。
代码如下:

import com.google.gson.JsonElement;import com.google.gson.JsonParser;import com.google.gson.JsonSerializationContext;import com.google.gson.JsonSerializer;import springfox.documentation.spring.web.json.Json;import java.lang.reflect.Type;public class JsonToGson implements JsonSerializer<Json> {    @Override    public JsonElement serialize(Json json, Type type, JsonSerializationContext context) {        return JsonParser.parseString(json.value());    }}
@Configurationpublic class SwaggerWebConfiguration implements WebMvcConfigurer {    @Override    public void addResourceHandlers(ResourceHandlerRegistry registry) {        registry.addResourceHandler("/swagger-ui/**")                .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/");    }    @Override    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {        converters.removeIf(httpMessageConverter -> httpMessageConverter instanceof MappingJackson2HttpMessageConverter);        converters.add(gsonHttpMessageConverters());    }    @Bean    public GsonHttpMessageConverter gsonHttpMessageConverters() {        Gson gson = new GsonBuilder()                .registerTypeAdapter(Json.class, new SpringfoxJsonToGsonAdapter())                .create();        GsonHttpMessageConverter gsonConverter = new GsonHttpMessageConverter(gson);        return gsonConverter;    }}

解决方案一:去掉Gson转换即可。

解决方案二:重新添加MappingJackson2HttpMessageConverter的bean

@Autowired(required = false)private MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter;@Overridepublic void extendMessageConverters(List<HttpMessageConverter<?>> converters) {    converters.removeIf(converter -> converter instanceof MappingJackson2HttpMessageConverter);    if (Objects.isNull(mappingJackson2HttpMessageConverter)) {        converters.add(0, new MappingJackson2HttpMessageConverter());    } else {        converters.add(0, mappingJackson2HttpMessageConverter);    }}

@Autowired(required = false)private MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter;@Overridepublic void configureMessageConverters(List<HttpMessageConverter<?>> converters) {    converters.removeIf(converter -> converter instanceof MappingJackson2HttpMessageConverter);    if (Objects.isNull(mappingJackson2HttpMessageConverter)) {        converters.add(0, new MappingJackson2HttpMessageConverter());    } else {        converters.add(0, mappingJackson2HttpMessageConverter);    }}

解析

Jackson一直是springframework默认的json库,从4.1开始,springframework支持通过配置GsonHttpMessageConverter的方式使用Gson。

Spring MVC中,一旦请求退出@Controller,它将寻找一个视图来呈现。当指定了@RequestBody@RestController时,我们会告诉Spring跳过这一步,将java对象通过model写入响应结果。Spring通过HttpMessageConverter来执行Java对象向其它类型(通常是Json)的转换,Spring默认使用的是 MappingJackson2HttpMessageConverter,所以如果希望使用Gson来执行这种转换,可用使用GsonHttpMessageConverter替换Jackson

小拓展

在Spring Boot提供了与三个JSON映射库的集成:Gson、默认库 Jackson 、JSON-B

@JsonFormat与@JSONField简介

@JsonFormat

@JsonFormat是Java中的一个Jackson注解,用于指定某个字段或属性,或整个类的JSON序列化或反序列化格式。它允许在将数据类型转换为或从JSON格式转换时自定义日期、数字、布尔值等数据类型的格式。

例如,如果您有一个Java类,其中包含一个Date字段,您希望以特定格式将其序列化为JSON,您可以使用@JsonFormat注解来指定该格式:

示例如下:Jackson在序列化或反序列化myDate字段时使用“yyyy-MM-dd”格式。

public class MyClass {  @JsonFormat(pattern="yyyy-MM-dd")  private Date myDate;  // ...}

@JSONField

@JSONField是阿里巴巴的fastjson库中的一个注解,用于指定Java对象属性在序列化为JSON字符串时的名称、顺序、格式等信息。例如,可以使用@JSONField(name=“username”)指定Java对象属性在序列化为JSON字符串时使用"username"作为属性名。

区别

@JsonFormat和@JSONField都是用于控制Java对象属性在序列化为JSON字符串时的格式,但是它们有一些不同之处。

@JsonFormat是Jackson库中的一个注解,用于指定Java对象属性在序列化为JSON字符串时的日期、时间、数字等格式。例如,可以使用@JsonFormat(pattern=“yyyy-MM-dd HH:mm:ss”)指定Java对象属性在序列化为JSON字符串时使用指定的日期时间格式。

@JSONField是阿里巴巴的fastjson库中的一个注解,用于指定Java对象属性在序列化为JSON字符串时的名称、顺序、格式等信息。例如,可以使用@JSONField(name=“username”)指定Java对象属性在序列化为JSON字符串时使用"username"作为属性名。

因此,虽然@JsonFormat和@JSONField都可以用于控制Java对象属性在序列化为JSON字符串时的格式,但是它们的作用范围和使用方式略有不同。

jackson自定义日期注解

依赖HttpMessageConverter默认实现如下:

jackson:MappingJackson2HttpMessageConverter;

请添加图片描述

gson:GsonHttpMessageConverter;

请添加图片描述

fastjson : FastJsonHttpMessageConverter

1、自定义转换类:

public class DateToJsonSerializer extends JsonSerializer<Date> implements ContextualSerializer {    private DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");    public DateToJsonSerializer() {    }    @Override    public void serialize(Date arg0, JsonGenerator arg1, SerializerProvider arg2) throws IOException {        if (null != arg0) {            arg1.writeString(this.df.format(arg0));        }    }    @Override    public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property)   {        AnnotationMap annotated = property.getMember().getAllAnnotations();        JsonFormat jsonFormat = annotated.get(JsonFormat.class);        if (jsonFormat != null && jsonFormat.pattern() != null){            df = new SimpleDateFormat(jsonFormat.pattern());        }        return this;    }}

2、使用

public class MyClass {  @JsonSerialize(using = DateToJsonSerializer .class)  private Date myDate;  // ...}

在这里插入图片描述

翩若惊鸿,婉若游龙。

来源地址:https://blog.csdn.net/qq_35764295/article/details/129718739

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

一文了解Jackson注解@JsonFormat及失效解决

下载Word文档到电脑,方便收藏和打印~

下载Word文档

猜你喜欢

springboot2中使用@JsonFormat注解不生效怎么解决

这篇“springboot2中使用@JsonFormat注解不生效怎么解决”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“sp
2023-06-29

事务注解@Transactional失效的场景及解决办法

本篇内容主要讲解“事务注解@Transactional失效的场景及解决办法”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“事务注解@Transactional失效的场景及解决办法”吧!Transa
2023-06-15

如何解决spring boot项目使用@JsonFormat失效问题

这篇文章给大家分享的是有关如何解决spring boot项目使用@JsonFormat失效问题的内容。小编觉得挺实用的,因此分享给大家做个参考,一起跟随小编过来看看吧。使用@JsonFormat失效在实体类定义时间格式原因:项目中配置了fa
2023-06-25

spring注解事务失效如何解决

在Spring中,如果注解式事务失效,可能有以下几个原因:1. 没有配置事务管理器:在Spring中,必须配置一个事务管理器来管理事务。如果没有配置事务管理器,注解式事务将无法生效。可以通过在Spring配置文件中添加如下内容来配置一个事务
2023-09-28

@CacheEvict注解失效的经历及解决方法是什么

@CacheEvict注解失效的经历及解决方法是什么,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。排查@CacheEvict注解失效我简单看了一下《Spring
2023-06-22

spring事务注解失效怎么解决

如果在使用Spring事务注解时遇到失效的情况,可以尝试以下解决方法:1. 确保在Spring配置文件中配置了事务管理器(如DataSourceTransactionManager)和@EnableTransactionManagement
2023-09-13

vue中@keyup.enter失效问题及解决

这篇文章主要介绍了vue中@keyup.enter失效问题及解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
2022-11-13

编程热搜

  • Python 学习之路 - Python
    一、安装Python34Windows在Python官网(https://www.python.org/downloads/)下载安装包并安装。Python的默认安装路径是:C:\Python34配置环境变量:【右键计算机】--》【属性】-
    Python 学习之路 - Python
  • chatgpt的中文全称是什么
    chatgpt的中文全称是生成型预训练变换模型。ChatGPT是什么ChatGPT是美国人工智能研究实验室OpenAI开发的一种全新聊天机器人模型,它能够通过学习和理解人类的语言来进行对话,还能根据聊天的上下文进行互动,并协助人类完成一系列
    chatgpt的中文全称是什么
  • C/C++中extern函数使用详解
  • C/C++可变参数的使用
    可变参数的使用方法远远不止以下几种,不过在C,C++中使用可变参数时要小心,在使用printf()等函数时传入的参数个数一定不能比前面的格式化字符串中的’%’符号个数少,否则会产生访问越界,运气不好的话还会导致程序崩溃
    C/C++可变参数的使用
  • css样式文件该放在哪里
  • php中数组下标必须是连续的吗
  • Python 3 教程
    Python 3 教程 Python 的 3.0 版本,常被称为 Python 3000,或简称 Py3k。相对于 Python 的早期版本,这是一个较大的升级。为了不带入过多的累赘,Python 3.0 在设计的时候没有考虑向下兼容。 Python
    Python 3 教程
  • Python pip包管理
    一、前言    在Python中, 安装第三方模块是通过 setuptools 这个工具完成的。 Python有两个封装了 setuptools的包管理工具: easy_install  和  pip , 目前官方推荐使用 pip。    
    Python pip包管理
  • ubuntu如何重新编译内核
  • 改善Java代码之慎用java动态编译

目录