java后端返回给前端对象时去除值为空或NULL的属性

ゞ浴缸里的玫瑰 2024-04-01 18:55 84阅读 0赞

### 前言 ###

测试接口时发现当返回的对象中属性值为 **“”** 或 **\[\]** 或 **null** 时，该属性依然会返回，这样数据看起来很不美观并且有时候也会导致前端组件出现一些小的bug。  
![在这里插入图片描述][46c05998af6f4250be3786cbe2e3f8c8.png]

例如这个下拉框，人事科下面是没有部门的，但是由于接口返回了 **children** 为空，导致后面多出一个空页面。  
![在这里插入图片描述][471c430a59084fc192b90ae1dadf6c4c.png]

### 解决 ###

##### 1、引入pom依赖 #####

<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、使用 @JsonInclude 注解 #####

只需要在实体类中的属性上面加上 **@JsonInclude(JsonInclude.Include.NON\_EMPTY)** 即可如下。

**注意**：  
1、 **departmentCode** 属性为 **String** 类型，**String** 的默认值为 **null**，所以注解里面要使用 **JsonInclude.Include.NON\_NULL**。  
2、**children** 属性为 **List** 类型，**List** 的默认值为 **空** 或 **\[\]** ，所以注解里面要使用 **JsonInclude.Include.NON\_EMPTY** 。

（另外还提供有 **NON\_ABSENT** ，**NON\_DEFAULT** 等可自行研究）  
![在这里插入图片描述][a4699fa7f0b147f3940456d8c91e93b2.png]

### 测试 ###

接口效果  
![在这里插入图片描述][2165182ededd4e26bc9f22a944313761.png]

前端页面效果  
![在这里插入图片描述][a569d1ebf1f94ce69ae53ce9885ce8c1.png]

[46c05998af6f4250be3786cbe2e3f8c8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/076bcc8ba286458cb6a65e8f36733316.png
[471c430a59084fc192b90ae1dadf6c4c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/fff7e01712cf4da1a33f2ccb8f241da6.png
[a4699fa7f0b147f3940456d8c91e93b2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/1dff2df16e624d2a946d540cdd4f6578.png
[2165182ededd4e26bc9f22a944313761.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/aad682e76442418da21323692b3af1d7.png
[a569d1ebf1f94ce69ae53ce9885ce8c1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/8aa1fcaf2933490ab4cb7bb03540943f.png