如何将依赖项注入杰克逊自定义反序列化器

Question

我想为某些字符串类型的字段启用自定义杰克逊反序列化器。反序列化器还需要注入一个基于 guice 的依赖 bean。示例代码如下：

public class CustomDeserializer extends StdDeserializer<String> {

    private SomeDependecy dependency;

    public StringDeserializer() {
        this(null);
    }

    public StringDeserializer(Class<?> vc) {
        super(vc);
    }

    @Override
    public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
        return dependency.perform(p.getValueAsString());
    }
}

我无法注册基于类类型的模块，因为它是通用的（String.class、复杂数据类型（但不是每个都需要自定义反序列化器））。有没有办法在不使用静态方法的情况下实现上述目标？

PS：我确实搜索过网络，但如果不使用 statics 就找不到更清洁的解决方案。使用一些静态方法获取上下文和 bean 的所有建议。

Answer 1

看起来还有另一种方法（感谢我的一位同事）在 objectMapper 实例上使用 injectableValues，然后通过 DeserializationContext ctxt 获取依赖项。以下是代码。

ObjectMapper guice 模块。

public class MerchantConverterModule extends AbstractModule {

    @Override
    protected void configure() {

    }

    @Provides
    @Singleton
    public ObjectMapper objectMapper() {

        ObjectMapper objectMapper = new ObjectMapper();

        /**
         * Add dependency object to object mapper.
         */
        objectMapper.setInjectableValues(new InjectableValues
            .Std()
            .addValue("DependencyName", dependency));

        return objectMapper;
    }


}

自定义反序列化器的代码

public class CustomDeserializer extends StdDeserializer<String> {

    private SomeDependecy dependency;

    public StringDeserializer() {
        this(null);
    }

    @Override
    public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
        return getDependency(ctxt).perform(p.getValueAsString());
    }

    private SomeDependency getDependency(DeserializationContext ctxt) {
        SomeDependency dependency = (SomeDependency) ctxt
                .findInjectableValue("DependencyName", null, null);

        return dependency;
    }
}

findInjectableValue 方法是 final 方法，因此您可能需要调整单元测试代码以模拟 final。

注意： 缺点是对象映射器和反序列化器之间存在紧密耦合。

Answer 2

看看ContextualDeserializer 接口。来自文档：

JsonDeserializers 可以实现的附加接口以获得一个 可用于创建上下文的回调（依赖于上下文） 用于处理支持的属性的解串器实例 类型。这对于可以通过以下方式配置的解串器很有用 注释，或者应该有不同的行为取决于 正在反序列化什么样的属性。

假设你有简单的解密接口和实现结构。

interface Dependency {

    String decrypt(String value);
}

class SomeDependency implements Dependency {

    public SomeDependency() {
        System.out.println("Create new SomeDependency!");
    }

    @Override
    public String decrypt(String value) {
        return value.replace('a', 'A');
    }
}

class DecryptModule extends AbstractModule {

    @Override
    protected void configure() {
        bind(Dependency.class).to(SomeDependency.class);
    }
}

您的自定义反序列化器可能如下所示：

class DecryptDeserializer extends StdDeserializer<String> implements ContextualDeserializer {

    private Dependency dependency;

    public DecryptDeserializer() {
        super(String.class);
    }

    @Override
    public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        return dependency.decrypt(p.getValueAsString());
    }

    @Override
    public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) {
        Injector injector = Guice.createInjector(new DecryptModule());
        DecryptDeserializer deserializer = new DecryptDeserializer();
        deserializer.dependency = injector.getInstance(Dependency.class);

        return deserializer;
    }
}

createContextual 方法用于创建新的反序列化器实例。你有很多选择如何创建它。您甚至可以将此解决方案与Static Injection 混合使用。

Answer 3

我没怎么用过Guice，但我猜它和Spring有点相似。因此，我将在此处发布此答案，以防您可以使用与我相同的原则，并且使用 Spring 的人会阅读此内容。

首先我将我的 Jackson 模块注释为 Spring @Component：

@Component
public class FlowModule extends SimpleModule {

@Autowired private SupplierItemDeserializer supplierItemDeserializer;

这意味着我可以将任何我想要的@Autowired 放入我的模块中。正如你所看到的，我也对我的反序列化器做了同样的事情：

@Component
public class SupplierItemDeserializer extends JsonDeserializer<SupplierItem> {

@Autowired
private SupplierService supplierService;

然后我创建了一个服务来处理与 JSON 之间的转换：

@Service
public class IOService {

private ObjectMapper mapper;

@Autowired
private FlowModule flowModule;


@PostConstruct
public void initialize() {
    mapper = new ObjectMapper();
    mapper.registerModule(flowModule);
    mapper.registerModule(new JavaTimeModule());
}

该服务包含一个带有我的模块的 ObjectMapper，该模块具有所有正确的接线。