Java使用ObjectMapper的簡單示例

學海無涯519發表於2020-09-18
JavaObjectAPP

一、什麼是ObjectMapper?

  • ObjectMapper類是Jackson庫的主要類，它提供一些功能將資料集或物件轉換的實現。
  • 它將使用JsonParser和JsonGenerator例項來實現JSON的實際讀/寫。

二、ObjectMapper怎麼使用？

2.1 配置

2.1.1 普通Java專案（引入如下依賴即可）

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.5</version>
</dependency>
 
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.9.5</version>
</dependency>
 
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-annotations -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotations</artifactId>
    <version>2.9.5</version>
</dependency>

2.1.2 Sring Boot專案

重要說明：

　　由於Spring Boot的自動配置JacksonAutoConfiguration中有如下圖所示的依賴引入和配置，所以不需要我們額外配置

  

 

2.2 實戰

 User類

 1 @Data
 2 @EqualsAndHashCode(callSuper = false)
 3 @Accessors(chain = true)
 4 public class User implements Serializable {
 5 
 6     private static final long serialVersionUID = 1L;
 7 
 8     // 姓名
 9     private String name;
10 
11     // 性別
12     private String sex;
13 
14     // 年齡
15     private Integer age;
16 }

2.2.1 Java物件、集合轉JSON

 1 public static void main(String[] args) throws IOException {
 2 
 3         ObjectMapper objectMapper = new ObjectMapper();
 4 
 5         User user = new User();
 6         user.setName("張三");
 7         user.setAge(20);
 8         user.setSex("男");
 9 
10         List<User> userList = new ArrayList<>();
11         userList.add(user);
12 
13         // 物件轉換為JSON
14         String userJsonString = objectMapper.writeValueAsString(user);16 
17         // 集合轉換為JSON
18         String userListJsonString = objectMapper.writeValueAsString(userList);20 }

2.2.2 JSON轉Java物件、集合

1 　　　　　// JOSN轉物件（java物件）
2         User newUser = objectMapper.readValue(userJsonString, User.class);
3 
4         // JOSN轉集合（集合）
5         List<User> list = objectMapper.readValue(userListJsonString, new TypeReference<List<User>>(){});

2.2.3 json轉JsonNode、ObjectNode

說明：

　　Jackson的JsonNode和ObjectNode兩個類，前者是不可變的，一般用於讀取。後者可變，一般用於建立Json物件圖。

 1 　　　　　// json轉JsonNode
 2         JsonNode jsonNode = objectMapper.readTree(userJsonString);
 3         String sex = jsonNode.get("sex").asText();
 4 
 5         // JsonNode轉ObjectNode
 6         ObjectNode objectNode = (ObjectNode)jsonNode;
 7 
 8         // json轉JsonNode
 9         JsonNode jsonNodeList = objectMapper.readTree(userListJsonString);
10 
11         // JsonNode轉ObjectNode
12         ArrayNode arrayNode = (ArrayNode)jsonNodeList;

 2.2.4 jsonNode轉物件、集合

1 　　　　　// jsonNode轉為json字串
2         String jsonNodeString = objectMapper.writeValueAsString(jsonNode);
3         String jsonNodeListString = objectMapper.writeValueAsString(jsonNodeList);
4 
5         // json字串轉物件、集合
6         User user1 = objectMapper.readValue(jsonNodeString, User.class);
7         List<User> list1 = objectMapper.readValue(jsonNodeListString, new TypeReference<List<User>>() {});

 2.3 注意事項

2.3.1 微服務中從其他服務獲取過來的物件，如果從Object強轉為自定義的型別會報錯，利用ObjectMapper轉換。

正確示例：

　　說明：Schedule類、OutpOrderBill類都是類似於User類的Java物件。

// 物件
Schedule schedule = objectMapper.convertValue(callNurseCenterService.getSchedule(registRecord.getScheCode()).getData(), Schedule.class);

// 泛型為物件的集合
List<OutpOrderBill> outpOrderBillList = objectMapper.convertValue(
                            callChargeCenterService.getOrderBillByOrderCode(orders.getOrgCode(),orders.getOrderCode()).getData(), 
                            new TypeReference<List<OutpOrderBill>>() {});

 2.3.2 上面轉換的過程中，如果返回的欄位你不是都需要，需要忽略其中的幾個欄位，在自定義的類中新增標紅註解

 1 @Data
 2 @EqualsAndHashCode(callSuper = false)
 3 @Accessors(chain = true)
 4 @JsonIgnoreProperties(ignoreUnknown = true)
 5 public class User  implements Serializable {
 6 
 7     private static final long serialVersionUID = 1L;
 8 
 9      ////提供有這個引數，但是不想獲取
10 //    // 姓名
11 //    private String name;
12 
13     // 性別
14     private String sex;
15 
16     // 年齡
17     private Integer age;
18 }

 如果不想新增註解，可以使用下面兩種方式

第一種方式：

ObjectMapper mapper = new ObjectMapper().setVisibility(JsonMethod.FIELD,Visibility.ANY);

mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
第二種方式：

ObjectMapper objectMapper = new ObjectMapper();

mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

2.3.3 在轉換的過程中，有可能有的屬性被設成空就不序列化等的需求，可以在類的屬性上或直接在類上加上一下註解。用在屬性上就是隻針對一個屬性，用在類上就是針對類裡的所有屬性。

@JsonInclude(Include.NON_NULL) 

@JsonInclude(Include.Include.ALWAYS) 預設 

@JsonInclude(Include.NON_DEFAULT) 屬性為預設值不序列化 

@JsonInclude(Include.NON_EMPTY) 屬性為 空（“”） 或者為 NULL 都不序列化 

@JsonInclude(Include.NON_NULL) 屬性為NULL 不序列化

  

參考網址：

　　Jackson-1.9.9線上文件

相關文章