Jackson ObjectMapper

背景

在最近写邓白氏项目的时候遇到一个需求，就是JSON字符串和Java对象之间相互转换，这就是涉及到数据反序列化。

概述

Jackson ObjectMapper是Java中处理JSON数据的强大工具，具有以下主要功能：
JSON与Java对象的相互转换：ObjectMapper可以将JSON数据转换为Java对象，以及将Java对象转换为JSON格式。这种转换过程称为序列化和反序列化。通过ObjectMapper，我们可以轻松地在Java应用程序中实现JSON和Java对象之间的转换。

支持不同数据格式：ObjectMapper支持多种JSON数据格式，包括JSON对象、数组、字符串等。它能够处理各种JSON数据结构，并将其转换为相应的Java对象。

快速开始

Maven 依赖

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.11.1</version>
</dependency>

ObjectMapper读写操作

定义一个Person对象

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Person {
    private String name;
    
    private Integer age;
}

Java 对象转 JSON

  Person person = new Person("yunzhi", 23);
  ObjectMapper objectMapper = new ObjectMapper();
  String s = objectMapper.writeValueAsString(person);
  logger.info(s);
 // {"name":"yunzhi","age":23}

JSON 对象转 Java

  ObjectMapper objectMapper = new ObjectMapper();
  String json = "{ \"name\" : \"yunzhi\", \"age\" : \"23\" }";
  Person person = objectMapper.readValue(json, Person.class);
  logger.info(people.toString());
// Person(name=yunzhi, age=23)

JSON数组转Java List

 ObjectMapper objectMapper = new ObjectMapper();
 String json = "[{ \"name\" : \"yunzhi\", \"age\" : \"23\" },{ \"name\" : \"kxb\", \"age\" : \"21\" }]";
 List<Person> peoples = objectMapper.readValue(json, new TypeReference<List<Person>>() {});
 logger.info(peoples.toString());
// [Person(name=yunzhi, age=23), Person(name=kxb, age=21)]

TypeReference的使用场景，假设我们有一个包含了许多人信息的JSON字符串，我们想要将它反序列化为一个列表（List）类型的对象，其中每个人信息是一个独立的对象。Java编译器无法确定这个列表中具体存放的是什么类型的对象。

JSON数组转Java Map

  ObjectMapper objectMapper = new ObjectMapper();
  String json = "{ \"name\" : \"yunzhi\", \"age\" : 23 }";
  Map<String, Object> map
                = objectMapper.readValue(json, new TypeReference<Map<String,Object>>(){});
logger.info(map.toString());
// {name=yunzhi, age=23}

特殊情况转换

Json转Java对象

重新定义Person类

public class Person {
    private String fullName;

    private Integer age;
}

下划线转驼峰性字段

 ObjectMapper objectMapper = new ObjectMapper();
 String json = "{ \"full_name\" : \"yunzhi\", \"age\" : 23 }";
 objectMapper.setPropertyNamingStrategy(PropertyNamingStrategies.SNAKE_CASE);
 Person person = objectMapper.readValue(json, Person.class);
 logger.info(person.toString());

// Person(fullName=yunzhi, age=23)

Json字段转换为对象字段不对应的情况

// 当json比对象实体多一个的情况，如何进行转换就会进行出错
ObjectMapper objectMapper = new ObjectMapper();
String json = "{\"full_name\":\"yunzhi\",\"age\":23, \"sex\":\"男\"}";

objectMapper.setPropertyNamingStrategy(PropertyNamingStrategies.SNAKE_CASE);
Person person = objectMapper.readValue(json,Person.class);

logger.info(person.toString());

//Unrecognized field "sex" (class club.yunzhi.dengbai.entity.Person)

解决方法：ObjectMapper配置

ObjectMapper objectMapper = new ObjectMapper();
String json = "{\"full_name\":\"yunzhi\",\"age\":23, \"sex\":\"男\"}";

objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
objectMapper.setPropertyNamingStrategy(PropertyNamingStrategies.SNAKE_CASE);

Person person = objectMapper.readValue(json,Person.class);
logger.info(person.toString());

// Person(fullName=yunzhi, age=23)

设置DeserializationFeatureFAIL_ON_UNKNOWN_PROPERTIES设置为false，这意味着在反序列化时，如果JSON中有未知的属性，如果有未知的属性，会进行忽略。

更多配置可以参考DeserializationFeature这个enum

Json字段为_开头的情况

ObjectMapper objectMapper = new ObjectMapper();
String json = "{ \"full_name\" : \"yunzhi\", \"_age\" : 23 }";
objectMapper.setPropertyNamingStrategy(PropertyNamingStrategies.SNAKE_CASE);
Person person = objectMapper.readValue(json, Person.class);
logger.info(person.toString());
//  Unrecognized field "_age" (class club.yunzhi.dengbai.entity.Person), not marked as ignorable (2 known properties: "full_name", "age"])

解决方式

// 重写Person
 @JsonProperty(value = "_age")
 private Integer age;

再次重新打印的值
Person(fullName=yunzhi, age=23)

@JsonProperty注解可以将 Java 对象的属性与 JSON 数据中的字段名称进行关联。这样，即使属性名称与字段名称不一致，Jackson 也能正确地进行序列化和反序列化。

总结

使用ObjectMapper API方式来解析和序列化JSON。方便进行序列化和反序列化

参考资料

https://www.baeldung.com/jackson-object-mapper-tutorial