文章详情

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

请输入下面的图形验证码

提交验证

短信预约提醒成功

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

2024-04-02 19:55

关注

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

以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程网。

阅读原文内容投诉

免责声明:

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

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

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯