基于@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这个注解已经被弃用了~

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

相关文章

  • Spring Boot无缝集成MongoDB

    Spring Boot无缝集成MongoDB

    这篇文章主要介绍了Spring Boot无缝集成MongoDB的相关知识,本文涉及到MongoDB的概念和nosql的应用场景,需要的朋友可以参考下
    2017-04-04
  • java实现模拟RPG格斗

    java实现模拟RPG格斗

    这篇文章主要介绍了java实现模拟RPG格斗,每个英雄具有以下几个属性:生命值(为0时英雄倒下)、攻击力(每次攻击时扣除对方的生命值点数)、攻击间隔(每次攻击过后都要等待间隔时间才能进行下次攻击首次攻击之前也要先等待间隔时间)简单设置了下吧,小伙伴可以参考下
    2015-03-03
  • java集合中list的用法代码示例

    java集合中list的用法代码示例

    这篇文章主要介绍了java集合中list的用法代码示例,分享了相关代码,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • Elasticsearch Analyzer 内置分词器使用示例详解

    Elasticsearch Analyzer 内置分词器使用示例详解

    这篇文章主要为大家介绍了Elasticsearch Analyzer 内置分词器使用示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-11-11
  • 浅析JVM的垃圾回收器

    浅析JVM的垃圾回收器

    这篇文章主要介绍了JVM垃圾回收器的相关资料,帮助大家更好的理解和学习Java虚拟机的相关知识,感兴趣的朋友可以了解下
    2020-11-11
  • 详解JUC 常用4大并发工具类

    详解JUC 常用4大并发工具类

    这篇文章主要介绍了JUC 常用4大并发工具类的相关资料,帮助大家更好的理解和学习Java 并发编程,感兴趣的朋友可以了解下
    2020-10-10
  • java设计模式之观察者模式

    java设计模式之观察者模式

    这篇文章主要为大家详细介绍了java设计模式之观察者模式的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • 如何使用Java将word解析出来(包含格式和图片)

    如何使用Java将word解析出来(包含格式和图片)

    今天遇到一个读取word模板内容的需求,下面这篇文章主要给大家介绍了关于如何使用Java将word解析出来,包含格式和图片,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2023-12-12
  • java Object的hashCode方法的计算逻辑分析

    java Object的hashCode方法的计算逻辑分析

    这篇文章主要介绍了java Object的hashCode方法的计算逻辑分析,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • SpringBoot整合Mail发送邮件功能

    SpringBoot整合Mail发送邮件功能

    我们在网站上注册账号的时候一般需要获取验证码,而这个验证码一般发送在你的手机号上还有的是发送在你的邮箱中,注册,账号密码…都需要用到验证,今天就演示一下如何用SpringBoot整合Mail发送邮箱
    2021-11-11

最新评论