Package org.springframework.data.redis.serializer

Class GenericJackson2JsonRedisSerializer

java.lang.Object

org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer

All Implemented Interfaces:

RedisSerializer<Object>

public class GenericJackson2JsonRedisSerializer
extends Object
implements RedisSerializer<Object>

Generic Jackson 2-based RedisSerializer that maps objects to JSON using dynamic typing.

JSON reading and writing can be customized by configuring JacksonObjectReader respective JacksonObjectWriter.

Since:

1.6

Author:

Christoph Strobl, Mark Paluch, Mao Shuai, John Blum

Constructor Summary

Constructors

Constructor	Description
GenericJackson2JsonRedisSerializer()	Creates GenericJackson2JsonRedisSerializer and configures ObjectMapper for default typing.
GenericJackson2JsonRedisSerializer(com.fasterxml.jackson.databind.ObjectMapper mapper)	Setting a custom-configured ObjectMapper is one way to take further control of the JSON serialization process.
GenericJackson2JsonRedisSerializer(com.fasterxml.jackson.databind.ObjectMapper mapper, JacksonObjectReader reader, JacksonObjectWriter writer)	Setting a custom-configured ObjectMapper is one way to take further control of the JSON serialization process.
GenericJackson2JsonRedisSerializer(String classPropertyTypeName)	Creates GenericJackson2JsonRedisSerializer and configures ObjectMapper for default typing using the given name.
GenericJackson2JsonRedisSerializer(String classPropertyTypeName, JacksonObjectReader reader, JacksonObjectWriter writer)	Creates GenericJackson2JsonRedisSerializer and configures ObjectMapper for default typing using the given name.

Method Summary

Modifier and Type	Method	Description
GenericJackson2JsonRedisSerializer	configure(Consumer<com.fasterxml.jackson.databind.ObjectMapper> objectMapperConfigurer)	Builder method used to configure and customize the internal Jackson ObjectMapper created by this GenericJackson2JsonRedisSerializer and used to de/serialize objects as JSON.
Object	deserialize(byte[] source)	Deserialize an object from the given binary data.
<T> T	deserialize(byte[] source, Class<T> type)
protected com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()	Gets the configured ObjectMapper used internally by this GenericJackson2JsonRedisSerializer to de/serialize objects as JSON.
static void	registerNullValueSerializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper, String classPropertyTypeName)	Register GenericJackson2JsonRedisSerializer.NullValueSerializer in the given ObjectMapper with an optional classPropertyTypeName.
protected com.fasterxml.jackson.databind.JavaType	resolveType(byte[] source, Class<?> type)
byte[]	serialize(Object value)	Serialize the given object to binary data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.redis.serializer.RedisSerializer

canSerialize, getTargetType

Constructor Details

GenericJackson2JsonRedisSerializer

public GenericJackson2JsonRedisSerializer()

Creates GenericJackson2JsonRedisSerializer and configures ObjectMapper for default typing.

GenericJackson2JsonRedisSerializer

public GenericJackson2JsonRedisSerializer(@Nullable
 String classPropertyTypeName)

Creates GenericJackson2JsonRedisSerializer and configures ObjectMapper for default typing using the given name. In case of an empty or null String the default JsonTypeInfo.Id.CLASS will be used.

Parameters:

classPropertyTypeName - name of the JSON property holding type information. Can be null.

See Also:

• ObjectMapper.activateDefaultTypingAsProperty(PolymorphicTypeValidator, DefaultTyping, String)
• ObjectMapper.activateDefaultTyping(PolymorphicTypeValidator, DefaultTyping, As)

GenericJackson2JsonRedisSerializer

public GenericJackson2JsonRedisSerializer(@Nullable
 String classPropertyTypeName,
 JacksonObjectReader reader,
 JacksonObjectWriter writer)

Creates GenericJackson2JsonRedisSerializer and configures ObjectMapper for default typing using the given name. In case of an empty or null String the default JsonTypeInfo.Id.CLASS will be used.

Parameters:

classPropertyTypeName - name of the JSON property holding type information. Can be null.

reader - the JacksonObjectReader function to read objects using ObjectMapper.

writer - the JacksonObjectWriter function to write objects using ObjectMapper.

Since:

3.0

See Also:

• ObjectMapper.activateDefaultTypingAsProperty(PolymorphicTypeValidator, DefaultTyping, String)
• ObjectMapper.activateDefaultTyping(PolymorphicTypeValidator, DefaultTyping, As)

GenericJackson2JsonRedisSerializer

public GenericJackson2JsonRedisSerializer(com.fasterxml.jackson.databind.ObjectMapper mapper)

Setting a custom-configured ObjectMapper is one way to take further control of the JSON serialization process. For example, an extended SerializerFactory can be configured that provides custom serializers for specific types.

Parameters:

mapper - must not be null.

GenericJackson2JsonRedisSerializer

public GenericJackson2JsonRedisSerializer(com.fasterxml.jackson.databind.ObjectMapper mapper,
 JacksonObjectReader reader,
 JacksonObjectWriter writer)

Setting a custom-configured ObjectMapper is one way to take further control of the JSON serialization process. For example, an extended SerializerFactory can be configured that provides custom serializers for specific types.

Parameters:

mapper - must not be null.

reader - the JacksonObjectReader function to read objects using ObjectMapper.

writer - the JacksonObjectWriter function to write objects using ObjectMapper.

Since:

3.0

Method Details

registerNullValueSerializer

public static void registerNullValueSerializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 @Nullable
 String classPropertyTypeName)

Register GenericJackson2JsonRedisSerializer.NullValueSerializer in the given ObjectMapper with an optional classPropertyTypeName. This method should be called by code that customizes GenericJackson2JsonRedisSerializer by providing an external ObjectMapper.

Parameters:

objectMapper - the object mapper to customize.

classPropertyTypeName - name of the type property. Defaults to @class if null/empty.

Since:

2.2

getObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Gets the configured ObjectMapper used internally by this GenericJackson2JsonRedisSerializer to de/serialize objects as JSON.

Returns:

the configured ObjectMapper.

serialize

public byte[] serialize(@Nullable
 Object value)
                 throws SerializationException

Description copied from interface: RedisSerializer

Serialize the given object to binary data.

Specified by:

serialize in interface RedisSerializer<Object>

Parameters:

value - object to serialize. Can be null.

Returns:

the equivalent binary data. Can be null.

Throws:

SerializationException

deserialize

public Object deserialize(@Nullable
 byte[] source)
                   throws SerializationException

Description copied from interface: RedisSerializer

Deserialize an object from the given binary data.

Specified by:

deserialize in interface RedisSerializer<Object>

Parameters:

source - object binary representation. Can be null.

Returns:

the equivalent object instance. Can be null.

Throws:

SerializationException

deserialize

@Nullable
public <T> T deserialize(@Nullable
 byte[] source,
 Class<T> type)
                  throws SerializationException

Parameters:

source - can be null.

type - must not be null.

Returns:

null for empty source.

Throws:

SerializationException

configure

public GenericJackson2JsonRedisSerializer configure(Consumer<com.fasterxml.jackson.databind.ObjectMapper> objectMapperConfigurer)

Builder method used to configure and customize the internal Jackson ObjectMapper created by this GenericJackson2JsonRedisSerializer and used to de/serialize objects as JSON.

Parameters:

objectMapperConfigurer - Consumer used to configure and customize the internal ObjectMapper; must not be null.

Returns:

this GenericJackson2JsonRedisSerializer.

Throws:

IllegalArgumentException - if the Consumer used to configure and customize the internal ObjectMapper is null.

resolveType

protected com.fasterxml.jackson.databind.JavaType resolveType(byte[] source,
 Class<?> type)
                                                       throws IOException

Throws:

IOException