如何在Jackson中为泛型类型创建自定义反序列化器？

Question

想象一下以下场景：

class <T> Foo<T> {
    ....
}

class Bar {
    Foo<Something> foo;
}

我想为Foo编写一个自定义的Jackson反序列化程序。为了做到这一点（例如，为了反序列化具有Foo的类

如何编写这样的反序列化程序？这应该是可能的，因为Jackson是通过键入集合和地图来实现的。

澄清：

似乎有两个部分可以解决这个问题：

1）获取Bar内声明的属性类型foo并使用它来反序列化Foo

2）在反序列化时找出我们正在类Bar内反序列化属性foo以成功完成步骤1）

如何完成1和2？




Answer 1

这就是您如何访问/解析自定义Jackson反序列化器的{Target etClass}。当然，您需要为此实现ContextualDeserializer接口。

public class WPCustomEntityDeserializer extends JsonDeserializer<Object> 
              implements ContextualDeserializer {

    private Class<?> targetClass;

    @Override
    public Object deserialize(JsonParser jp, DeserializationContext ctxt)
            throws IOException, JsonProcessingException {

        ObjectCodec oc = jp.getCodec();
        JsonNode node = oc.readTree(jp);

        //Your code here to customize deserialization
        // You can access {target class} as targetClass (defined class field here)
        //This should build some {deserializedClasObject}

        return deserializedClasObject;

    }   

    @Override
    public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property){
        //Find here the targetClass to be deserialized  
        String targetClassName=ctxt.getContextualType().toCanonical();
        try {
            targetClass = Class.forName(targetClassName);
        } catch (ClassNotFoundException e) {            
            e.printStackTrace();
        }
        return this;
    }
}

Answer 2

如果目标本身是泛型类型，则属性将为null，因此需要从反序列化上下文中获取valueTtype：

@Override
public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException {
    if (property == null) { //  context is generic
        JMapToListParser parser = new JMapToListParser();
        parser.valueType = ctxt.getContextualType().containedType(0);
        return parser;
    } else {  //  property is generic
        JavaType wrapperType = property.getType();
        JavaType valueType = wrapperType.containedType(0);
        JMapToListParser parser = new JMapToListParser();
        parser.valueType = valueType;
        return parser;
    }
}

Answer 3

您可以为泛型类型实现自定义的JsonDeserializer，它还实现了ContextualDeserializer。

例如，假设我们有以下包含泛型值的简单包装器类型：

public static class Wrapper<T> {
    public T value;
}

我们现在想要反序列化JSON，如下所示：

{
    "name": "Alice",
    "age": 37
}

一个类的实例，如下所示：

public static class Person {
    public Wrapper<String> name;
    public Wrapper<Integer> age;
}

实现ContextualDeserializer允许我们基于字段的泛型类型参数为Person类中的每个字段创建特定的反序列化器。这允许我们将名称反序列化为字符串，将年龄反序列化为整数。

完整的反序列化程序如下所示：

public static class WrapperDeserializer extends JsonDeserializer<Wrapper<?>> implements ContextualDeserializer {
    private JavaType valueType;

    @Override
    public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException {
        JavaType wrapperType = property.getType();
        JavaType valueType = wrapperType.containedType(0);
        WrapperDeserializer deserializer = new WrapperDeserializer();
        deserializer.valueType = valueType;
        return deserializer;
    }

    @Override
    public Wrapper<?> deserialize(JsonParser parser, DeserializationContext ctxt) throws IOException {
        Wrapper<?> wrapper = new Wrapper<>();
        wrapper.value = ctxt.readValue(parser, valueType);
        return wrapper;
    }
}

最好先看看这里的createContext，因为Jackson将首先调用它。我们从BeanProperty（例如，包装器）中读取字段的类型

一旦在这个新创建的反序列化器上调用了反序列化，我们可以简单地要求Jackson将值反序列化为内部类型，而不是整个包装类型，并返回一个包含反序列化值的新的包装。

为了注册这个自定义反序列化器，我们需要创建一个包含它的模块，并注册该模块：

SimpleModule module = new SimpleModule()
        .addDeserializer(Wrapper.class, new WrapperDeserializer());

ObjectMapper objectMapper = new ObjectMapper();
objectMapper.registerModule(module);

如果我们尝试从上面反序列化示例JSON，我们可以看到它按预期工作：

Person person = objectMapper.readValue(json, Person.class);
System.out.println(person.name.value);  // prints Alice
System.out.println(person.age.value);   // prints 37

还有一些关于上下文反序列化器如何在Jackson留档中工作的详细信息。