Jackson ObjectMapper с использованием пользовательских сериализаторов и десериализаторов

У меня есть класс, который настраивает JackMark ObjectMapper. Он добавляет некоторые пользовательские сериализаторы и десериализаторы для моих типов объектов следующим образом:

public class JsonMapperFactory {
    public static ObjectMapper createObjectMapper() {
        final SimpleModule module = new SimpleModule("customerSerializationModule", new Version(1, 0, 0, "static version"));
        addCustomDeserializersTo(module);
        addCustomSerializersTo(module);

        final ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.registerModule(module);
        return objectMapper;
    }
    private static void addCustomSerializersTo(final SimpleModule module) {
        module.addSerializer(DateTime.class, new DateTimeSerializer());
    }
    private static void addCustomDeserializersTo(final SimpleModule objectMapper) {
        objectMapper.addDeserializer(DateTime.class, new DateTimeDeserializer());
    }
}

Я тестировал свои сериализаторы клиентов в своих собственных тестовых классах, поэтому в своем тестировании этого класса JsonMapperFactory я пытаюсь просто проверить, что созданный ObjectMapper имеет ожидаемые сериализаторы (или десериализаторы). Этого можно достичь путем инспектирования ObjectMapper, но у него нет никаких механизмов для этого.

Кто-нибудь знает хороший способ проверить это?

Для десериализаторов у меня есть следующее:

private void assertThatObjectMapperUsesCorrectDeserializer(final Class<?> typeClazz, final Class<?> deserializerClazz) throws JsonMappingException {
    final  DeserializationConfig deserializationConfig = this.objectMapper.getDeserializationConfig();
    final JsonDeserializer<Object> deserializer = this.objectMapper.getDeserializerProvider().findTypedValueDeserializer(deserializationConfig, javaTypeFor(typeClazz), null);
    assertThat(deserializer, is(instanceOf(deserializerClazz)));
}
private JavaType javaTypeFor(final Class<?> clazz) {
    return TypeFactory.type(clazz); //deprecated method :(
}

Что довольно многословно и использует устаревшие методы.

Мне еще предстоит найти способ сделать аналогичный тест для сериализаторов. Таким образом, я в настоящее время прибегал к сериализации объекта и проверял правильность его сериализации (по сути, дублирование теста serializer)

Любые идеи очень приветствуются.

Ответы

Ответ 1

Из ответов и комментариев, представленных здесь, я недавно переработал класс для использования сборщиков как для Module, так и для ObjectMapper. Это позволило мне предоставить mocks и проверить, что в модуль добавлены правильные (de) сериализаторы, а затем модуль зарегистрирован в mapperper объектов, как ожидалось.

Конструктор Map Mapper:

public class ObjectMapperBuilder {
    ObjectMapper mapper;

    public ObjectMapperBuilder configure(final ObjectMapper mapper) {
        this.mapper = mapper;
        return this;
    }

    public ObjectMapperBuilder withModule(final Module module) {
        this.mapper.registerModule(module);
        return this;
    }

    public ObjectMapper build() {
        return this.mapper;
    }
}

Модуль Builder:

public class SimpleModuleBuilder {
    SimpleModule module;

    public SimpleModuleBuilder configure(final SimpleModule module) {
        this.module = module;
        return this;
    }

    public <X> SimpleModuleBuilder withSerializer(final Class<X> clazz, final JsonSerializer<X> serializer) {
        this.module.addSerializer(clazz, serializer);
        return this;
    }

    public <X> SimpleModuleBuilder withDeserializer(final Class<X> clazz, final JsonDeserializer<X> deserializer) {
        this.module.addDeserializer(clazz, deserializer);
        return this;
    }

    public SimpleModule build() {
        return this.module;
    }
}

И, наконец, новый JsonMapperFactory:

public class JsonMapperFactory {

    public static ObjectMapper configureObjectMapper(final ObjectMapper mapper, final SimpleModule module) {
        final SimpleModuleBuilder modulebuilder = new SimpleModuleBuilder();

        final SimpleModule configuredModule = modulebuilder.configure(module)
            .withSerializer(DateTime.class, new DateTimeSerializer())
            .withDeserializer(DateTime.class, new DateTimeDeserializer())
            .build();

        final ObjectMapperBuilder objectMapperBuilder = new ObjectMapperBuilder();
        return objectMapperBuilder.configure(mapper).withModule(configuredModule).build();
    }
}

Метод factory по-прежнему используется в конфигурации Spring, но теперь конфигурация теперь создает пустые Module и ObjectMapper, прежде чем предоставлять их методам factory, которые затем настраивают их.

Ответ 2

Если JsonDeserializer (и DateTimeDeserializer тоже) был интерфейсом, вы могли бы легко "JMock", передать mocked-экземпляр на JsonMapperFactory#createObjectMapper, а затем ожидать ровно 1 вызов вашего пользовательского метода "serialize"; например

DateTimeSerializer serializer = context.mock(DateTimeSerializer.class);
DateTimeDeserializer serializer = context.mock(DateTimeDeserializer.class);
ObjectMapper mapper = JacksonMapperFactory.createObjectMapper(deserializer, serializer);

exactly(1).of(jsonDeserializer).serialize(myDateTime,
  with(any(JsonGenerator.class),
  with(any(SerializerProvider.class)))

Будучи конкретным классом, вы можете вместо этого определить новый (сериализованный) тестовой областью, который расширяет ваш пользовательский сериализатор DateTime (De) и просто подсчитывает вызов:

private static class DateTimeDeserializerWithCounter extends DateTimeDeserializer {
    public int counter = 0;

    @Override
    public DateTime deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {
        counter++;
        return super.deserialize(jsonParser, deserializationContext);
    }
}

@Test
public void usageTest(){
    //init mapper with the above DateTimeDeserializerWithCounter - see below
    mapper.readValue("...", DateTime.class);
    Assert.assertEquals(1, deserializer.counter);
}

Ниже моментального снимка более "тестового" Factory:

//package visibility, to allow passing different De/Serializers while testing
static ObjectMapper createObjectMapper(JsonDeserializer deserializer, JsonSerializer serializer) {
    final SimpleModule module = new SimpleModule("customerSerializationModule", new Version(1, 0, 0, "static version"));
    module.addDeserializer(DateTime.class, deserializer);
    module.addSerializer(DateTime.class, serializer);

    final ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.registerModule(module);
    return objectMapper;
}

//production method: no-args, as in the original version
public static ObjectMapper createObjectMapper() {
    return createObjectMapper(new DateTimeDeserializer(), new DateTimeSerializer());
}

Надеюсь, что это поможет.