实体类或对象序列化时,忽略为空属性的操作

时间：2022-11-06 09:07:20

第一种，在配置文件配置

在application.xml直接配置，这种方式是全局配置，所有返回给前端对象的属性为null或""都不进行序列化；

?
1
2
3
4
spring:
  jackson:
    #实体类转json时字段为null不参与序列化
    default-property-inclusion: NON_EMPTY

default-property-inclusion 常用的4种类型

  • ALWAYS 默认
  • NON_DEFAULT 属性为默认值不序列化
  • NON_EMPTY 属性为 “” 或者为NULL都不序列化
  • NON_NULL 属性为NULL时不序列化

第二种，给每个类单独设置

给为空时需要忽略序列化的对象属性加 @JsonInclude(Include.NON_NULL)，也可以直接加到类上，表示一整个对象的属性为null时都不参与序列化；

@JsonInclude 括号里面可以设置不同的类型

  • Include.Include.ALWAYS 默认
  • Include.NON_DEFAULT 属性为默认值不序列化
  • Include.NON_EMPTY 属性为 “” 或者为NULL都不序列化
  • Include.NON_NULL 属性为NULL时不序列化

如果配置了全局，又给某个对象进行注解方式的设置，注解方式会覆盖全局的设置。

SpringBoot2.x 不反回空值属性

由于有的时候我们返回的数据中存在属性没有值得情况，或者是属性的值为空白字符串，这会浪费网络流量，又或者是前端框架存在的bug会导致null值或者是空白字符串在渲染的时候会报错。

处理方式

第一种

全局的方式：在SpringBoot的配置文件中添加以下属性，即可达到全局过滤

?
1
spring.jackson.default-property-inclusion=non_empty

第二种

局部的方式：在返回的实体类属性或者是类名上添加以下注解，即可达到过滤效果

?
1
@JsonInclude(JsonInclude.Include.NON_EMPTY)

注意

这种方式对于空集合也是成立的。属性一共有如下值可选

  • Include.Include.ALWAYS 默认
  • Include.NON_DEFAULT 属性为默认值不序列化
  • Include.NON_EMPTY 属性为 空（“”） 或者为 NULL 都不序列化
  • Include.NON_NULL 属性为NULL 不序列化

以上为个人经验，希望能给大家一个参考，也希望大家多多支持服务器之家。

原文链接：https://blog.csdn.net/qq_33732195/article/details/106271216

标签：

相关文章