DATAREDIS-392 - Add Gerneric Jackson2 RedisSerializer.
We introduced GenericJackson2JsonRedisSerializer holding a preconfigured ObjectMapper which writes Class type informations into the JSON structure. This enables polymorphic deserialization and allows RedisCache manager to operate upon a RedisTemplate storing data in JSON format, which had until this only been possible using the Jdk Serializer.
This commit is contained in:
Christoph Strobl
committed by
Oliver Gierke
Oliver Gierke
parent
9a6a892a48
commit
35424bb9da
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2013 - 2014 the original author or authors.
|
||||
* Copyright 2013 - 2015 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -27,6 +27,7 @@ import org.springframework.data.redis.RawObjectFactory;
|
||||
import org.springframework.data.redis.SettingsUtils;
|
||||
import org.springframework.data.redis.StringObjectFactory;
|
||||
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
|
||||
import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
|
||||
import org.springframework.data.redis.serializer.GenericToStringSerializer;
|
||||
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
|
||||
import org.springframework.data.redis.serializer.JacksonJsonRedisSerializer;
|
||||
@@ -115,6 +116,12 @@ abstract public class AbstractOperationsTestParams {
|
||||
jackson2JsonPersonTemplate.setValueSerializer(jackson2JsonSerializer);
|
||||
jackson2JsonPersonTemplate.afterPropertiesSet();
|
||||
|
||||
GenericJackson2JsonRedisSerializer genericJackson2JsonSerializer = new GenericJackson2JsonRedisSerializer();
|
||||
RedisTemplate<String, Person> genericJackson2JsonPersonTemplate = new RedisTemplate<String, Person>();
|
||||
genericJackson2JsonPersonTemplate.setConnectionFactory(jedisConnectionFactory);
|
||||
genericJackson2JsonPersonTemplate.setValueSerializer(genericJackson2JsonSerializer);
|
||||
genericJackson2JsonPersonTemplate.afterPropertiesSet();
|
||||
|
||||
return Arrays.asList(new Object[][] { //
|
||||
{ stringTemplate, stringFactory, stringFactory }, //
|
||||
{ longTemplate, stringFactory, longFactory }, //
|
||||
@@ -124,7 +131,7 @@ abstract public class AbstractOperationsTestParams {
|
||||
{ xstreamStringTemplate, stringFactory, stringFactory }, //
|
||||
{ xstreamPersonTemplate, stringFactory, personFactory }, //
|
||||
{ jsonPersonTemplate, stringFactory, personFactory }, //
|
||||
{ jackson2JsonPersonTemplate, stringFactory, personFactory } //
|
||||
});
|
||||
{ jackson2JsonPersonTemplate, stringFactory, personFactory }, //
|
||||
{ genericJackson2JsonPersonTemplate, stringFactory, personFactory } });
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,228 @@
|
||||
/*
|
||||
* Copyright 2015 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.springframework.data.redis.serializer;
|
||||
|
||||
import static org.hamcrest.core.Is.*;
|
||||
import static org.hamcrest.core.IsNull.*;
|
||||
import static org.junit.Assert.*;
|
||||
import static org.mockito.Matchers.*;
|
||||
import static org.mockito.Mockito.*;
|
||||
import static org.springframework.test.util.ReflectionTestUtils.*;
|
||||
import static org.springframework.util.ObjectUtils.*;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonTypeInfo;
|
||||
import com.fasterxml.jackson.core.JsonGenerationException;
|
||||
import com.fasterxml.jackson.core.JsonProcessingException;
|
||||
import com.fasterxml.jackson.databind.JsonMappingException;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.fasterxml.jackson.databind.jsontype.TypeResolverBuilder;
|
||||
import com.fasterxml.jackson.databind.type.TypeFactory;
|
||||
|
||||
/**
|
||||
* @author Christoph Strobl
|
||||
*/
|
||||
public class GenericJackson2JsonRedisSerializerUnitTests {
|
||||
|
||||
private static final SimpleObject SIMPLE_OBJECT = new SimpleObject(1L);
|
||||
private static final ComplexObject COMPLEX_OBJECT = new ComplexObject("steelheart", SIMPLE_OBJECT);
|
||||
|
||||
/**
|
||||
* @see DATAREDIS-392
|
||||
*/
|
||||
@Test
|
||||
public void shouldUseDefaultTyping() {
|
||||
assertThat(extractTypeResolver(new GenericJackson2JsonRedisSerializer()), notNullValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* @see DATAREDIS-392
|
||||
*/
|
||||
@Test
|
||||
public void shouldUseDefaultTypingWhenClassPropertyNameIsEmpty() {
|
||||
|
||||
TypeResolverBuilder<?> typeResolver = extractTypeResolver(new GenericJackson2JsonRedisSerializer(""));
|
||||
assertThat((String) getField(typeResolver, "_typeProperty"), is(JsonTypeInfo.Id.CLASS.getDefaultPropertyName()));
|
||||
}
|
||||
|
||||
/**
|
||||
* @see DATAREDIS-392
|
||||
*/
|
||||
@Test
|
||||
public void shouldUseDefaultTypingWhenClassPropertyNameIsNull() {
|
||||
|
||||
TypeResolverBuilder<?> typeResolver = extractTypeResolver(new GenericJackson2JsonRedisSerializer((String) null));
|
||||
assertThat((String) getField(typeResolver, "_typeProperty"), is(JsonTypeInfo.Id.CLASS.getDefaultPropertyName()));
|
||||
}
|
||||
|
||||
/**
|
||||
* @see DATAREDIS-392
|
||||
*/
|
||||
@Test
|
||||
public void shouldUseDefaultTypingWhenClassPropertyNameIsProvided() {
|
||||
|
||||
TypeResolverBuilder<?> typeResolver = extractTypeResolver(new GenericJackson2JsonRedisSerializer("firefight"));
|
||||
assertThat((String) getField(typeResolver, "_typeProperty"), is("firefight"));
|
||||
}
|
||||
|
||||
/**
|
||||
* @see DATAREDIS-392
|
||||
*/
|
||||
@Test
|
||||
public void serializeShouldReturnEmptyByteArrayWhenSouceIsNull() {
|
||||
assertThat(new GenericJackson2JsonRedisSerializer().serialize(null), is(SerializationUtils.EMPTY_ARRAY));
|
||||
}
|
||||
|
||||
/**
|
||||
* @see DATAREDIS-392
|
||||
*/
|
||||
@Test
|
||||
public void deserializeShouldReturnNullWhenSouceIsNull() {
|
||||
assertThat(new GenericJackson2JsonRedisSerializer().deserialize(null), nullValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* @see DATAREDIS-392
|
||||
*/
|
||||
@Test
|
||||
public void deserializeShouldReturnNullWhenSouceIsEmptyArray() {
|
||||
assertThat(new GenericJackson2JsonRedisSerializer().deserialize(SerializationUtils.EMPTY_ARRAY), nullValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* @see DATAREDIS-392
|
||||
*/
|
||||
@Test
|
||||
public void deserializeShouldBeAbleToRestoreSimpleObjectAfterSerialization() {
|
||||
|
||||
GenericJackson2JsonRedisSerializer serializer = new GenericJackson2JsonRedisSerializer();
|
||||
|
||||
assertThat((SimpleObject) serializer.deserialize(serializer.serialize(SIMPLE_OBJECT)), is(SIMPLE_OBJECT));
|
||||
}
|
||||
|
||||
/**
|
||||
* @see DATAREDIS-392
|
||||
*/
|
||||
@Test
|
||||
public void deserializeShouldBeAbleToRestoreComplexObjectAfterSerialization() {
|
||||
|
||||
GenericJackson2JsonRedisSerializer serializer = new GenericJackson2JsonRedisSerializer();
|
||||
|
||||
assertThat((ComplexObject) serializer.deserialize(serializer.serialize(COMPLEX_OBJECT)), is(COMPLEX_OBJECT));
|
||||
}
|
||||
|
||||
/**
|
||||
* @see DATAREDIS-392
|
||||
*/
|
||||
@Test(expected = SerializationException.class)
|
||||
public void serializeShouldThrowSerializationExceptionProcessingError() throws JsonProcessingException {
|
||||
|
||||
ObjectMapper objectMapperMock = mock(ObjectMapper.class);
|
||||
when(objectMapperMock.writeValueAsBytes(anyObject())).thenThrow(new JsonGenerationException("nightwielder"));
|
||||
|
||||
new GenericJackson2JsonRedisSerializer(objectMapperMock).serialize(SIMPLE_OBJECT);
|
||||
}
|
||||
|
||||
/**
|
||||
* @see DATAREDIS-392
|
||||
*/
|
||||
@Test(expected = SerializationException.class)
|
||||
public void deserializeShouldThrowSerializationExceptionProcessingError() throws IOException {
|
||||
|
||||
ObjectMapper objectMapperMock = mock(ObjectMapper.class);
|
||||
when(objectMapperMock.readValue(any(byte[].class), any(Class.class)))
|
||||
.thenThrow(new JsonMappingException("conflux"));
|
||||
|
||||
new GenericJackson2JsonRedisSerializer(objectMapperMock).deserialize(new byte[] { 1 });
|
||||
}
|
||||
|
||||
private TypeResolverBuilder<?> extractTypeResolver(GenericJackson2JsonRedisSerializer serializer) {
|
||||
|
||||
ObjectMapper mapper = (ObjectMapper) getField(serializer, "mapper");
|
||||
return mapper.getSerializationConfig().getDefaultTyper(TypeFactory.defaultInstance().constructType(Object.class));
|
||||
}
|
||||
|
||||
static class ComplexObject {
|
||||
|
||||
public String stringValue;
|
||||
public SimpleObject simpleObject;
|
||||
|
||||
public ComplexObject() {}
|
||||
|
||||
public ComplexObject(String stringValue, SimpleObject simpleObject) {
|
||||
this.stringValue = stringValue;
|
||||
this.simpleObject = simpleObject;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode() {
|
||||
return nullSafeHashCode(stringValue) + nullSafeHashCode(simpleObject);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object obj) {
|
||||
if (this == obj) {
|
||||
return true;
|
||||
}
|
||||
if (obj == null) {
|
||||
return false;
|
||||
}
|
||||
if (!(obj instanceof ComplexObject)) {
|
||||
return false;
|
||||
}
|
||||
ComplexObject other = (ComplexObject) obj;
|
||||
return nullSafeEquals(this.stringValue, other.stringValue)
|
||||
&& nullSafeEquals(this.simpleObject, other.simpleObject);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class SimpleObject {
|
||||
|
||||
public Long longValue;
|
||||
|
||||
public SimpleObject() {}
|
||||
|
||||
public SimpleObject(Long longValue) {
|
||||
this.longValue = longValue;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode() {
|
||||
return nullSafeHashCode(this.longValue);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object obj) {
|
||||
|
||||
if (this == obj) {
|
||||
return true;
|
||||
}
|
||||
if (obj == null) {
|
||||
return false;
|
||||
}
|
||||
if (!(obj instanceof SimpleObject)) {
|
||||
return false;
|
||||
}
|
||||
SimpleObject other = (SimpleObject) obj;
|
||||
return nullSafeEquals(this.longValue, other.longValue);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user