第三方类的Jackson JSON自定义类实例化器

Question

我使用的是只能使用生成器创建的第三方POJO类RetryOptions。生成器只能使用静态方法RetryOptions实例化。newBuilder（），或通过调用选项。现有实例上的toBuilder（）。

我想为第三方POJO（RetryOptions）创建自定义反/序列化器。我的第一种方法是将对象编写为构建器，然后将对象作为构建器读取并返回构建结果：

    class RetryOptionsSerializer extends StdSerializer<RetryOptions> {
        @Override
        public void serialize(RetryOptions value, JsonGenerator gen, SerializerProvider provider) throws IOException {
            // Save as a builder
            gen.writeObject(value.toBuilder());
        }
    }
    class RetryOptionsDeserializer extends StdDeserializer<RetryOptions> {
        @Override
        public RetryOptions deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
            // Read as builder, then build
            return p.readValueAs(RetryOptions.Builder.class).build();
        }
    }

但问题是Jackson不知道如何创建RetryOptions. Builder的实例以填充它的字段。

是否有一种方法可以指导Jackson如何创建生成器实例，但让Jackson处理字段的解析、反射和分配？

也许是这样的：

    class RetryOptionsDeserializer extends StdDeserializer<RetryOptions> {
        @Override
        public RetryOptions deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
            // Read as builder, then build
            var builder = RetryOptions.newBuilder();
            return p.readValueInto(builder).build();
        }
    }

或者，也许有一种方法可以告诉对象映射器如何创建RetryOptions的实例。建筑商：

var mapper = new ObjectMapper();
mapper.registerValueInstantiator(RetryOptions.Builder, () -> RetryOptions.newBuilder());

或者有没有其他方法可以在不诉诸我自己的反射逻辑或第三方类的暴力复制的情况下解决这个问题？

注意：我的解决方案必须使用Jackson JSON库（没有Guava等）。注意：这个第三方库中有几个类遇到了相同的问题，所以通用解决方案很有用

Answer 1

如果您出于任何原因无法使用委托反序列化方法来最初创建对象，那么这里还涉及到另一种看似黑暗的魔力。为了让引用恢复工作，我使用了@GordonBean描述的DelegatingDeserializer，但必须添加以下内容：

    public Object deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {


        final EntityCreateSpec spec = ctxt.readValue(p, EntityCreateSpec.class);
        try {
            final Entity entity = engine.createEntity(
                            (Class<? extends Entity>) ctxt.findClass(spec.getClazz()),
                            spec.getId(),
                            spec.getComponent());

            // The Important Bit
            
            // Bind entities for back references.
            final ObjectIdReader reader = this.getObjectIdReader();
            final ReadableObjectId roid = ctxt.findObjectId(entity.getId(), reader.generator, reader.resolver);
            roid.bindItem(entity);

            // End Important Bit

            return entity;
        } catch (ClassNotFoundException | FactoryException e) {
            throw new RuntimeException("Unable to deserialize " + spec.getClazz(), e);
        }
    }

这里是反序列化的对象。注意：这使用委托对象生成器和解析器，使用上下文findObjectId创建可读对象id。从那里，我们将新创建的对象绑定到ReadableObjectId，以确保它稍后能够解析！

Answer 2

Jackson可以反序列化私有字段，只要它们有getter（请参阅https://www.baeldung.com/jackson-field-serializable-deserializable-or-not).

因此，事实证明，在我的场景中，我不需要通过构建器反序列化RetryOptions，我只需要能够构建一个RetryOptions的实例，Jackson可以使用它来填充字段。

由于我有多个具有相同约束的类（第三方类上没有公共构造函数），我编写了以下方法来从供应商lambda生成ValueInstantiators：

static ValueInstantiator createDefaultValueInstantiator(DeserializationConfig config, JavaType valueType, Supplier<?> creator) {
    class Instantiator extends StdValueInstantiator {
        public Instantiator(DeserializationConfig config, JavaType valueType) {
            super(config, valueType);
        }

        @Override
        public boolean canCreateUsingDefault() {
            return true;
        }

        @Override
        public Object createUsingDefault(DeserializationContext ctxt) {
            return creator.get();
        }
    }

    return new Instantiator(config, valueType);
}

然后我为我的每个类注册了ValueInstantiators，例如：

var mapper = new ObjectMapper();
var module = new SimpleModule()
        .addValueInstantiator(
                RetryOptions.class,
                createDefaultValueInstantiator(
                        mapper.getDeserializationConfig(),
                        mapper.getTypeFactory().constructType(RetryOptions.class),
                        () -> RetryOptions.newBuilder().validateBuildWithDefaults()
                )
        )
        .addValueInstantiator(
                ActivityOptions.class,
                createDefaultValueInstantiator(
                        mapper.getDeserializationConfig(),
                        mapper.getTypeFactory().constructType(ActivityOptions.class),
                        () -> ActivityOptions.newBuilder().validateAndBuildWithDefaults()
                )
        );

mapper.registerModule(module);

不需要自定义反序列化程序。

我找到了一个方法。

首先，为类定义一个值实例化器。Jackson文档强烈鼓励您扩展StdValueInstantiator。

在我的场景中，我只需要“default”（无参数）实例化器，因此我覆盖了canCreateUsingDefault和createUsingDefault方法。

如果需要，还可以使用其他方法从参数创建。

    class RetryOptionsBuilderValueInstantiator extends StdValueInstantiator {

        public RetryOptionsBuilderValueInstantiator(DeserializationConfig config, JavaType valueType) {
            super(config, valueType);
        }

        @Override
        public boolean canCreateUsingDefault() {
            return true;
        }

        @Override
        public Object createUsingDefault(DeserializationContext ctxt) throws IOException {
            return RetryOptions.newBuilder();
        }
    }

然后我用ObjectMapper注册我的ValueInstantiator：

var mapper = new ObjectMapper();

var module = new SimpleModule();

module.addDeserializer(RetryOptions.class, new RetryOptionsDeserializer());
module.addSerializer(RetryOptions.class, new RetryOptionsSerializer());

module.addValueInstantiator(
    RetryOptions.Builder.class, 
    new RetryOptionsBuilderValueInstantiator(
                mapper.getDeserializationConfig(),
                mapper.getTypeFactory().constructType(RetryOptions.Builder.class))
);
mapper.registerModule(module);

现在我可以反序列化RetryOptions的实例，如下所示：

var options = RetryOptions.newBuilder()
                .setInitialInterval(Duration.ofMinutes(1))
                .setMaximumAttempts(7)
                .setBackoffCoefficient(1.0)
                .build();
var json = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(options);
var moreOptions = mapper.readValue(json, RetryOptions.class);

注意：我的解决方案使用了问题中定义的反序列化器，即先将RetryOptions实例转换为builder，然后再反序列化回builder和building以恢复实例。

原始答复结束