Spring Boot中如何在jsonArray为空数组时排除"productBasedOffer"键值对?
避免输出空数组
productBasedOffer字段的实现方案 问题梳理
- 现有开发场景:基于Spring Boot框架开发商品列表接口,组装JSON时先执行
jsonArray.put(jsonObject)写入offer对象,再通过非空判断控制productBasedOffer字段的写入。 - 非空场景下
productBasedOffer的正常结构为包含优惠详情的对象数组,示例:
"productBasedOffer": [ { "offerKeyword": "null", "minAmount": "0.0", "offerType": "PRODUCT_BASED", "amount": "50.0", "offerId": "27", "freeProductId": "0", "endTime": "1613757599000", "offerCategory": "FIXED" } ]
- 现存问题:最终序列化结果中仍然会输出空数组形式的
productBasedOffer字段,示例:
"productBasedOffer": []
- 核心目标:当
jsonArray为空数组时,完全跳过productBasedOffer键值对的输出,不将该字段纳入最终JSON结果。
具体实现方案
1. 修正组装环节的逻辑漏洞
原有非空判断写法存在两个容易忽略的问题:
- 可能存在在if判断外提前写入
productBasedOffer字段的操作,导致空数组被提前塞进JSON对象 - 错误地将外层商品对象加入列表的操作放在了非空判断分支内,会导致空数组场景下整个商品对象被遗漏,无法正常输出
修正后的正确逻辑:仅将productBasedOffer字段的写入操作放在非空判断分支内,外层商品对象无论是否携带offer字段,都正常加入商品列表。
修正后的代码参考:
// 组装offer对象并写入数组 JSONArray jsonArray = new JSONArray(); // ... 单个offer对象的组装逻辑 jsonArray.put(jsonObject); // 仅当数组非空时,才写入对应字段,否则完全不添加这个键值对 if (!jsonArray.isEmpty()) { shopProductJsonObject.put("productBasedOffer", jsonArray); } // 无论是否有offer字段,商品对象都正常加入输出列表 shopProductListJsonArray.put(shopProductJsonObject);
2. 通过Spring Boot默认序列化配置兜底
Spring Boot默认使用Jackson完成JSON序列化,可通过全局配置自动过滤空值、空数组类字段,从序列化环节兜底避免空字段输出,无需在每个组装节点手动判空。
在application.yml中加入配置:
spring: jackson: # 序列化时自动跳过null、空字符串、空数组、空集合类型的字段 default-property-inclusion: non_empty
配置生效后,所有值为空数组、null、空字符串的字段都会被自动排除在序列化结果之外,从根源上避免输出productBasedOffer: []这类无效结构。
3. 自定义JSON组件的适配规则
如果项目中使用fastjson等非默认JSON组件完成序列化,可在序列化环节加入对应过滤规则,跳过空集合、null值字段的输出:
// 序列化时自动跳过默认值(空数组、null、空字符串)字段 String finalJson = JSON.toJSONString(shopProductListJsonArray, SerializerFeature.NotWriteDefaultValue );
内容的提问来源于stack exchange,提问作者user10767069
相关产品推荐
相关产品推荐

