Jackson JSON 序列化：如何在嵌套對象的所有字段都為空時忽略它？

Question

我正在使用 Jackson 並且我有一些 JSON 模式對象設置如下：

@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class Person {

    String name;
    Child child = new Child();
    Sibling sibling = new Sibling();

    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }

    public Child getChild() {
        return child;
    }
    public void setChild(Child child) {
        this.child = child;
    }

    public Sibling getSibling() {
        return sibling;
    }
    public void setSibling(Sibling sibling) {
        this.sibling = sibling;
    }
}

@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class Child {

    String name;

    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class Sibling {

    String name;

    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

我試圖忽略所有為空或空的字段，這很好用。 但我也想忽略字段全部為空或空的對象。 例如：

Person person = new Person();
person.setName("John Doe");
ObjectMapper mapper = new ObjectMapper();
String json = objectMapper.writeValueAsString(person);

生成的 JSON 字符串是{"name":"John Doe","child":{},"sibling":{}} ，但我希望它是{"name":"John Doe"} 。 創建Person時需要初始化Child和Sibling ，所以我不想更改它。 有沒有辦法讓傑克遜使用自定義序列化程序將具有空字段的對象視為空？ 我見過為特定類型的對象使用自定義序列化程序的示例，但我需要一個適用於任何對象的示例。

Answer 1

您可以以一種可能更簡單的方式來實現此目的，而無需為Person或Child和Sibling使用CUSTOM定義序列化程序，而使用CUSTOM include並將字段類型作為過濾器傳遞。

首先，為Child和Sibling定義正確的equals方法。 然后，要過濾與其默認構造函數將返回的嵌套對象相等的嵌套對象，請在Person注釋相關的獲取器，如下所示：

@JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = Child.class)
public Child getChild() {
    return child;
}

@JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = Sibling.class)
public Sibling getSibling() {
    return sibling;
}

將valueFilter設置為上面的Child.class的作用是使用默認構造函數Child emptyChild = new Child()創建一個對象，然后確定應該序列化另一個對象Child child來檢查emptyChild.equals(child)是否為false

用於valueFilter的文檔

Answer 2

在您的情況下，我認為在序列化程序級別忽略空值就足夠了：

mapper.setSerializationInclusion(Include.NON_EMPTY);
mapper.setSerializationInclusion(Include.NON_NULL);