DATACMNS-1324 - Introduced extensible proxy detection infrastructure.

Introduced ProxyUtils.getUserClass(…) that by default is basically a facade for Spring's ClassUtils.getUserClass(…) but allows the registration of ProxyDetector implementations via Spring's SpringFactoriesLoader mechanism.

Moved all existing usages of ClassUtils.getUserClass(…) to ProxyUtils.

Author: odrotbohm

src/main/java/org/springframework/data/domain/Example.java

@@ -21,7 +21,7 @@
 import lombok.RequiredArgsConstructor;
 import lombok.ToString;
 
-import org.springframework.util.ClassUtils;
+import org.springframework.data.util.ProxyUtils;
 
 /**
  * Support for query by example (QBE). An {@link Example} takes a {@code probe} to define the example. Matching options
@@ -85,10 +85,10 @@ public ExampleMatcher getMatcher() {
 	 * CGLIB-generated subclass.
 	 *
 	 * @return
-	 * @see ClassUtils#getUserClass(Class)
+	 * @see ProxyUtils#getUserClass(Class)
 	 */
 	@SuppressWarnings("unchecked")
 	public Class<T> getProbeType() {
-		return (Class<T>) ClassUtils.getUserClass(probe.getClass());
+		return (Class<T>) ProxyUtils.getUserClass(probe.getClass());
 	}
 }

src/main/java/org/springframework/data/repository/core/support/TransactionalRepositoryProxyPostProcessor.java

@@ -33,6 +33,7 @@
 import org.springframework.core.BridgeMethodResolver;
 import org.springframework.dao.support.PersistenceExceptionTranslationInterceptor;
 import org.springframework.data.repository.core.RepositoryInformation;
+import org.springframework.data.util.ProxyUtils;
 import org.springframework.transaction.annotation.Ejb3TransactionAnnotationParser;
 import org.springframework.transaction.annotation.JtaTransactionAnnotationParser;
 import org.springframework.transaction.annotation.SpringTransactionAnnotationParser;
@@ -383,7 +384,7 @@ private TransactionAttribute computeTransactionAttribute(Method method, Class<?>
 			}
 
 			// Ignore CGLIB subclasses - introspect the actual user class.
-			Class<?> userClass = ClassUtils.getUserClass(targetClass);
+			Class<?> userClass = ProxyUtils.getUserClass(targetClass);
 			// The method may be on an interface, but we need attributes from the target class.
 			// If the target class is null, the method will be unchanged.
 			Method specificMethod = ClassUtils.getMostSpecificMethod(method, userClass);

src/main/java/org/springframework/data/repository/support/Repositories.java

@@ -33,6 +33,7 @@
 import org.springframework.data.repository.core.RepositoryInformation;
 import org.springframework.data.repository.core.support.RepositoryFactoryInformation;
 import org.springframework.data.repository.query.QueryMethod;
+import org.springframework.data.util.ProxyUtils;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
 
@@ -121,7 +122,7 @@ public boolean hasRepositoryFor(Class<?> domainClass) {
 
 		Assert.notNull(domainClass, DOMAIN_TYPE_MUST_NOT_BE_NULL);
 
-		Class<?> userClass = ClassUtils.getUserClass(domainClass);
+		Class<?> userClass = ProxyUtils.getUserClass(domainClass);
 
 		return repositoryFactoryInfos.containsKey(userClass);
 	}
@@ -136,16 +137,16 @@ public Object getRepositoryFor(Class<?> domainClass) {
 
 		Assert.notNull(domainClass, DOMAIN_TYPE_MUST_NOT_BE_NULL);
 
-		Class<?> userClass = ClassUtils.getUserClass(domainClass);
+		Class<?> userClass = ProxyUtils.getUserClass(domainClass);
 		String repositoryBeanName = repositoryBeanNames.get(userClass);
 
 		return repositoryBeanName == null || beanFactory == null ? null : beanFactory.getBean(repositoryBeanName);
 	}
 
 	/**
 	 * Returns the {@link RepositoryFactoryInformation} for the given domain class. The given <code>code</code> is
-	 * converted to the actual user class if necessary, @see ClassUtils#getUserClass.
-	 * 
+	 * converted to the actual user class if necessary, @see ProxyUtils#getUserClass.
+	 *
 	 * @param domainClass must not be {@literal null}.
 	 * @return the {@link RepositoryFactoryInformation} for the given domain class or {@literal null} if no repository
 	 *         registered for this domain class.
@@ -154,7 +155,7 @@ private RepositoryFactoryInformation<Object, Serializable> getRepositoryFactoryI
 
 		Assert.notNull(domainClass, DOMAIN_TYPE_MUST_NOT_BE_NULL);
 
-		Class<?> userType = ClassUtils.getUserClass(domainClass);
+		Class<?> userType = ProxyUtils.getUserClass(domainClass);
 		RepositoryFactoryInformation<Object, Serializable> repositoryInfo = repositoryFactoryInfos.get(userType);
 
 		if (repositoryInfo != null) {

src/main/java/org/springframework/data/util/ClassTypeInformation.java

@@ -102,7 +102,7 @@ public static <S> TypeInformation<S> fromReturnTypeOf(Method method) {
 	 * @param type
 	 */
 	ClassTypeInformation(Class<S> type) {
-		super(ClassUtils.getUserClass(type), getTypeVariableMap(type));
+		super(ProxyUtils.getUserClass(type), getTypeVariableMap(type));
 		this.type = type;
 	}
 

src/main/java/org/springframework/data/util/ProxyUtils.java

@@ -0,0 +1,108 @@
+/*
+ * Copyright 2018 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.util;
+
+import lombok.experimental.UtilityClass;
+
+import java.util.List;
+import java.util.Map;
+
+import org.springframework.core.io.support.SpringFactoriesLoader;
+import org.springframework.util.Assert;
+import org.springframework.util.ClassUtils;
+import org.springframework.util.ConcurrentReferenceHashMap;
+
+/**
+ * Proxy type detection utilities, extensible via {@link ProxyDetector} registered via Spring factories.
+ * 
+ * @author Oliver Gierke
+ * @soundtrack Victor Wooten - Cruising Altitude (Trypnotix)
+ */
+@UtilityClass
+public class ProxyUtils {
+
+	private static Map<Class<?>, Class<?>> USER_TYPES = new ConcurrentReferenceHashMap<Class<?>, Class<?>>();
+
+	private static final List<ProxyDetector> DETECTORS = SpringFactoriesLoader.loadFactories(ProxyDetector.class,
+			ProxyUtils.class.getClassLoader());
+
+	static {
+
+		DETECTORS.add(new ProxyDetector() {
+
+			@Override
+			public Class<?> getUserType(Class<?> type) {
+				return ClassUtils.getUserClass(type);
+			}
+		});
+	}
+
+	/**
+	 * Returns the user class for the given type.
+	 * 
+	 * @param type must not be {@literal null}.
+	 * @return
+	 */
+	public static Class<?> getUserClass(Class<?> type) {
+
+		Assert.notNull(type, "Type must not be null!");
+
+		Class<?> result = USER_TYPES.get(type);
+
+		if (result != null) {
+			return result;
+		}
+
+		result = type;
+
+		for (ProxyDetector proxyDetector : DETECTORS) {
+			result = proxyDetector.getUserType(result);
+		}
+
+		USER_TYPES.put(type, result);
+
+		return result;
+	}
+
+	/**
+	 * Returns the user class for the given source object.
+	 * 
+	 * @param source must not be {@literal null}.
+	 * @return
+	 */
+	public static Class<?> getUserClass(Object source) {
+
+		Assert.notNull(source, "Source object must not be null!");
+
+		return getUserClass(source.getClass());
+	}
+
+	/**
+	 * SPI to extend Spring's default proxy detection capabilities.
+	 *
+	 * @author Oliver Gierke
+	 */
+	public interface ProxyDetector {
+
+		/**
+		 * Returns the user class for the given type.
+		 * 
+		 * @param type will never be {@literal null}.
+		 * @return
+		 */
+		Class<?> getUserType(Class<?> type);
+	}
+}

src/test/java/org/springframework/data/util/ProxyUtilsUnitTests.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2018 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.util;
+
+import static org.hamcrest.Matchers.*;
+import static org.junit.Assert.*;
+
+import org.junit.Test;
+import org.springframework.aop.framework.ProxyFactory;
+import org.springframework.data.util.ProxyUtils.ProxyDetector;
+
+/**
+ * Unit tests for {@link ProxyUtils}.
+ * 
+ * @author Oliver Gierke
+ * @soundtrack Victor Wooten - The 13th Floor (Trypnotix)
+ */
+public class ProxyUtilsUnitTests {
+
+	@Test // DATACMNS-1324
+	public void detectsStandardProxy() {
+
+		ProxyFactory factory = new ProxyFactory();
+		factory.setTarget(new Sample());
+		Object proxy = factory.getProxy();
+
+		assertThat(proxy.getClass(), is(not((Class) Sample.class)));
+		assertThat(ProxyUtils.getUserClass(proxy), is(equalTo((Class) Sample.class)));
+	}
+
+	@Test // DATACMNS-1324
+	public void usesCustomProxyDetector() {
+
+		ProxyFactory factory = new ProxyFactory();
+		factory.setTarget(new AnotherSample());
+		Object proxy = factory.getProxy();
+
+		assertThat(ProxyUtils.getUserClass(proxy), is(equalTo((Class) UserType.class)));
+	}
+
+	static class SampleProxyDetector implements ProxyDetector {
+
+		/* 
+		 * (non-Javadoc)
+		 * @see org.springframework.data.util.ProxyUtils.ProxyDetector#getUserType(java.lang.Class)
+		 */
+		@Override
+		public Class<?> getUserType(Class<?> type) {
+			return AnotherSample.class.isAssignableFrom(type) ? UserType.class : type;
+		}
+	}
+
+	static class Sample {}
+
+	static class UserType {}
+
+	static class AnotherSample {}
+}

src/test/resources/META-INF/spring.factories

@@ -1 +1,2 @@
 org.springframework.data.web.config.SpringDataJacksonModules=org.springframework.data.web.config.SampleMixin
+org.springframework.data.util.ProxyUtils$ProxyDetector=org.springframework.data.util.ProxyUtilsUnitTests$SampleProxyDetector