java 去除Json中null和空字符串节点

原创

mob64ca12d36217 2024-09-09 04:47:31 ©著作权

©著作权归作者所有：来自51CTO博客作者mob64ca12d36217的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java 去除 JSON 中 null 和空字符串节点的实现指南

在当今开发中，JSON（JavaScript Object Notation）是一种广泛使用的数据格式。处理JSON数据时，我们常常会遇到需要去除其中的null和空字符串节点的情况。本文将介绍如何使用Java实现这一功能。

我们将整个过程分为以下几个步骤：

步骤	任务	描述
1	创建 JSON 对象	使用库如 Jackson 或 Gson 创建 JSON 对象
2	遍历 JSON 节点	遍历 JSON 中的每一个节点
3	过滤节点	判断节点值是否为 null 或空字符串
4	构建新的 JSON 对象	将过滤后的节点重新构建成新的 JSON 对象
5	输出结果	输出最终的 JSON 结果

步骤详解

1. 创建 JSON 对象

我们使用常用的 Jackson 库来处理 JSON。首先，我们需要添加 Jackson 的依赖（在 Maven 的 pom.xml 文件中）：

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

2. 遍历 JSON 节点

接下来，我们定义一个方法 cleanJson，在这个方法中，我们将通过 Jackson 的 ObjectMapper 来读取 JSON 字符串并将其转换为 Map 对象。

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.util.Iterator;
import java.util.Map;

public class JsonCleaner {
    public static void main(String[] args) {
        String jsonString = "{\"name\":null, \"age\":25, \"address\":\"\", \"email\":\"test@example.com\"}";

        try {
            ObjectMapper objectMapper = new ObjectMapper();
            JsonNode rootNode = objectMapper.readTree(jsonString);
            JsonNode cleanedNode = cleanJson(rootNode);
            System.out.println("清理后的 JSON: " + objectMapper.writeValueAsString(cleanedNode));
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
    }
}

3. 过滤节点

我们接下来实现 cleanJson 方法。在这个方法中，我们将遍历 JSON 节点，并按照条件过滤掉 null 和空字符串。

private static JsonNode cleanJson(JsonNode node) {
    ObjectMapper objectMapper = new ObjectMapper();
    JsonNode newNode = objectMapper.createObjectNode();

    if (node.isObject()) {
        Iterator<Map.Entry<String, JsonNode>> fields = node.fields();
        while (fields.hasNext()) {
            Map.Entry<String, JsonNode> entry = fields.next();
            if (!entry.getValue().isNull() && !entry.getValue().asText().isEmpty()) {
                // 将非空和非null的节点添加到新的对象中
                ((ObjectNode) newNode).set(entry.getKey(), entry.getValue());
            }
        }
    }
    return newNode;
}

4. 构建新的 JSON 对象

在上面的代码中，我们使用了 ObjectMapper.createObjectNode() 方法创建新的 JSON 对象，并将非 null 和非空字符串的节点添加到新对象中。

5. 输出结果

最后，我们将清理后的 JSON 输出。可以用 objectMapper.writeValueAsString(cleanedNode) 来将 JsonNode 转换为字符串并打印出来。

序列图

下面是序列图，展示了 JSON 清理过程中的各个主要步骤：

sequenceDiagram
    participant User
    participant JsonCleaner
    participant ObjectMapper

    User->>JsonCleaner: 提供 JSON 字符串
    JsonCleaner->>ObjectMapper: 解析 JSON 字符串
    ObjectMapper->>JsonCleaner: 返回 JsonNode 对象
    JsonCleaner->>JsonCleaner: 清理 JSON 节点
    JsonCleaner->>ObjectMapper: 生成新的 JSON 字符串
    ObjectMapper->>JsonCleaner: 返回 JSON 字符串
    JsonCleaner->>User: 输出 JSON 字符串

甘特图

以下是甘特图，展示了整个流程的处理时间段：

gantt
    title JSON 清理任务流程
    dateFormat  YYYY-MM-DD
    section 任务
    创建 JSON 对象         :a1, 2023-10-01, 1d
    遍历 JSON 节点         :after a1  , 1d
    过滤节点               :after a1  , 1d
    构建新的 JSON 对象    :after a1  , 1d
    输出结果               :after a1  , 1d