Java中避免空嵌套JSON对象序列化的策略

本文探讨了在Java中使用Jackson库进行JSON序列化时，如何避免将空的嵌套对象（如{"add": {}}）输出到JSON负载中。针对@JsonInclude(JsonInclude.Include.NON_NULL)无法完全解决此问题的情况，文章详细介绍了两种基于@JsonInclude(JsonInclude.Include.CUSTOM)的解决方案：一种是利用值对象自身的equals()方法作为过滤器，另一种是创建专门的自定义过滤器类，以实现更精细的控制，包括处理父对象本身为null的情况。

在java开发中，使用jackson库进行对象到json的序列化是常见的操作。然而，有时我们希望在特定条件下，例如当一个嵌套对象的所有字段都为空时，避免将其序列化为一个空的json对象（如"add": {}）。虽然@jsoninclude(jsoninclude.include.non_null)注解可以阻止值为null的字段被序列化，但它通常无法阻止一个非null的嵌套对象（即使其内部所有字段都为null）被序列化为空对象。为了解决这一问题，我们可以利用@jsoninclude(jsoninclude.include.custom)结合自定义的过滤器来实现更精确的控制。

问题场景描述

假设我们有以下Java类结构：

class X {
  public Address add;
}

class Address {
  public String str;
  public String pincode;
}

当X对象中的add字段被初始化，但Address对象内部的str和pincode字段都为null时，默认的Jackson序列化可能会生成如下JSON：

{
  "add": {}
}

而我们的目标是，在这种情况下完全不输出"add": {}，即希望序列化结果为：

{}

解决方案一：利用值对象的 equals() 方法作为过滤器

@JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = YourClass.class) 允许我们指定一个类作为过滤器。当使用 Include.CUSTOM 模式时，Jackson会实例化 valueFilter 指定的类（通常是默认构造函数），并使用其 equals() 方法来判断是否应该包含该字段。如果待序列化的字段值与过滤器的 equals() 方法返回 true，则该字段将被排除。

因此，如果我们的Address类实现了一个“合理”的equals()方法，该方法在所有字段都为null时返回true，那么我们就可以直接将Address.class作为valueFilter。

示例代码：

首先，修改Address类，实现equals()和hashCode()方法：

import java.util.Objects;

class Address {
    public String str;
    public String pincode;

    @Override
    public boolean equals(Object o) {
        // 如果是同一个对象，直接返回 true
        if (this == o) return true;
        // 如果传入对象为 null 或类型不匹配，返回 false
        if (o == null || getClass() != o.getClass()) return false;
        // 类型转换
        Address address = (Address) o;
        // 比较所有字段是否相等。这里，如果 str 和 pincode 都为 null，则视为相等
        return Objects.equals(str, address.str) &&
               Objects.equals(pincode, address.pincode);
    }

    @Override
    public int hashCode() {
        return Objects.hash(str, pincode);
    }
}

然后，在X类中的add字段上应用@JsonInclude注解：

import com.fasterxml.jackson.annotation.JsonInclude;

class X {
    // 当 add 字段的值与 Address 类的默认实例（或其 equals 方法判断为等价的空实例）相等时，不包含该字段
    @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = Address.class)
    public Address add;
}

工作原理： 当Jackson序列化X对象时，它会检查add字段。它会创建一个Address类的实例（通过默认构造函数），然后调用add.equals(new Address())。如果add对象的所有字段（str和pincode）都为null，那么equals方法会返回true，Jackson就不会序列化add字段。

注意事项： 这种方法有一个局限性。如果add字段本身就是null，它仍然会按照Jackson的默认行为被序列化为"add": null（除非你在类或字段级别也使用了@JsonInclude(JsonInclude.Include.NON_NULL)）。如果你希望add字段为null时也完全不输出，那么需要更精细的控制。

解决方案二：创建专门的自定义过滤器类

为了实现更灵活和全面的控制，特别是当add字段本身为null时也希望完全排除，我们可以创建一个独立的自定义过滤器类。

示例代码：

首先，定义一个自定义过滤器类AddressFilter：

class AddressFilter {
    // Jackson会调用此 equals 方法来判断是否应该排除字段值
    @Override
    public boolean equals(Object obj) {
        // 如果 obj 为 null，表示待序列化的字段值是 null。
        // 如果我们希望 null 值也被排除，则返回 true。
        if (obj == null) {
            return true;
        }
        // 确保 obj 是 Address 类型
        if (!(obj instanceof Address)) {
            return false; // 如果类型不匹配，通常不排除
        }
        // 将 obj 转换为 Address 类型
        Address add = (Address) obj;
        // 判断 Address 对象的所有字段是否都为 null。
        // 如果是，则认为它是“空的”，应该被排除。
        return add.str == null && add.pincode == null;
    }
}

然后，在X类中的add字段上应用@JsonInclude注解，并指定valueFilter为AddressFilter.class：

import com.fasterxml.jackson.annotation.JsonInclude;

class X {
    // 使用自定义过滤器 AddressFilter 来判断是否包含 add 字段
    @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = AddressFilter.class)
    public Address add;
}

工作原理： 当Jackson序列化X对象时，它会实例化AddressFilter类，并调用new AddressFilter().equals(add)。

• 如果add字段的值是null，AddressFilter.equals()方法会捕获到obj == null的情况并返回true，从而排除add字段。
• 如果add字段的值是一个Address对象，但其内部的str和pincode都为null，AddressFilter.equals()方法会判断add.str == null && add.pincode == null为true，从而排除add字段。
• 只有当add字段非null且其内部至少有一个字段非null时，equals()方法才会返回false，此时add字段才会被正常序列化。

总结与最佳实践

• 选择合适的方案：
  • 如果你的值对象（如Address）已经有一个非常完善且符合“空”概念的equals()方法，并且你不介意null字段被序列化为"fieldName": null，那么方案一（直接使用值类作为valueFilter）可能更简洁。
  • 如果你需要更精细的控制，特别是要处理字段本身为null的情况，或者值对象的equals()方法不适合作为“空”的判断标准，那么方案二（创建独立的自定义过滤器类）是更推荐的选择。
• equals()和hashCode()的重要性： 如果采用方案一，务必确保值对象的equals()和hashCode()方法实现正确且一致。它们是Java对象比较的核心，不正确的实现可能导致不可预测的行为。
• 代码可读性： 自定义过滤器类（方案二）通常能提供更好的代码可读性，因为它明确地封装了排除逻辑，使得其他开发者更容易理解其意图。
• 性能考量： 两种方案都会在序列化时引入额外的equals()方法调用。对于性能敏感的应用，应进行基准测试。但在大多数情况下，这种开销是微不足道的。

通过上述两种方法，我们可以有效地控制Jackson在序列化时对空嵌套对象的处理，确保生成的JSON负载符合预期，避免不必要的空结构，从而提高API的整洁性和效率。