Class GenericJacksonJsonRedisSerializer

java.lang.Object

org.springframework.data.redis.serializer.GenericJacksonJsonRedisSerializer

All Implemented Interfaces:

RedisJsonSerializer, RedisJsonSerializer.Splitter, RedisSerializer<Object>

public class GenericJacksonJsonRedisSerializer
extends Object
implements RedisJsonSerializer.Splitter

Generic Jackson 3-based RedisSerializer that maps objects to and from JSON.

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

Since:

4.0

Author:

Christoph Strobl, Moritz Halbritter

See Also:

• JacksonObjectReader
• JacksonObjectWriter
• ObjectMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B extends MapperBuilder<? extends ObjectMapper, ? extends MapperBuilder<?,?>>>	GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder wraps around a JsonMapper.Builder providing dedicated methods to configure aspects like NullValue serialization strategy for the resulting ObjectMapper to be used with GenericJacksonJsonRedisSerializer as well as potential Object/-reader and -writer settings.

Nested classes/interfaces inherited from interface RedisJsonSerializer

RedisJsonSerializer.Splitter

Constructor Summary

Constructors

Modifier	Constructor	Description
	GenericJacksonJsonRedisSerializer(ObjectMapper mapper)	Create a GenericJacksonJsonRedisSerializer with a custom-configured ObjectMapper.
protected	GenericJacksonJsonRedisSerializer(ObjectMapper mapper, JacksonObjectReader reader, JacksonObjectWriter writer)	Create a GenericJacksonJsonRedisSerializer with a custom-configured ObjectMapper considering potential Object/-reader and -writer.

Method Summary

Modifier and Type	Method	Description
static GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<JsonMapper.Builder>	builder()	Creates a new GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder to configure and build a GenericJacksonJsonRedisSerializer using JsonMapper.
static <B extends MapperBuilder<? extends ObjectMapper, ? extends MapperBuilder<?,?>>> GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B>	builder(Supplier<B> builderFactory)	Creates a new GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder to configure and build a GenericJacksonJsonRedisSerializer.
static GenericJacksonJsonRedisSerializer	create(Consumer<GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<JsonMapper.Builder>> configurer)	Prepare a new GenericJacksonJsonRedisSerializer instance.
@Nullable Object	deserialize(byte @Nullable [] source)	Deserialize an object from the given binary data.
<T> @Nullable T	deserialize(byte @Nullable [] source, Class<T> type)	Deserialized the array of bytes containing JSON as an Object of the given, required type.
@Nullable Object	deserialize(byte @Nullable [] source, ResolvableType type)	Deserialize the given source into an instance of the type described by ResolvableType.
byte[]	joinObject(Map<String,byte[]> members)	Create a JSON object from the given members.
protected JavaType	resolveType(byte[] source, Class<?> type)
byte[]	serialize(@Nullable Object value)	Serialize the given object to binary data.
List<byte[]>	splitArray(byte[] source)	Extract immediate elements of a JSON array as individual JSON values.
Map<String,byte[]>	splitObject(byte[] source)	Extract the immediate members of a JSON object as individual JSON values.
RedisJsonSerializer.Splitter	splitter()	Return a RedisJsonSerializer.Splitter for this serializer.

Methods inherited from class Object

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

Methods inherited from interface RedisJsonSerializer

deserialize

Methods inherited from interface RedisSerializer

canSerialize, getTargetType

Constructor Details

GenericJacksonJsonRedisSerializer

public GenericJacksonJsonRedisSerializer(ObjectMapper mapper)

Create a GenericJacksonJsonRedisSerializer with a custom-configured ObjectMapper.

Parameters:

mapper - must not be null.

GenericJacksonJsonRedisSerializer

protected GenericJacksonJsonRedisSerializer(ObjectMapper mapper,
 JacksonObjectReader reader,
 JacksonObjectWriter writer)

Create a GenericJacksonJsonRedisSerializer with a custom-configured ObjectMapper considering potential Object/-reader and -writer.

Parameters:

mapper - must not be null.

reader - the JacksonObjectReader function to read objects using ObjectMapper.

writer - the JacksonObjectWriter function to write objects using ObjectMapper.

Method Details

create

public static GenericJacksonJsonRedisSerializer create(Consumer<GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<JsonMapper.Builder>> configurer)

Prepare a new GenericJacksonJsonRedisSerializer instance.

Parameters:

configurer - the configurer for GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder.

Returns:

new instance of GenericJacksonJsonRedisSerializer.

builder

public static GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<JsonMapper.Builder> builder()

Creates a new GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder to configure and build a GenericJacksonJsonRedisSerializer using JsonMapper.

Returns:

a new GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder.

builder

public static <B extends MapperBuilder<? extends ObjectMapper, ? extends MapperBuilder<?,?>>>
GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder<B> builder(Supplier<B> builderFactory)

Creates a new GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder to configure and build a GenericJacksonJsonRedisSerializer.

Type Parameters:

B - type of the MapperBuilder to use.

Parameters:

builderFactory - factory to create a MapperBuilder for the ObjectMapper.

Returns:

a new GenericJacksonJsonRedisSerializer.GenericJacksonJsonRedisSerializerBuilder.

serialize

@Contract("_ -> !null")
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 an empty array but never null.

Throws:

SerializationException

deserialize

@Contract("null -> null")
public @Nullable Object deserialize(byte @Nullable [] 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

@Contract("null, _ -> null")
public <T> @Nullable T deserialize(byte @Nullable [] source,
 Class<T> type)
                            throws SerializationException

Deserialized the array of bytes containing JSON as an Object of the given, required type.

Specified by:

deserialize in interface RedisSerializer<Object>

Parameters:

source - array of bytes containing the JSON to deserialize; can be null.

type - type of Object from which the JSON will be deserialized; must not be null.

Returns:

null for an empty source, or an Object of the given type deserialized from the array of bytes containing JSON.

Throws:

IllegalArgumentException - if the given type is null.

SerializationException - if the array of bytes cannot be deserialized as an instance of the given type

deserialize

@Contract("null, _ -> null")
public @Nullable Object deserialize(byte @Nullable [] source,
 ResolvableType type)
                             throws SerializationException

Description copied from interface: RedisJsonSerializer

Deserialize the given source into an instance of the type described by ResolvableType.

Use this variant for generic types such as List<Person> that cannot be expressed as a Class.

Specified by:

deserialize in interface RedisJsonSerializer

Parameters:

source - the JSON bytes to read.

type - the target type.

Returns:

the deserialized object, or null if source is empty or represents JSON null.

Throws:

SerializationException - if the JSON cannot be deserialized.

splitter

public RedisJsonSerializer.Splitter splitter()

Description copied from interface: RedisJsonSerializer

Return a RedisJsonSerializer.Splitter for this serializer.

Specified by:

splitter in interface RedisJsonSerializer

splitArray

public List<byte[]> splitArray(byte[] source)
                        throws SerializationException

Description copied from interface: RedisJsonSerializer.Splitter

Extract immediate elements of a JSON array as individual JSON values.

Note: The default implementation deserializes the array and serializes each element separately. This may change number formatting or precision. For example, 1.10 may become 1.1. Implementations should override this method to preserve the original bytes of each element.

Specified by:

splitArray in interface RedisJsonSerializer.Splitter

Parameters:

source - the JSON array to read.

Returns:

the JSON bytes for each element in array order, or an empty list if the array is empty.

Throws:

SerializationException - if the source is not a JSON array or cannot be read.

splitObject

public Map<String,byte[]> splitObject(byte[] source)
                               throws SerializationException

Description copied from interface: RedisJsonSerializer.Splitter

Extract the immediate members of a JSON object as individual JSON values.

Note: Map keys contain the unescaped member names. Values contain the JSON bytes for each member. The default implementation deserializes the object and serializes each member value separately. See RedisJsonSerializer.Splitter.splitArray(byte[]) for the effect on number formatting and precision.

Specified by:

splitObject in interface RedisJsonSerializer.Splitter

Parameters:

source - the JSON object to read.

Returns:

the members in source order, or an empty map if the object is empty.

Throws:

SerializationException - if the source is not a JSON object or cannot be read.

joinObject

public byte[] joinObject(Map<String,byte[]> members)
                  throws SerializationException

Description copied from interface: RedisJsonSerializer.Splitter

Create a JSON object from the given members.

Map keys supply the member names, which are escaped as needed. Each value must contain a valid JSON value. Members are written in map iteration order.

Note: The default implementation deserializes the member values and serializes the resulting object. See RedisJsonSerializer.Splitter.splitArray(byte[]) for the effect on number formatting and precision. Implementations can override this method to preserve the supplied JSON bytes for each value.

Specified by:

joinObject in interface RedisJsonSerializer.Splitter

Parameters:

members - the member names and their JSON bytes.

Returns:

the JSON object as bytes, or the representation of {} if the map is empty.

Throws:

SerializationException - if the object cannot be written.

See Also:

• RedisJsonSerializer.Splitter.splitObject(byte[])

resolveType

protected JavaType resolveType(byte[] source,
 Class<?> type)
                        throws IOException

Throws:

IOException