如何配置Jackson的ObjectMapper实现null值不序列化？

Question

如何配置Jackson的`ObjectMapper`以实现序列化时忽略`null`值？这是使用Jackson进行JSON序列化时常见的需求之一。默认情况下，Jackson会将值为`null`的字段也序列化到JSON输出中，但大多数实际应用场景中，我们更希望忽略这些`null`字段，以减少传输数据量并提升可读性。实现方式通常涉及对`ObjectMapper`的配置，例如通过设置`setSerializationInclusion`方法，使用`Include.NON_NULL`策略。此外，也可以通过注解方式在字段级别控制序列化行为。本文将详细介绍如何正确配置`ObjectMapper`以实现全局或局部忽略`null`值的序列化策略。

Answer 1

一、Jackson序列化中的null值处理机制

在Java应用中，使用Jackson库进行JSON序列化与反序列化是非常常见的做法。默认情况下，Jackson会将所有字段，包括值为null的字段，都序列化到输出的JSON字符串中。例如：

public class User {
    private String name;
    private Integer age;
    // getter and setter
}
  

如果name为null，而age为25，则默认序列化结果可能如下：

{"name":null,"age":25}

在很多业务场景中，我们并不希望输出包含null字段。这不仅增加了数据传输量，也可能导致前端处理复杂化。

二、全局配置：通过ObjectMapper设置非空序列化策略

最常见且推荐的方式是通过配置ObjectMapper实例，设置其序列化策略为忽略null值。可以通过如下方式实现：

ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(Include.NON_NULL);
  

其中，Include.NON_NULL表示仅序列化非空字段。该配置将作用于所有被序列化的对象实例。

此外，还可以选择其他策略，例如：

• Include.NON_EMPTY：忽略空值（包括null、空字符串、空数组等）
• Include.NON_DEFAULT：忽略默认值（如int为0、boolean为false等）

三、局部配置：通过注解控制字段级别的序列化行为

有时候我们希望对某些字段进行更细粒度的控制。Jackson提供了注解机制，允许在类或字段级别指定序列化策略。

例如，使用@JsonInclude注解：

public class User {
    @JsonInclude(Include.NON_NULL)
    private String name;

    @JsonInclude(Include.NON_DEFAULT)
    private Integer age;

    // getter and setter
}
  

上述配置表示，name字段仅在非空时才会被序列化，而age字段则在非默认值（如0）时才被包含。

这种方式适用于需要对不同字段应用不同策略的场景。

四、Spring Boot中的集成配置

在Spring Boot项目中，通常通过自定义配置类来全局配置Jackson的序列化行为。例如：

@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        mapper.setSerializationInclusion(Include.NON_NULL);
        return mapper;
    }
}
  

该配置将替换Spring Boot默认的ObjectMapper，从而影响整个应用中的JSON序列化行为。

此外，也可以通过application.properties文件进行快速配置：

spring.jackson.default-property-inclusion=non_null
  

这是Spring Boot 2.4+版本支持的特性，简化了配置流程。

五、常见问题与调试建议

在实际开发中，可能会遇到以下问题：

1. 配置未生效：检查是否创建了多个ObjectMapper实例，或是否被其他配置覆盖。
2. Spring Boot中配置冲突：确认是否同时存在多个Jackson配置类。
3. 注解与全局配置冲突：注解优先级高于全局配置，需注意字段级别的覆盖。

建议在开发阶段打印当前ObjectMapper的配置信息，以确认生效的序列化策略。

六、总结与扩展思考

忽略null值的序列化是优化API响应的重要手段。通过全局配置或字段注解，可以灵活控制JSON输出格式。此外，结合Spring Boot的集成配置，可以实现更高效的开发流程。

未来可进一步探索Jackson的其他特性，如：

• 自定义序列化器（JsonSerializer）
• 日期格式的统一处理
• 多态类型处理（@JsonTypeInfo）