java后端返回数据给前端时去除值为空或NULL的属性、忽略某些属性代码示例

更新时间：2024年07月15日 11:09:13 作者：姚舜禹_12140

在Java开发中我们处理JSON数据时经常会遇到空值(null)的情况,这篇文章主要给大家介绍了关于java后端返回数据给前端时去除值为空或NULL的属性、忽略某些属性的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下

一、使用场景

在开发过程中，有时候需要将后端数据返回前端，此时有些数据为空属性不需要返回，或者有些属性不需要返回，因此就需要处理。

二、环境准备

1、引入依赖

		<dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.10.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.10.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.10.0</version>
        </dependency>

2、实体类

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Student{
    private Integer id;
    private String name;
    private Integer age;
    private String address;

    private BigDecimal score;

    private String className;

    private List<String> subjectList = new ArrayList<>();
}

三、示例

1、不返回空值

(1)方式

在实体类上面加上下面的注解：

@JsonInclude(JsonInclude.Include.NON_EMPTY)

(2)测试

Controller里面的方法：

    @PostMapping("/getData")
    public R getData(){
        Student student = new Student();
        student.setName("Tom");
        student.setAge(22);
        return R.ok().data("student", student);
    }

测试结果：

(3)说明

如果要对部分属性进行空值限制，分为两类：

字符串、基本数据类型的设置，使用JsonInclude.Include.NON_NULL
对象、数组之类的设置，使用JsonInclude.Include.NON_EMPTY

import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Student{
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private Integer id;

    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String name;

    @JsonInclude(JsonInclude.Include.NON_NULL)
    private Integer age;

    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String address;

    @JsonInclude(JsonInclude.Include.NON_NULL)
    private BigDecimal score;

    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String className;

    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    private List<String> subjectList = new ArrayList<>();

}

2、不返回部分属性

(1)方式

实体类属性上使用注解：

@JsonIgnore

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

@Data
@NoArgsConstructor
@AllArgsConstructor
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class Student {
    private Integer id;
    private String name;
    private Integer age;
    @JsonIgnore
    private String address;

    private BigDecimal score;

    private String className;

    private List<String> subjectList = new ArrayList<>();
}

(2)测试

Controller里面的方法：

    @PostMapping("/getData")
    public R getData(){
        Student student = new Student();
        student.setId(1001);
        student.setName("Tom");
        student.setAge(22);
        student.setAddress("浙江");
        return R.ok().data("student", student);
    }

测试结果：

四、 Jackson常用注解

1、 @JsonProperty

此注解用于属性上，作用是把该属性的名称序列化为另外一个名称，如把testPwd属性序列化为pwd，@JsonProperty(value="pwd")。

2、@JsonPropertyOrder

作用在类上，被用来指明当序列化时需要对属性做排序，它有2个属性一个是alphabetic：布尔类型，表示是否采用字母拼音顺序排序，默认是为false，即不排序。如@JsonPropertyOrder(alphabetic=true)。

3、@JsonInclude

是用在实体类的方法类的头上作用是实体类的参数查询到的为null的不显示，比如说你想传一些json数据到前台，但是不想传值为null的数据，就可以使用该标签。如@JsonInclude(JsonInclude.Include.NON_NULL)

4、@JsonIgnoreProperties

可以注明是想要忽略的属性列表如@JsonIgnoreProperties({"name","age","title"})，也可以注明过滤掉未知的属性如@JsonIgnoreProperties(ignoreUnknown=true),@JsonIgnore表示忽略当前属性。

5、@JsonFormat

用在属性和方法上，可以方便的进行格式转换，如把Date转换为我们要的模式@JsonFormat(pattern = "yyyy-MM-dd HH-mm-ss")。

6、@JsonUnwrapped

当实体类中成员属性是一个类的对象时候，忽略包装。直接显示属性。

总结

到此这篇关于java后端返回数据给前端时去除值为空或NULL的属性、忽略某些属性的文章就介绍到这了,更多相关java后端返回数据去除空值或NULL内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

解决Tomcat启动报异常java.lang.ClassNotFoundException问题
这篇文章主要介绍了解决Tomcat启动报异常java.lang.ClassNotFoundException问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-01-01
JavaEE之SpringBoot配置文件的使用及说明
本文主要介绍了Spring Boot中配置文件的使用,包括application.properties和application.yml两种格式的配置文件的语法、读取方式以及优缺点,同时,还通过一个验证码案例练习,展示了如何使用Spring Boot和hutool工具类包实现验证码功能
2026-01-01
Java线程池ForkJoinPool实例解析
这篇文章主要介绍了Java线程池ForkJoinPool实例解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-02-02
Spring Security 自定义授权服务器实践记录
授权服务器（Authorization Server）目前并没有集成在Spring Security项目中，而是作为独立项目存在于Spring生态中，这篇文章主要介绍了Spring Security 自定义授权服务器实践,需要的朋友可以参考下
2022-08-08
Java创建随机数的四种方式总结
这篇文章主要介绍了java的四种随机数生成方式的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，,需要的朋友可以参考下
2022-07-07
Java 中的语法糖,真甜
语法糖（Syntactic sugar），也叫做糖衣语法，是英国科学家发明的一个术语，通常来说使用语法糖能够增加程序的可读性，从而减少程序代码出错的机会.这篇文章主要介绍了Java 中的语法糖知识，需要的朋友可以参考下
2020-12-12
Java基础之FastJson详解
今天给大家复习Java基础FastJson,文中有非常详细的代码示例,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
2021-05-05
IDEA中服务太多内存不足闪退的解决过程
本文介绍了使用idea工具启动微服务时,因服务过多导致内存不足闪退的问题及解决方法,需为每个服务分配合适的内存,并注意避免服务因内存不足而无法启动的状况
2026-04-04
Java删除String中指定字符的11种方法汇总
这篇文章主要给大家介绍了关于Java删除String中指定字符的11种方法,在Java中String类提供了许多方法来处理字符串,其中包括删除指定字符的方法,文中通过代码介绍的非常详细,需要的朋友可以参考下
2023-11-11
Spring Boot开发中加密数据的模糊搜索解决方案详解
在SpringBoot中实现加密手机号的模糊搜索,需在数据安全、业务功能和系统性能之间进行权衡,简单解密后查询方案仅适用于极小规模应用,本文介绍Spring Boot开发中加密数据的模糊搜索解决方案,感兴趣的朋友跟随小编一起看看吧
2025-12-12