Java物件轉JSON時如何動態的增刪改查屬性

碼農小胖哥發表於2020-11-03
Java物件JSON

1. 前言

日常開發中少不了JSON處理，少不了需要在JSON中新增額外欄位或者刪除特定欄位的需求。今天我們就使用Jackson類庫來實現這個功能。

2. JSON字串增加額外欄位

假如我們有這樣結構的JSON:

{
    "username":"felord.cn",
    "age":18
}

期望增加一個性別欄位gender:

{
    "username": "felord.cn",
    "age": 18,
    "gender": "male"
}

首先使用ObjectMapper載入JSON字串，為ObjectNode:

ObjectNode jsonNodes = objectMapper.readValue(json, ObjectNode.class);

ObjectNode提供了很多操作JSON屬性的方法：

  • get 根據索引或者欄位名獲取對應的JsonNode。
  • put系列方法 提供了將基本型別、null值、物件、陣列、原始值新增到JSON的能力。

正好我們可以藉助於put方法來完成額外新增欄位，完整的程式碼片段：

String json = "{\n" +
        "    \"username\":\"felord.cn\",\n" +
        "    \"age\":18\n" +
        "}";

ObjectMapper objectMapper = new ObjectMapper();

ObjectNode jsonNodes = objectMapper.readValue(json, ObjectNode.class);
jsonNodes.put("gender", "male");
String newJson = objectMapper.writeValueAsString(jsonNodes);
// newJson = {"username":"felord.cn","age":18,"gender":"male"}

3. 物件轉JSON時新增欄位

有時候我們定義的物件沒有包含特定的欄位，但是轉成JSON時同樣需要有額外的欄位。跟章節2類似，，只不過提供的不再是JSON字串而是Java物件：

/**
 * @author felord.cn
 * @since 11:02
 */
@Data
public class User {
    private String username;
    private Integer age;
}

其實思路很明確，只要我們能夠將物件轉換為ObjectNode就可以如法炮製。ObjectMapper提供了valueToTree方法可以實現這一點，所以物件轉JSON時新增欄位完整的DEMO為：

User user = new User();
user.setUsername("felord.cn");
user.setAge(18);

ObjectMapper objectMapper = new ObjectMapper();
ObjectNode jsonNodes = objectMapper.valueToTree(user);
jsonNodes.put("gender", "male");
String newJson = objectMapper.writeValueAsString(jsonNodes);
// newJson = {"username":"felord.cn","age":18,"gender":"male"}

4. 移除屬性

無論是JSON字串或者Java物件轉JSON時，移除屬性跟上面的思路一樣，只需要呼叫remove方法即可，這裡不再演示。

5. 擴充套件

上面的所有操作都是藉助於了Jackson中的JsonNode派生的JSON節點類完成的，關係如下：

JsonNode

JsonNode可以細粒度的訪問JSON資訊，提供了非常有用的JSON物件操作API，但是很多人在有相關需求的時候並不能夠想到它，所以你不需要具體的記住這些API，只需要記住它可以操作JSON即可。

6. 總結

本文對Jackson動態的增刪改查JSON進行了介紹，牽引出一個很重要的操作工具JsonNode。充分利用手中已有的資源來解決問題，無需自己造輪子，也不必引入新的依賴。好了今天的分享就到這裡，多多關注：碼農小胖哥 及時獲取更多有效的程式設計乾貨。

關注公眾號：Felordcn 獲取更多資訊

個人部落格：https://felord.cn

相關文章