基于@JsonSerialize和@JsonInclude注解使用方法

 更新时间:2021年10月13日 15:27:56   作者:Jesslili  
这篇文章主要介绍了@JsonSerialize和@JsonInclude注解使用方法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

@JsonSerialize和@JsonInclude注解

@JsonSerialize

后端开发时返回给前端的数据格式有时可能并不符合。

举个例子,比如一张表中的时间,数据库中存储的是yyy-mm-dd hh:mm:ss 这样的形式,而前段需要的是精确到秒的格式,这是就会出现问题。此时可以利用@JsonSerialize注解,改变返回给前端的json格式

@JsonSerialize注解,主要用于数据转换,该注解作用在该属性的getter()方法上。

使用步骤

1. 指定一个格式化的类

里面写好规则

//JsonSerializer<Integer>:Integer为要转换的类型
public class MySerializerUtils extends JsonSerializer<Integer> {
    @Override
    public void serialize(Integer status, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
        String statusStr = "";
        switch (status) {
            case 0:
                statusStr = "暂存";
                break;
            case 1:
                statusStr = "待上报";
                break;
            case 2:
                statusStr = "待审核";
                break;
            case 3:
                statusStr = "已审";
                break;
            case 4:
                statusStr = "退回";
                break;
            case -1:
                statusStr = "已删";
                break;
            default:
                statusStr = "状态信息不符合";
        }
        jsonGenerator.writeString(statusStr);
    }
}

//JsonSerializer<Date>:Date为要转换的类型
public class Date2LongSerializer extends JsonSerializer<Date> {
    @Override
    public void serialize(Date date, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
       jsonGenerator.writeNumber(date.getTime() / 1000);
    }
}

2. 在实体类中在要转换的字段上加上该注解

@JsonSerialize(using = MySerializerUtils.class)
private int status;

//创建时间
@JsonSerialize(using = Date2LongSerializer.class)
private Date creatTime;
//更新时间
@JsonSerialize(using = Date2LongSerializer.class)
private Date updateTime;

@JsonInclude

返回前端的实体类中如果某个字段为空的话那么就不返回这个字段了

所以将@JsonInclude(Include.NON_NULL) 这个注解放在类头上就可以解决。 实体类与json互转的时候属性值为 null 的不参与序列化

JsonJsonInclude.Include.ALWAYS这个是默认策略,任何情况下都序列化该字段,和不写这个注解是一样的效果。

@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class OrderDTO {
    private String orderId;
    private String buyerName;
    private String buyerPhone;
    private String buyerAddress;    
    private String buyerOpenid;
    List<OrderDetail> orderDetailList;//null,不返回
}

如果多个类都需要不返回null,挨个加注释太麻烦了,可以全局设置,更改配置文件application.yml

spring:
  jackson:
    default-property-inclusion: non_null

如果List<OrderDetail> orderDetailList;需要返回一个空的list,但不能返回null,可以直接初始化

List<OrderDetail> orderDetailList = new ArrayList<>();

在这里插入图片描述

同样若要返回空字符而不是null,初始化

private String msr = "";
private String data;

在这里插入图片描述

JSON @JsonSerialize 弃用问题解决方案

@JsonSerialize弃用spring boot中,返回json默认是包含空串的,如果我们不想让json返回null值,可以在bean上添加一些注解。

@JsonInclude(JsonInclude.Include.NON_EMPTY)​​

后面的枚举值可以为

ALWAYS,
NON_NULL, // 属性为NULL 不序列化,就是为null的字段不参加序列化    
NON_ABSENT, // 属性为默认值不序列化
NON_EMPTY, // 属性为 空("") 或者为 NULL 都不序列化,则返回的json是没有这个字段的。这样对移动端会更省流量
NON_DEFAULT,
CUSTOM,
USE_DEFAULTS;

调用

@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class MsgBean {}

Ps:好多资料上说的@JsonSerialize这个注解已经被弃用了~

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 聊一聊Java的JVM类加载机制

    聊一聊Java的JVM类加载机制

    这篇文章主要介绍了聊一聊Java的JVM类加载机制,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-04-04
  • SpringBoot解决跨域问题的五种方案

    SpringBoot解决跨域问题的五种方案

    跨域问题指的是不同站点之间,使用 ajax 无法相互调用的问题,跨域问题本质是浏览器的一种保护机制,它的初衷是为了保证用户的安全,防止恶意网站窃取数据,那怎么解决这个问题呢?接下来我们一起来看,需要的朋友可以参考下
    2024-07-07
  • java语言求解兔子问题代码分析

    java语言求解兔子问题代码分析

    这篇文章主要介绍了Java语言求解兔子问题代码分析,具有一定借鉴价值,需要的朋友可以了解下。
    2017-12-12
  • 从java源码分析线程池(池化技术)的实现原理

    从java源码分析线程池(池化技术)的实现原理

    这篇文章主要介绍了从java源码分析线程池(池化技术)的实现原理,池化技术是一种编程技巧,当程序出现高并发时,能够明显的优化程序,降低系统频繁创建销毁连接等额外开销,下文更多的相关介绍需要的小伙伴可以参考一下
    2022-04-04
  • 深入理解Java 线程通信

    深入理解Java 线程通信

    这篇文章主要介绍了Java 线程通信的的相关资料,文中讲解非常细致,代码帮助大家更好的理解和学习,感兴趣的朋友可以了解下
    2020-06-06
  • 基于springboot i18n国际化后台多种语言设置的方式

    基于springboot i18n国际化后台多种语言设置的方式

    这篇文章主要介绍了基于springboot i18n国际化后台多种语言设置的方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • Java工具之ja-netfilter 2022.1 配置教程

    Java工具之ja-netfilter 2022.1 配置教程

    这篇文章主要介绍了Java工具之ja-netfilter 2022.1 配置教程,本防火墙基于javaagent,所以目前只有基于java的程序能够使用,需要的朋友可以参考下
    2022-04-04
  • 详解Java5、Java6、Java7的新特性

    详解Java5、Java6、Java7的新特性

    本编文章详细介绍了Java5、Java6、Java7的新特性,需要的朋友可以参考下
    2017-04-04
  • java数据结构基础:线性表

    java数据结构基础:线性表

    这篇文章主要介绍了Java的数据解构基础,希望对广大的程序爱好者有所帮助,同时祝大家有一个好成绩,需要的朋友可以参考下,希望能给你带来帮助
    2021-07-07
  • Mybatis事务如何跟Spring结合(数据库事务特性和Spring事务管理源码)

    Mybatis事务如何跟Spring结合(数据库事务特性和Spring事务管理源码)

    MyBatis与Spring的事务结合主要是通过Spring的事务管理和MyBatis的数据库操作来实现的,在本文中,我们将从数据库事务特性和Spring事务管理源码两个角度来分析MyBatis事务如何与Spring结合到一起的原理,感兴趣的朋友一起看看吧
    2024-01-01

最新评论