Package org.springframework.data.redis.serializer

Class StringRedisSerializer

java.lang.Object

org.springframework.data.redis.serializer.StringRedisSerializer

All Implemented Interfaces:

RedisSerializer<String>

public class StringRedisSerializer
extends Object
implements RedisSerializer<String>

Simple String to byte[] (and back) serializer. Converts Strings into bytes and vice-versa using the specified charset (by default UTF-8).

Useful when the interaction with the Redis happens mainly through Strings.

Does not perform any null conversion since empty strings are valid keys/values.

Author:

Costin Leau, Christoph Strobl, Mark Paluch

Field Summary

Fields

Modifier and Type	Field	Description
static final StringRedisSerializer	ISO_8859_1	StringRedisSerializer to use ISO Latin Alphabet No. 1, a.k.a.
static final StringRedisSerializer	US_ASCII	StringRedisSerializer to use 7 bit ASCII, a.k.a.
static final StringRedisSerializer	UTF_8	StringRedisSerializer to use 8 bit UCS Transformation Format.

Constructor Summary

Constructors

Constructor	Description
StringRedisSerializer()	Creates a new StringRedisSerializer using UTF-8.
StringRedisSerializer(Charset charset)	Creates a new StringRedisSerializer using the given Charset to encode and decode strings.

Method Summary

Modifier and Type	Method	Description
String	deserialize(byte[] bytes)	Deserialize an object from the given binary data.
Class<?>	getTargetType()	Return the serializer target type.
byte[]	serialize(String 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

Field Details

US_ASCII

public static final StringRedisSerializer US_ASCII

StringRedisSerializer to use 7 bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.

Since:

2.1

See Also:

• StandardCharsets.US_ASCII

ISO_8859_1

public static final StringRedisSerializer ISO_8859_1

StringRedisSerializer to use ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.

Since:

2.1

See Also:

• StandardCharsets.ISO_8859_1

UTF_8

public static final StringRedisSerializer UTF_8

StringRedisSerializer to use 8 bit UCS Transformation Format.

Since:

2.1

See Also:

• StandardCharsets.UTF_8

Constructor Details

StringRedisSerializer

public StringRedisSerializer()

Creates a new StringRedisSerializer using UTF-8.

StringRedisSerializer

public StringRedisSerializer(Charset charset)

Creates a new StringRedisSerializer using the given Charset to encode and decode strings.

Parameters:

charset - must not be null.

Method Details

serialize

@Nullable
public byte[] serialize(@Nullable
 String value)

Description copied from interface: RedisSerializer

Serialize the given object to binary data.

Specified by:

serialize in interface RedisSerializer<String>

Parameters:

value - object to serialize. Can be null.

Returns:

the equivalent binary data. Can be null.

deserialize

@Nullable
public String deserialize(@Nullable
 byte[] bytes)

Description copied from interface: RedisSerializer

Deserialize an object from the given binary data.

Specified by:

deserialize in interface RedisSerializer<String>

Parameters:

bytes - object binary representation. Can be null.

Returns:

the equivalent object instance. Can be null.

getTargetType

public Class<?> getTargetType()

Description copied from interface: RedisSerializer

Return the serializer target type.

Specified by:

getTargetType in interface RedisSerializer<String>

Returns:

the serializer target type.