知識庫 / JSON / Jackson RSS 訂閱

1. 引言

Jackson 庫是用於在 Java 應用程序中處理 JSON（JavaScript 對象標記）的強大工具。 此外，它還提供廣泛的功能，用於高效地讀取、寫入和操作 JSON 數據。 因此，處理 JSON 時，刪除特定元素是一個常見任務。

在本教程中，我們將探討如何使用 Jackson 刪除 JSON 元素，並通過實際示例瞭解該過程。

2. 環境搭建

要使用 Jackson，首先需要在我們的 <em href="https://mvnrepository.com/artifact/com.fasterxml.jackson.dataformat/jackson-dataformat-xml">jackson-dataformat-xml</a</em> 依賴中添加jackson-dataformat-xml</a 依賴到 pom.xml 文件中：`

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
    <version>2.15.2</version>
</dependency>

該庫允許我們使用數據綁定 API。

3. 通過鍵刪除 JSON 元素

當涉及到刪除 JSON 時，最簡單的方法就是通過其鍵。 Jackson 提供了多個方法來簡化此任務。 其中一種常用的方法是使用 JsonNode 類，該類代表 Jackson API 中的 JSON 節點。

要通過鍵刪除元素，我們可以按照以下步驟操作：

1. 使用 Jackson 的 ObjectMapper 解析 JSON 字符串或輸入流。
2. 將 JSON 數據轉換為 JsonNode 對象。
3. 使用 JsonNode 對象的 remove(String fieldName) 方法刪除所需元素。
4. 使用 ObjectMapper 將修改後的 JsonNode 對象轉換回 JSON 字符串。

假設我們有以下 JSON 對象：

{
    "name": "John",
    "age": 30,
    "city": "New York"
}

我們希望從該對象中移除 age 屬性。以下是相應的代碼片段：

@Test
public void given_JsonData_whenUsingJackson_thenRemoveElementByKey() throws JsonProcessingException {
    String json = "{\"name\": \"John\", \"age\": 30, \"city\": \"New York\"}";
    ObjectMapper objectMapper = new ObjectMapper();
    JsonNode jsonNode = objectMapper.readTree(json);
    ObjectNode object = (ObjectNode) jsonNode;
    object.remove("age");
    String updatedJson = objectMapper.writeValueAsString(object);
    Assertions.assertEquals("{\"name\":\"John\",\"city\":\"New York\"}", updatedJson);
}

在上述測試方法中，我們從 JSON 對象中移除鍵為 age 的元素，並驗證結果 JSON 字符串中不包含該元素。

預期和實際的 JSON 輸出應相同：

{
    "name": "John",
    "city": "New York"
}

4. 根據條件移除 JSON 元素

有時，我們需要根據特定條件從集合中移除元素。例如，我們可能想要移除所有具有特定值或特定類型的元素。

幸運的是，Jackson 提供了多種方法來實現這一目標。一種方法是使用 <em >JsonNode</em >>，遍歷其元素，並移除滿足給定條件的元素。

讓我們考慮以下場景，我們有一個 JSON 對象：

{
    "name": "John",
    "age": 30,
    "city": "New York"
}

我們希望從這個對象中移除任何值為 30 的數字元素。下面我們來看如何做到這一點：

@Test
public void given_JsonData_whenUsingJackson_thenRemoveElementsByCondition() throws JsonProcessingException {
    String json = "{\"name\": \"John\", \"age\": 30, \"city\": \"New York\"}";
    ObjectMapper objectMapper = new ObjectMapper();
    JsonNode jsonNode = objectMapper.readTree(json);
    Iterator<JsonNode> elements = jsonNode.elements();
    while (elements.hasNext()) {
        JsonNode element = elements.next();
        if (element.isNumber() && element.asInt() == 30) {
            elements.remove();
        }
    }
    String updatedJson = objectMapper.writeValueAsString(jsonNode);
    Assertions.assertEquals("{\"name\":\"John\",\"city\":\"New York\"}", updatedJson);
}

在上述示例中，我們遍歷 JsonNode 的元素，並移除任何值為 30 且是數字的元素。 最終的 JSON 字符串不包含被移除的元素。

以下是預期的 JSON 輸出和實際的 JSON 輸出應相同：

{
    "name": "John",
    "city": "New York"
}

5. 從複雜結構中移除 JSON 元素

在某些情況下，我們可能會遇到由嵌套對象或數組組成的複雜 JSON 結構。 針對這些結構進行高效處理需要具備根據我們的要求移除特定元素的能夠。

通過使用 Jackson 的豐富 API 集合，我們可以迭代 JsonNode 實例中的元素，並執行條件檢查以識別要移除的元素。

要從嵌套對象或數組中移除元素，請遵循以下步驟：

1. 使用 ObjectMapper 解析 JSON 字符串或輸入流
2. 使用 JsonNode 方法（例如 get(String fieldName) 或 path(String fieldName)）遍歷 JSON 結構以到達所需元素
3. 在選定的 JsonNode 上使用適當的移除方法（例如 remove(String fieldName)、remove(int index) 等）
4. 使用 ObjectMapper 將修改後的 JsonNode 轉換回 JSON 字符串

讓我們考慮我們正在處理一個具有複雜結構的嵌套 JSON 對象：

{
    "name": "John",
    "details": {
        "age": 30,
        "city": "New York"
    }
}

我們希望從嵌套的 details 對象中移除具有鍵 age 的元素：

@Test
public void given_JsonData_whenUsingJackson_thenRemoveElementFromNestedStructure() throws JsonProcessingException {
    String json = "{\"name\": \"John\", \"details\": {\"age\": 30, \"city\": \"New York\"}}";
    ObjectMapper objectMapper = new ObjectMapper();
    JsonNode jsonNode = objectMapper.readTree(json);
    JsonNode detailsNode = jsonNode.path("details");
    ((ObjectNode) detailsNode).remove("age");
    String updatedJson = objectMapper.writeValueAsString(jsonNode);
    Assertions.assertEquals("{\"name\":\"John\",\"details\":{\"city\":\"New York\"}}", updatedJson);
}

在上述代碼中，我們訪問嵌套對象（details）並刪除鍵（age）。生成的 JSON 字符串反映了修改後的結構，並且預期的 JSON 輸出應與實際 JSON 輸出相同。

{
    "name": "John",
    "details": {
        "city": "New York"
    }
}

6. 結論

在本文中，我們探討了使用 Java 中 Jackson 庫去除 JSON 元素的各種技術。我們討論了通過鍵刪除元素、基於條件刪除元素以及從複雜 JSON 結構中刪除元素。

總而言之，通過利用 Jackson 提供的強大功能，我們可以輕鬆地操縱 JSON 數據以滿足應用程序的要求。