使用Jackson序列化忽略属性值为null字段解决方案

Jackson序列化技巧：轻松忽略null字段的两种方法

开发中常遇到需要过滤JSON中null字段的场景。本文将手把手教你用Jackson实现字段值为null时自动忽略该键值对，并附上完整代码案例！

一、问题场景

假设我们有一个Java对象：

@Data
public class User {
    private String name;
    private Integer age;
}

当name = null且age = 25时，默认序列化结果为：

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

而我们需要得到：

{"age": 25}

二、解决方案

方法1：全局配置

通过配置ObjectMapper全局忽略所有null字段：

// 配置全局忽略null
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

// 序列化示例
User user = new User();
user.setName(null);
user.setAge(25);

String json = objectMapper.writeValueAsString(user);
System.out.println(json); // 输出: {"age":25}

优点：一键配置所有类的序列化行为
缺点：无法针对特定字段保留null值

---

方法2：注解方式（精准控制字段）

在类或字段上添加@JsonInclude注解：

类级别注解

@JsonInclude(JsonInclude.Include.NON_NULL) // 类中所有字段生效
public class User {
    private String name;
    private Integer age;
    
    @JsonInclude(JsonInclude.Include.ALWAYS) // 强制保留该字段（即使为null）
    private String email;
}

字段级别注解

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

优先级规则：
字段注解 > 类注解 > 全局配置

---

三、效果验证

假设email = null时的序列化结果：

public static void main(String[] args) throws JsonProcessingException {
    // 创建测试对象
    User user = new User();
    user.setName(null);
    user.setAge(25);
    user.setEmail(null);

    // 配置全局忽略null
    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

    // 序列化并输出结果
    String json = objectMapper.writeValueAsString(user);
    System.out.println("全局配置 + 类注解 -> " + json);

    // 如果需要保留email字段，可以在类或字段上添加@JsonInclude(JsonInclude.Include.ALWAYS)
    User userWithEmail = new User();
    userWithEmail.setName(null);
    userWithEmail.setAge(25);
    userWithEmail.setEmail(null);

    // 单独配置email字段保留null
    String jsonWithEmail = objectMapper.writeValueAsString(userWithEmail);
    System.out.println("字段注解保留email -> " + jsonWithEmail);
}

// 输出根据配置不同：
// 全局配置 + 类注解 -> {"age":25}
// 字段注解保留email -> {"age":25, "email": null}

---

四、总结

方案	适用场景	灵活性
全局配置	统一处理所有类的null字段	★★☆☆
注解方式	需要精细控制特定字段	★★★★