使用 Jackson 刪除 JSON 元素

一、簡介

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

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

2. 搭建環境

要使用 Jackson，我們首先將[jackson-dataformat-xml](https://mvnrepository.com/artifact/com.fasterxml.jackson.dataformat/jackson-dataformat-xml)依賴項添加到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 節點。

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

• 使用 Jackson ObjectMapper解析 JSON 字符串或輸入流
• 將 JSON 數據轉換為JsonNode對象
• 使用JsonNode對像上的remove(String fieldName)方法刪除所需的元素
• 使用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 元素

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

幸運的是，傑克遜提供了多種方法來實現這一目標。一種方法涉及使用JsonNode ，迭代其元素，並刪除滿足給定條件的元素。

讓我們考慮給定的場景，其中我們有以下 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實例的元素並執行條件檢查以識別要刪除的元素。

要從嵌套對像或數組中刪除元素，我們遵循以下步驟：

• 使用ObjectMapper解析 JSON 字符串或輸入流
• 使用JsonNode方法（例如get(String fieldName)或path(String fieldName)遍歷 JSON 結構以到達所需的元素
• 在選定的JsonNode上使用適當的刪除方法（ remove(String fieldName) 、 remove(int index)等）
• 使用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"
 }
 }

六，結論

在本文中，我們探索了使用 Java 中的 Jackson 庫刪除 JSON 元素的不同技術。我們討論了按鍵刪除元素、根據條件刪除元素以及從復雜的 JSON 結構中刪除元素。

總的來說，通過使用Jackson提供的強大功能，我們可以輕鬆地操作JSON數據來滿足我們應用程序的要求。

與往常一樣，代碼示例可在 GitHub 上獲取。