Skip to content

Commit 060e3fd

Browse files
mp911demp911de
committed
Refine RedisSerializer implementations.
This commit polishes up method ordering, introduces Javadoc where missing and updates nullability annotations and argument names. Closes #1097
1 parent 17320fb commit 060e3fd

13 files changed

+142
-120
lines changed

‎src/main/java/org/springframework/data/redis/serializer/ByteArrayRedisSerializer.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ enum ByteArrayRedisSerializer implements RedisSerializer<byte[]> {
2929

3030
@Nullable
3131
@Override
32-
public byte[] serialize(@Nullable byte[] bytes) throws SerializationException {
33-
return bytes;
32+
public byte[] serialize(@Nullable byte[] value) throws SerializationException {
33+
return value;
3434
}
3535

3636
@Nullable

‎src/main/java/org/springframework/data/redis/serializer/DefaultRedisElementReader.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class DefaultRedisElementReader<T> implements RedisElementReader<T> {
3131

3232
private final @Nullable RedisSerializer<T> serializer;
3333

34-
DefaultRedisElementReader(RedisSerializer<T> serializer) {
34+
DefaultRedisElementReader(@Nullable RedisSerializer<T> serializer) {
3535
this.serializer = serializer;
3636
}
3737

‎src/main/java/org/springframework/data/redis/serializer/DefaultRedisElementWriter.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class DefaultRedisElementWriter<T> implements RedisElementWriter<T> {
3535
}
3636

3737
@Override
38-
public ByteBuffer write(T value) {
38+
public ByteBuffer write(@Nullable T value) {
3939

4040
if (serializer != null && (value == null || serializer.canSerialize(value.getClass()))) {
4141
return ByteBuffer.wrap(serializer.serialize(value));
@@ -51,6 +51,5 @@ public ByteBuffer write(T value) {
5151

5252
throw new IllegalStateException(
5353
String.format("Cannot serialize value of type %s without a serializer", value.getClass()));
54-
5554
}
5655
}

‎src/main/java/org/springframework/data/redis/serializer/GenericJackson2JsonRedisSerializer.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,14 +198,14 @@ public static void registerNullValueSerializer(ObjectMapper objectMapper, @Nulla
198198
}
199199

200200
@Override
201-
public byte[] serialize(@Nullable Object source) throws SerializationException {
201+
public byte[] serialize(@Nullable Object value) throws SerializationException {
202202

203-
if (source == null) {
203+
if (value == null) {
204204
return SerializationUtils.EMPTY_ARRAY;
205205
}
206206

207207
try {
208-
return writer.write(mapper, source);
208+
return writer.write(mapper, value);
209209
} catch (IOException e) {
210210
throw new SerializationException("Could not write JSON: " + e.getMessage(), e);
211211
}

‎src/main/java/org/springframework/data/redis/serializer/GenericToStringSerializer.java‎

Lines changed: 36 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
import org.springframework.beans.TypeConverter;
2323
import org.springframework.beans.factory.BeanFactory;
2424
import org.springframework.beans.factory.BeanFactoryAware;
25-
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
2625
import org.springframework.core.convert.ConversionService;
2726
import org.springframework.core.convert.support.DefaultConversionService;
2827
import org.springframework.lang.Nullable;
@@ -42,8 +41,7 @@ public class GenericToStringSerializer<T> implements RedisSerializer<T>, BeanFac
4241

4342
private final Class<T> type;
4443
private final Charset charset;
45-
46-
private Converter converter = new Converter(new DefaultConversionService());
44+
private Converter converter;
4745

4846
public GenericToStringSerializer(Class<T> type) {
4947
this(type, StandardCharsets.UTF_8);
@@ -55,55 +53,64 @@ public GenericToStringSerializer(Class<T> type, Charset charset) {
5553

5654
this.type = type;
5755
this.charset = charset;
56+
this.converter = new Converter(DefaultConversionService.getSharedInstance());
5857
}
5958

59+
/**
60+
* Set the {@link ConversionService} to be used.
61+
*
62+
* @param conversionService the conversion service to be used, must not be {@literal null}.
63+
*/
6064
public void setConversionService(ConversionService conversionService) {
6165

62-
Assert.notNull(conversionService, "non null conversion service required");
66+
Assert.notNull(conversionService, "ConversionService must not be null");
67+
6368
converter = new Converter(conversionService);
6469
}
6570

71+
/**
72+
* Set the {@link TypeConverter} to be used.
73+
*
74+
* @param typeConverter the conversion service to be used, must not be {@literal null}.
75+
*/
6676
public void setTypeConverter(TypeConverter typeConverter) {
6777

68-
Assert.notNull(typeConverter, "non null type converter required");
78+
Assert.notNull(typeConverter, "TypeConverter must not be null");
79+
6980
converter = new Converter(typeConverter);
7081
}
7182

7283
@Override
73-
public T deserialize(@Nullable byte[] bytes) {
84+
public byte[] serialize(@Nullable T value) {
7485

75-
if (bytes == null) {
86+
if (value == null) {
7687
return null;
7788
}
7889

79-
String string = new String(bytes, charset);
80-
return converter.convert(string, type);
90+
String string = converter.convert(value, String.class);
91+
return string.getBytes(charset);
8192
}
8293

8394
@Override
84-
public byte[] serialize(@Nullable T object) {
85-
if (object == null) {
95+
public T deserialize(@Nullable byte[] bytes) {
96+
97+
if (bytes == null) {
8698
return null;
8799
}
88-
String string = converter.convert(object, String.class);
89-
return string.getBytes(charset);
100+
101+
String string = new String(bytes, charset);
102+
return converter.convert(string, type);
90103
}
91104

105+
@Override
92106
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
93-
94-
// TODO: This code can never happen...
95-
if (converter == null && beanFactory instanceof ConfigurableBeanFactory) {
96-
ConfigurableBeanFactory cFB = (ConfigurableBeanFactory) beanFactory;
97-
ConversionService conversionService = cFB.getConversionService();
98-
99-
converter = (conversionService != null ? new Converter(conversionService)
100-
: new Converter(cFB.getTypeConverter()));
101-
}
107+
// no-op
102108
}
103109

104-
private class Converter {
105-
private final ConversionService conversionService;
106-
private final TypeConverter typeConverter;
110+
private final static class Converter {
111+
112+
private final @Nullable ConversionService conversionService;
113+
private final @Nullable TypeConverter typeConverter;
107114

108115
public Converter(ConversionService conversionService) {
109116
this.conversionService = conversionService;
@@ -115,11 +122,11 @@ public Converter(TypeConverter typeConverter) {
115122
this.typeConverter = typeConverter;
116123
}
117124

125+
@Nullable
118126
<E> E convert(Object value, Class<E> targetType) {
119-
if (conversionService != null) {
120-
return conversionService.convert(value, targetType);
121-
}
122-
return typeConverter.convertIfNecessary(value, targetType);
127+
128+
return conversionService != null ? conversionService.convert(value, targetType)
129+
: typeConverter.convertIfNecessary(value, targetType);
123130
}
124131
}
125132
}

‎src/main/java/org/springframework/data/redis/serializer/Jackson2JsonRedisSerializer.java‎

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -126,32 +126,6 @@ public Jackson2JsonRedisSerializer(ObjectMapper mapper, JavaType javaType, Jacks
126126
this.javaType = javaType;
127127
}
128128

129-
@SuppressWarnings("unchecked")
130-
public T deserialize(@Nullable byte[] bytes) throws SerializationException {
131-
132-
if (SerializationUtils.isEmpty(bytes)) {
133-
return null;
134-
}
135-
try {
136-
return (T) this.reader.read(this.mapper, bytes, javaType);
137-
} catch (Exception ex) {
138-
throw new SerializationException("Could not read JSON: " + ex.getMessage(), ex);
139-
}
140-
}
141-
142-
@Override
143-
public byte[] serialize(@Nullable Object t) throws SerializationException {
144-
145-
if (t == null) {
146-
return SerializationUtils.EMPTY_ARRAY;
147-
}
148-
try {
149-
return this.writer.write(this.mapper, t);
150-
} catch (Exception ex) {
151-
throw new SerializationException("Could not write JSON: " + ex.getMessage(), ex);
152-
}
153-
}
154-
155129
/**
156130
* Sets the {@code ObjectMapper} for this view. If not set, a default {@link ObjectMapper#ObjectMapper() ObjectMapper}
157131
* is used.
@@ -171,6 +145,33 @@ public void setObjectMapper(ObjectMapper mapper) {
171145
this.mapper = mapper;
172146
}
173147

148+
@Override
149+
public byte[] serialize(@Nullable T value) throws SerializationException {
150+
151+
if (value == null) {
152+
return SerializationUtils.EMPTY_ARRAY;
153+
}
154+
try {
155+
return this.writer.write(this.mapper, value);
156+
} catch (Exception ex) {
157+
throw new SerializationException("Could not write JSON: " + ex.getMessage(), ex);
158+
}
159+
}
160+
161+
@Override
162+
@SuppressWarnings("unchecked")
163+
public T deserialize(@Nullable byte[] bytes) throws SerializationException {
164+
165+
if (SerializationUtils.isEmpty(bytes)) {
166+
return null;
167+
}
168+
try {
169+
return (T) this.reader.read(this.mapper, bytes, javaType);
170+
} catch (Exception ex) {
171+
throw new SerializationException("Could not read JSON: " + ex.getMessage(), ex);
172+
}
173+
}
174+
174175
/**
175176
* Returns the Jackson {@link JavaType} for the specific class.
176177
* <p>

‎src/main/java/org/springframework/data/redis/serializer/JdkSerializationRedisSerializer.java‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,28 +72,31 @@ public JdkSerializationRedisSerializer(Converter<Object, byte[]> serializer, Con
7272
this.deserializer = deserializer;
7373
}
7474

75-
public Object deserialize(@Nullable byte[] bytes) {
75+
@Override
76+
public byte[] serialize(@Nullable Object value) {
7677

77-
if (SerializationUtils.isEmpty(bytes)) {
78-
return null;
78+
if (value == null) {
79+
return SerializationUtils.EMPTY_ARRAY;
7980
}
8081

8182
try {
82-
return deserializer.convert(bytes);
83-
} catch (Exception ex) {
84-
throw new SerializationException("Cannot deserialize", ex);
83+
return serializer.convert(value);
84+
} catch (Exception cause) {
85+
throw new SerializationException("Cannot serialize", cause);
8586
}
8687
}
8788

8889
@Override
89-
public byte[] serialize(@Nullable Object object) {
90-
if (object == null) {
91-
return SerializationUtils.EMPTY_ARRAY;
90+
public Object deserialize(@Nullable byte[] bytes) {
91+
92+
if (SerializationUtils.isEmpty(bytes)) {
93+
return null;
9294
}
95+
9396
try {
94-
return serializer.convert(object);
97+
return deserializer.convert(bytes);
9598
} catch (Exception ex) {
96-
throw new SerializationException("Cannot serialize", ex);
99+
throw new SerializationException("Cannot deserialize", ex);
97100
}
98101
}
99102
}

‎src/main/java/org/springframework/data/redis/serializer/OxmSerializer.java‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -85,34 +85,34 @@ public void afterPropertiesSet() {
8585
}
8686

8787
@Override
88-
public Object deserialize(@Nullable byte[] bytes) throws SerializationException {
88+
public byte[] serialize(@Nullable Object value) throws SerializationException {
8989

90-
if (SerializationUtils.isEmpty(bytes)) {
91-
return null;
90+
if (value == null) {
91+
return SerializationUtils.EMPTY_ARRAY;
9292
}
9393

94+
ByteArrayOutputStream stream = new ByteArrayOutputStream();
95+
StreamResult result = new StreamResult(stream);
96+
9497
try {
95-
return unmarshaller.unmarshal(new StreamSource(new ByteArrayInputStream(bytes)));
98+
marshaller.marshal(value, result);
9699
} catch (Exception ex) {
97-
throw new SerializationException("Cannot deserialize bytes", ex);
100+
throw new SerializationException("Cannot serialize object", ex);
98101
}
102+
return stream.toByteArray();
99103
}
100104

101105
@Override
102-
public byte[] serialize(@Nullable Object t) throws SerializationException {
106+
public Object deserialize(@Nullable byte[] bytes) throws SerializationException {
103107

104-
if (t == null) {
105-
return SerializationUtils.EMPTY_ARRAY;
108+
if (SerializationUtils.isEmpty(bytes)) {
109+
return null;
106110
}
107111

108-
ByteArrayOutputStream stream = new ByteArrayOutputStream();
109-
StreamResult result = new StreamResult(stream);
110-
111112
try {
112-
marshaller.marshal(t, result);
113+
return unmarshaller.unmarshal(new StreamSource(new ByteArrayInputStream(bytes)));
113114
} catch (Exception ex) {
114-
throw new SerializationException("Cannot serialize object", ex);
115+
throw new SerializationException("Cannot deserialize bytes", ex);
115116
}
116-
return stream.toByteArray();
117117
}
118118
}

‎src/main/java/org/springframework/data/redis/serializer/RedisElementWriter.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import java.nio.ByteBuffer;
1919

20+
import org.springframework.lang.Nullable;
2021
import org.springframework.util.Assert;
2122

2223
/**
@@ -36,7 +37,7 @@ public interface RedisElementWriter<T> {
3637
* @param element can be {@literal null}.
3738
* @return the {@link ByteBuffer} representing {@code element} in its binary form.
3839
*/
39-
ByteBuffer write(T element);
40+
ByteBuffer write(@Nullable T element);
4041

4142
/**
4243
* Create new {@link RedisElementWriter} using given {@link RedisSerializer}.

0 commit comments

Comments
 (0)