DATAREDIS-501 - Use application context ClassLoader as default for JdkSerializationRedisSerializer in RedisTemplate.

We now pick up the ResourceLoader from the ApplicationContext and use the latter as default in RedisTemplate for initializing the JdkSerializationRedisSerializer. We only do this in case the default serializer has not been set explicitly.

Author: christophstrobl

src/main/java/org/springframework/data/redis/core/RedisTemplate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2015 the original author or authors.
+ * Copyright 2011-2016 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.
@@ -26,6 +26,8 @@
 import java.util.Set;
 import java.util.concurrent.TimeUnit;
 
+import org.springframework.context.ResourceLoaderAware;
+import org.springframework.core.io.ResourceLoader;
 import org.springframework.dao.DataAccessException;
 import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.data.redis.RedisSystemException;
@@ -75,13 +77,14 @@
  * @param <V> the Redis value type against which the template works
  * @see StringRedisTemplate
  */
-public class RedisTemplate<K, V> extends RedisAccessor implements RedisOperations<K, V> {
+public class RedisTemplate<K, V> extends RedisAccessor implements RedisOperations<K, V>, ResourceLoaderAware {
 
 	private boolean enableTransactionSupport = false;
 	private boolean exposeConnection = false;
 	private boolean initialized = false;
 	private boolean enableDefaultSerializer = true;
-	private RedisSerializer<?> defaultSerializer = new JdkSerializationRedisSerializer();
+	private RedisSerializer<?> defaultSerializer;
+	private ResourceLoader resourceLoader;
 
 	private RedisSerializer keySerializer = null;
 	private RedisSerializer valueSerializer = null;
@@ -104,10 +107,18 @@ public class RedisTemplate<K, V> extends RedisAccessor implements RedisOperation
 	public RedisTemplate() {}
 
 	public void afterPropertiesSet() {
+
 		super.afterPropertiesSet();
+
 		boolean defaultUsed = false;
 
+		if (defaultSerializer == null) {
+			defaultSerializer = new JdkSerializationRedisSerializer(
+					resourceLoader != null ? resourceLoader.getClassLoader() : this.getClass().getClassLoader());
+		}
+
 		if (enableDefaultSerializer) {
+
 			if (keySerializer == null) {
 				keySerializer = defaultSerializer;
 				defaultUsed = true;
@@ -1096,4 +1107,17 @@ public void setEnableTransactionSupport(boolean enableTransactionSupport) {
 		this.enableTransactionSupport = enableTransactionSupport;
 	}
 
+	/**
+	 * Set the {@link ResourceLoader} to be used for the default {@link JdkSerializationRedisSerializer} in case no other
+	 * {@link RedisSerializer} is explicitly set as the default one.
+	 *
+	 * @param resourceLoader can be {@literal null}.
+	 * @see org.springframework.context.ResourceLoaderAware#setResourceLoader
+	 * @since 1.8
+	 */
+	@Override
+	public void setResourceLoader(ResourceLoader resourceLoader) {
+		this.resourceLoader = resourceLoader;
+	}
+
 }

src/test/java/org/springframework/data/redis/core/RedisTemplateUnitTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014 the original author or authors.
+ * Copyright 2014-2016 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.
@@ -15,31 +15,39 @@
  */
 package org.springframework.data.redis.core;
 
+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 java.io.Serializable;
+
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
+import org.springframework.core.io.DefaultResourceLoader;
 import org.springframework.data.redis.connection.RedisConnection;
 import org.springframework.data.redis.connection.RedisConnectionFactory;
+import org.springframework.data.redis.serializer.JdkSerializationRedisSerializer;
+import org.springframework.instrument.classloading.ShadowingClassLoader;
 
 /**
  * @author Christoph Strobl
  */
 @RunWith(MockitoJUnitRunner.class)
 public class RedisTemplateUnitTests {
 
-	private RedisTemplate<String, String> template;
+	private RedisTemplate<Object, Object> template;
 	private @Mock RedisConnectionFactory connectionFactoryMock;
 	private @Mock RedisConnection redisConnectionMock;
 
 	@Before
 	public void setUp() {
 
-		template = new RedisTemplate<String, String>();
+		template = new RedisTemplate<Object, Object>();
 		template.setConnectionFactory(connectionFactoryMock);
 		when(connectionFactoryMock.getConnection()).thenReturn(redisConnectionMock);
 
@@ -66,4 +74,29 @@ public void slaveOfNoOneIsDelegatedToConnectionCorrectly() {
 		verify(redisConnectionMock, times(1)).slaveOfNoOne();
 	}
 
+	/**
+	 * @see DATAREDIS-501
+	 */
+	@Test
+	public void templateShouldPassOnAndUseResoureLoaderClassLoaderToDefaultJdkSerializerWhenNotAlreadySet() {
+
+		ShadowingClassLoader scl = new ShadowingClassLoader(ClassLoader.getSystemClassLoader());
+
+		template = new RedisTemplate<Object, Object>();
+		template.setConnectionFactory(connectionFactoryMock);
+		template.setResourceLoader(new DefaultResourceLoader(scl));
+		template.afterPropertiesSet();
+
+		when(redisConnectionMock.get(any(byte[].class)))
+				.thenReturn(new JdkSerializationRedisSerializer().serialize(new SomeArbitrarySeriaizableObject()));
+
+		Object deserialized = template.opsForValue().get("spring");
+		assertThat(deserialized, notNullValue());
+		assertThat(deserialized.getClass().getClassLoader(), is((ClassLoader) scl));
+	}
+
+	static class SomeArbitrarySeriaizableObject implements Serializable {
+		private static final long serialVersionUID = -5973659324040506423L;
+	}
+
 }