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。充分利用手中已有的資源來解決問題，無需自己造輪子，也不必引入新的依賴。
本文轉載自微信公眾號「碼農小胖哥」，可以通過以下二維碼關注。轉載本文請聯系碼農小胖哥公眾號。
