您的位置:

Jackson ObjectMapper: Java 序列化的强大工具

一、简介

Jackson 是一个高效、功能强大的 Java 库,用来处理 JSON 数据格式。它提供了两个核心接口:

  • JsonParser 用来解析 JSON 数据流。
  • ObjectMapper 用来解析和生成 JSON 数据,也可以用来处理 Java 对象和 JSON 字符串之间的转换。

Jackson 将 Java 对象序列化为 JSON 格式的过程大大简化了我们的开发任务,而它的核心类 ObjectMapper 则是实现这一功能的核心。

二、基础用法

使用 ObjectMapper 将 Java 对象序列化为 JSON 格式的过程非常简单:

public class Person {
    private String name;
    private int age;

    // getters and setters
}

ObjectMapper objectMapper = new ObjectMapper();
Person person = new Person("Alex", 28);
String json = objectMapper.writeValueAsString(person);
System.out.println(json);

一行代码就将 Person 对象序列化成了下面的 JSON 字符串:

{"name":"Alex","age":28}

Jackson 自动将每个属性转换成 JSON 格式,如果你需要更改某个属性的名称,可以使用 @JsonProperty 注解。

三、高级用法

1. 支持 Java 8 时间 API

从 Jackson 2.8.1 版本开始,可以支持 Java 8 时间 API 的序列化和反序列化。

ObjectMapper objectMapper = new ObjectMapper();
objectMapper.registerModule(new JavaTimeModule());
objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);

配置完成后,我们可以将 LocalDate、LocalTime、Instant 类型转换成 ISO8601 格式的字符串。

2. 忽略空属性

在序列化过程中,我们可以使用 @JsonInclude(JsonInclude.Include.NON_NULL) 注解或者通过配置 ObjectMapper 来实现忽略空属性的功能。

@JsonInclude(JsonInclude.Include.NON_NULL)
public class Person {
    private String name;
    private Integer age;
    private String email;

    // getters and setters
}

ObjectMapper objectMapper = new ObjectMapper();
objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

以上代码将忽略 Person 对象中值为 null 的属性,不会将它们写入 JSON 字符串中。

3. 处理 JSON 嵌套

Jackson 可以自动序列化和反序列化 JSON 数据嵌套的 Java 对象,无需我们手动处理。

public class Address {
    private String street;
    private String city;
    private String country;

    // getters and setters
}

public class Person {
    private String name;
    private Address address;

    // getters and setters
}

ObjectMapper objectMapper = new ObjectMapper();
Person person = new Person("Alex", new Address("Main St.", "San Francisco", "USA"));
String json = objectMapper.writeValueAsString(person);

以上代码将序列化出一个包含嵌套 JSON 数据的字符串:

{"name":"Alex","address":{"street":"Main St.","city":"San Francisco","country":"USA"}}

4. 处理 JSON 数组

Jackson 可以处理 JSON 数组,将它们转换成 Java 中的 List 或数组类型。

public class Person {
    private String name;
    private List<String> hobbies;

    // getters and setters
}

ObjectMapper objectMapper = new ObjectMapper();
Person person = new Person("Alex", Arrays.asList("swimming", "reading", "traveling"));
String json = objectMapper.writeValueAsString(person);

以上代码将生成一个包含 JSON 数组的字符串:

{"name":"Alex","hobbies":["swimming","reading","traveling"]}

5. 自定义序列化和反序列化

有时候,我们需要自定义序列化和反序列化的行为,例如将 Java 类型 BigDecimal 序列化成字符串类型而不是数字类型,或者从 JSON 串中读取时间戳并转换成本地时间对象。

我们可以通过编写 JsonSerializerJsonDeserializer 来实现这些自定义行为。下面是一个将时间戳转换成本地时间对象的例子:

public class LocalDateTimeJsonDeserializer extends JsonDeserializer<LocalDateTime> {
    @Override
    public LocalDateTime deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
        long epochMillis = p.getValueAsLong();
        return LocalDateTime.ofInstant(Instant.ofEpochMilli(epochMillis), ZoneId.systemDefault());
    }
}

ObjectMapper objectMapper = new ObjectMapper();
SimpleModule module = new SimpleModule();
module.addDeserializer(LocalDateTime.class, new LocalDateTimeJsonDeserializer());
objectMapper.registerModule(module);

以上代码将用自定义的 JsonDeserializer 对象来反序列化 LocalDateTime 类型。

四、结语

Jackson ObjectMapper 是 Java 序列化中的一个强大工具,可大大简化我们的开发任务。我们可以使用它来将 Java 对象序列化为 JSON 字符串,也可以将 JSON 数据转换成 Java 对象。

在实际使用中,我们可以利用各种功能,如支持 Java 8 时间 API、自定义序列化和反序列化等,来处理不同的业务需求。

更多高级用法和 API 请参考官方文档:https://github.com/FasterXML/jackson-databind