Jackson序列化时如何忽略值为null的字段？

Question

在使用Jackson进行Java对象序列化时，如何忽略值为null的字段是一个常见需求。默认情况下，Jackson会将null字段输出到JSON中，导致结果冗余或不符合接口规范。例如，一个User对象中`email`字段为null，序列化后仍显示`"email": null`，影响前端解析。如何配置ObjectMapper全局忽略null字段？是否可以通过注解方式在类或字段级别控制？常用的方式包括使用`@JsonInclude(JsonInclude.Include.NON_NULL)`注解，或通过`objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL)`全局设置。但在实际应用中，若同时存在部分字段需保留null值，应如何精细化控制？这涉及到注解优先级与配置冲突问题，是开发中容易出错的点。

Answer 1

一、Jackson序列化中忽略null字段的深度解析

1. 问题背景与常见场景

在Java后端开发中，使用Jackson进行JSON序列化是RESTful API构建的核心环节。默认情况下，Jackson会将对象中值为null的字段也输出到JSON结果中，例如：

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

若email == null，默认序列化结果为：{"name":"John", "email":null}。这种输出不仅冗余，还可能导致前端解析异常或增加网络传输负担。

2. 全局配置：ObjectMapper级控制

最直接的方式是在应用启动时通过ObjectMapper设置全局策略，统一忽略所有null字段：

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

该配置作用于所有序列化操作，适用于大多数字段都不希望输出null的场景。Spring Boot中可通过配置类实现：

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

3. 注解方式：类级别与字段级别的灵活控制

Jackson提供了@JsonInclude注解，支持在类或字段上声明null处理策略。

• 类级别：影响该类所有字段
• 字段级别：精确控制某个字段的行为

@JsonInclude(JsonInclude.Include.NON_NULL)
public class User {
    private String name;
    
    @JsonInclude(JsonInclude.Include.ALWAYS)  // 强制保留null
    private String email;

    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
    private int age;
}

上述代码中，email即使为null也会被序列化输出，而其他字段遵循类级别的NON_NULL规则。

4. 注解优先级与配置冲突分析

当全局配置、类注解、字段注解共存时，Jackson遵循以下优先级顺序（由高到低）：

优先级	配置层级	说明
1	字段注解	最高优先级，覆盖类和全局设置
2	类注解	影响类内所有未单独标注的字段
3	ObjectMapper全局配置	最低优先级，作为默认兜底策略

5. 实际应用中的精细化控制策略

在复杂业务系统中，常需混合策略。例如用户信息接口需隐藏null字段，但审计日志需完整记录包括null在内的状态变更。

解决方案如下：

1. 定义多个ObjectMapper实例，分别用于API输出和内部日志
2. 使用@JsonView配合不同视图分离序列化逻辑
3. 结合mixIn机制动态注入注解行为

// 审计专用ObjectMapper
ObjectMapper auditMapper = new ObjectMapper();
auditMapper.setSerializationInclusion(JsonInclude.Include.ALWAYS); // 不忽略任何null

6. 特殊类型与边界情况处理

某些类型如集合、数组、Optional等对null的处理有特殊逻辑：

• List<String>为null时是否输出取决于配置
• Optional.empty()默认视为null，受NON_NULL影响
• 自定义序列化器可绕过默认行为

可通过注册自定义Serializer实现更细粒度控制：

SimpleModule module = new SimpleModule();
module.addSerializer(Optional.class, new OptionalSerializer());
mapper.registerModule(module);

7. 性能与可维护性权衡

过度使用注解可能导致代码污染，建议采用“全局+局部例外”模式：

graph TD A[开始序列化] --> B{是否存在字段级@JsonInclude?} B -- 是 --> C[使用字段注解策略] B -- 否 --> D{是否存在类级@JsonInclude?} D -- 是 --> E[使用类注解策略] D -- 否 --> F[使用ObjectMapper全局配置] C --> G[输出JSON] E --> G F --> G

8. Spring Boot中的自动化配置实践

在application.yml中可简化全局配置：

spring:
  jackson:
    default-property-inclusion: non_null

此配置等价于调用setSerializationInclusion(NON_NULL)，适合微服务架构下的统一规范管理。

9. 常见误区与调试技巧

开发者常遇到的问题包括：

• 误以为@JsonIgnore能替代@JsonInclude
• 忽略父类字段的继承行为
• 未意识到反序列化时null字段仍会被设为null

调试建议：启用Jackson的SerializationFeature.WRITE_NULL_MAP_VALUES并结合日志输出中间状态。

10. 扩展思考：与其他框架的集成挑战

在GraphQL、gRPC JSON映射或消息队列场景中，null语义更为敏感。例如Protobuf转JSON时需确保空值语义一致。此时应结合Schema定义与Jackson配置协同设计。

推荐建立团队级JSON输出规范文档，明确null、空字符串、缺失字段的语义差异。