杰克逊@JsonSubTypes对于多态反序列化仍然是必需的吗?

2022-08-31 17:02:07

我能够序列化和反序列化一个类层次结构,其中抽象基类被注释

@JsonTypeInfo(
    use = JsonTypeInfo.Id.MINIMAL_CLASS,
    include = JsonTypeInfo.As.PROPERTY,
    property = "@class")

但是没有列出子类,子类本身相对未注释,只有构造函数。ObjectMapper是香草,我没有使用mixin。@JsonSubTypes@JsonCreator

Jackson 关于 PolymorphicDeserialization 和 “type ids” 的文档建议(强烈)我需要抽象基类上的注释,或者在 mixin 上使用它,或者我需要向 ObjectMapper 注册子类型。有很多SO问题和/或博客文章同意。然而,它奏效了。(这是杰克逊 2.6.0。@JsonSubTypes)

所以。。。我是尚未记录的功能的受益人,还是依赖于未记录的行为(可能会更改)还是发生了其他事情?(我问是因为我真的不希望它是后两者中的任何一个。但我知道了。

编辑:添加代码 - 和一个注释。注释是:我应该提到我正在反序列化的所有子类都与基本抽象类位于同一包和同一jar中。

抽象基类:

package so;
import com.fasterxml.jackson.annotation.JsonTypeInfo;

@JsonTypeInfo(
    use = JsonTypeInfo.Id.MINIMAL_CLASS,
    include = JsonTypeInfo.As.PROPERTY,
    property = "@class")
public abstract class PolyBase
{
    public PolyBase() { }

    @Override
    public abstract boolean equals(Object obj);
}

它的子类:

package so;
import org.apache.commons.lang3.builder.EqualsBuilder;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

public final class SubA extends PolyBase
{
    private final int a;

    @JsonCreator
    public SubA(@JsonProperty("a") int a) { this.a = a; }

    public int getA() { return a; }

    @Override
    public boolean equals(Object obj) {
        if (null == obj) return false;
        if (this == obj) return true;
        if (this.getClass() != obj.getClass()) return false;

        SubA rhs = (SubA) obj;
        return new EqualsBuilder().append(this.a, rhs.a).isEquals();
    }
}

子类 是相同的,只是字段在 中声明 (not ) 和 (not ) (并且相应地修改了方法)。SubBSubCaStringintSubBbooleanintSubCgetA

测试类:

package so;    
import java.io.IOException;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.testng.annotations.Test;
import static org.assertj.core.api.Assertions.*;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.ObjectMapper;

public class TestPoly
{
    public static class TestClass
    {
        public PolyBase pb1, pb2, pb3;

        @JsonCreator
        public TestClass(@JsonProperty("pb1") PolyBase pb1,
                         @JsonProperty("pb2") PolyBase pb2,
                         @JsonProperty("pb3") PolyBase pb3)
        {
            this.pb1 = pb1;
            this.pb2 = pb2;
            this.pb3 = pb3;
        }

        @Override
        public boolean equals(Object obj) {
            if (null == obj) return false;
            if (this == obj) return true;
            if (this.getClass() != obj.getClass()) return false;

            TestClass rhs = (TestClass) obj;
            return new EqualsBuilder().append(pb1, rhs.pb1)
                                      .append(pb2, rhs.pb2)
                                      .append(pb3, rhs.pb3)
                                      .isEquals();
        }
    }

    @Test
    public void jackson_should_or_should_not_deserialize_without_JsonSubTypes() {

        // Arrange
        PolyBase pb1 = new SubA(5), pb2 = new SubB("foobar"), pb3 = new SubC(true);
        TestClass sut = new TestClass(pb1, pb2, pb3);

        ObjectMapper mapper = new ObjectMapper();

        // Act
        String actual1 = null;
        TestClass actual2 = null;

        try {
            actual1 = mapper.writeValueAsString(sut);
        } catch (IOException e) {
            fail("didn't serialize", e);
        }

        try {
            actual2 = mapper.readValue(actual1, TestClass.class);
        } catch (IOException e) {
            fail("didn't deserialize", e);
        }

        // Assert
        assertThat(actual2).isEqualTo(sut);
    }
}

此测试通过,如果您在第二行中断,您可以检查并查看:try {actual1

{"pb1":{"@class":".SubA","a":5},
 "pb2":{"@class":".SubB","a":"foobar"},
 "pb3":{"@class":".SubC","a":true}}

因此,三个子类被正确序列化(每个子类的类名为id),然后反序列化,结果比较相等(每个子类都有一个“值类型”)。equals()


答案 1

有两种方法可以在序列化和杰克逊的反序列化中实现多态性。它们在第 1 节中定义。您发布的链接中的用法。

您的代码

@JsonTypeInfo(
    use = JsonTypeInfo.Id.MINIMAL_CLASS,
    include = JsonTypeInfo.As.PROPERTY,
    property = "@class")

是第二种方法的一个例子。首先要注意的是

注释类型及其子类型的所有实例都使用这些设置(除非被其他注释覆盖)

因此,此配置值将传播到所有子类型。然后,我们需要一个类型标识符,它将 Java 类型映射到 JSON 字符串中的文本值,反之亦然。在您的示例中,这是由JsonTypeInfo.Id#MINIMAL_CLASS

表示使用具有最小路径的 Java 类名作为类型标识符。

因此,从目标实例生成最小类名,并在序列化时写入 JSON 内容。或者使用最小类名来确定用于反序列化的目标类型。

你也可以使用JsonTypeInfo.Id#NAME

表示逻辑类型名称用作类型信息;然后,名称需要单独解析为实际的具体类型()。Class

若要提供此类逻辑类型名称,请使用@JsonSubTypes

用于指示可序列化多态类型的子类型,以及关联 JSON 内容中使用的逻辑名称的注释(这比使用物理 Java 类名更具可移植性)。JsonTypeInfo

这只是实现相同结果的另一种方法。您询问的有关状态的文档

基于Java类名的类型ID相当简单:它只是类名,可能是一些简单的前缀删除(对于“最小”变体)。但是类型名称是不同的:必须在逻辑名称和实际类之间有映射。

因此,处理类名的各种值是直截了当的,因为它们可以自动生成。但是,对于类型名称,您需要显式提供映射值。JsonTypeInfo.Id


答案 2