Introduce configuration of class loader in SimpleTypeInformationMapper.

We now support configuration of the class loader in SimpleTypeInformationMapper to use a configured class loader instead of falling always back to the default/contextual class loader. In arrangements where the contextual class loader isn't able to provide access to the desired classes (e.g. parallel Streams, general Fork/Join Thread usage) the contextual class loader may not have access to the entity types. By implementing BeanClassLoaderAware, we can now propagate a configured class loader.

Closes #2508
This commit is contained in:
Mark Paluch
2021-12-09 11:13:50 +01:00
parent ef522f8e9c
commit 6a52f274f6
4 changed files with 62 additions and 7 deletions

View File

@@ -23,6 +23,7 @@ import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;
import org.springframework.beans.factory.BeanClassLoaderAware;
import org.springframework.data.mapping.Alias;
import org.springframework.data.mapping.PersistentEntity;
import org.springframework.data.mapping.context.MappingContext;
@@ -39,7 +40,7 @@ import org.springframework.util.Assert;
* @author Christoph Strobl
* @author Mark Paluch
*/
public class DefaultTypeMapper<S> implements TypeMapper<S> {
public class DefaultTypeMapper<S> implements TypeMapper<S>, BeanClassLoaderAware {
private final TypeAliasAccessor<S> accessor;
private final List<? extends TypeInformationMapper> mappers;
@@ -215,6 +216,19 @@ public class DefaultTypeMapper<S> implements TypeMapper<S> {
}
}
/*
* (non-Javadoc)
* @see org.springframework.beans.factory.BeanClassLoaderAware#setBeanClassLoader(java.lang.ClassLoader)
*/
@Override
public void setBeanClassLoader(ClassLoader classLoader) {
for (TypeInformationMapper mapper : mappers) {
if (mapper instanceof BeanClassLoaderAware) {
((BeanClassLoaderAware) mapper).setBeanClassLoader(classLoader);
}
}
}
/**
* Returns the alias to be used for the given {@link TypeInformation}.
*

View File

@@ -19,6 +19,7 @@ import java.util.Map;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;
import org.springframework.beans.factory.BeanClassLoaderAware;
import org.springframework.data.mapping.Alias;
import org.springframework.data.util.ClassTypeInformation;
import org.springframework.data.util.TypeInformation;
@@ -33,10 +34,12 @@ import org.springframework.util.ClassUtils;
* @author Oliver Gierke
* @author Mark Paluch
*/
public class SimpleTypeInformationMapper implements TypeInformationMapper {
public class SimpleTypeInformationMapper implements TypeInformationMapper, BeanClassLoaderAware {
private final Map<String, Optional<ClassTypeInformation<?>>> cache = new ConcurrentHashMap<>();
private @Nullable ClassLoader classLoader;
/**
* Returns the {@link TypeInformation} that shall be used when the given {@link String} value is found as type hint.
* The implementation will simply interpret the given value as fully-qualified class name and try to load the class.
@@ -53,7 +56,7 @@ public class SimpleTypeInformationMapper implements TypeInformationMapper {
String stringAlias = alias.mapTyped(String.class);
if (stringAlias != null) {
return cache.computeIfAbsent(stringAlias, SimpleTypeInformationMapper::loadClass).orElse(null);
return cache.computeIfAbsent(stringAlias, this::loadClass).orElse(null);
}
return null;
@@ -70,10 +73,19 @@ public class SimpleTypeInformationMapper implements TypeInformationMapper {
return Alias.of(type.getType().getName());
}
private static Optional<ClassTypeInformation<?>> loadClass(String typeName) {
/*
* (non-Javadoc)
* @see org.springframework.beans.factory.BeanClassLoaderAware#setBeanClassLoader(java.lang.ClassLoader)
*/
@Override
public void setBeanClassLoader(ClassLoader classLoader) {
this.classLoader = classLoader;
}
private Optional<ClassTypeInformation<?>> loadClass(String typeName) {
try {
return Optional.of(ClassTypeInformation.from(ClassUtils.forName(typeName, null)));
return Optional.of(ClassTypeInformation.from(ClassUtils.forName(typeName, this.classLoader)));
} catch (ClassNotFoundException e) {
return Optional.empty();
}

View File

@@ -18,6 +18,8 @@ package org.springframework.data.convert;
import static org.assertj.core.api.Assertions.*;
import static org.mockito.Mockito.*;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Collections;
import java.util.Map;
@@ -29,6 +31,7 @@ import org.mockito.junit.jupiter.MockitoExtension;
import org.mockito.junit.jupiter.MockitoSettings;
import org.mockito.quality.Strictness;
import org.springframework.beans.factory.BeanClassLoaderAware;
import org.springframework.data.mapping.Alias;
import org.springframework.data.util.ClassTypeInformation;
import org.springframework.data.util.TypeInformation;
@@ -47,7 +50,7 @@ class DefaultTypeMapperUnitTests {
static final Alias ALIAS = Alias.of(String.class.getName());
@Mock TypeAliasAccessor<Map<String, String>> accessor;
@Mock TypeInformationMapper mapper;
@Mock(extraInterfaces = BeanClassLoaderAware.class) TypeInformationMapper mapper;
DefaultTypeMapper<Map<String, String>> typeMapper;
Map<String, String> source;
@@ -102,6 +105,15 @@ class DefaultTypeMapperUnitTests {
assertThat(typeInformation.getProperty("field").getType()).isEqualTo(Character.class);
}
@Test // GH-2508
void configuresClassLoaderOnTypeInformationMapper() {
ClassLoader loader = new URLClassLoader(new URL[0]);
typeMapper.setBeanClassLoader(loader);
verify((BeanClassLoaderAware) mapper).setBeanClassLoader(loader);
}
static class TypeWithAbstractGenericType<T> {
AbstractBar<T> abstractBar;
}

View File

@@ -18,6 +18,8 @@ package org.springframework.data.convert;
import static org.assertj.core.api.Assertions.*;
import org.junit.jupiter.api.Test;
import org.springframework.data.classloadersupport.HidingClassLoader;
import org.springframework.data.mapping.Alias;
import org.springframework.data.util.ClassTypeInformation;
import org.springframework.data.util.TypeInformation;
@@ -26,10 +28,11 @@ import org.springframework.data.util.TypeInformation;
* Unit tests for {@link SimpleTypeInformationMapper}.
*
* @author Oliver Gierke
* @author Mark Paluch
*/
class SimpleTypeInformationMapperUnitTests {
TypeInformationMapper mapper = new SimpleTypeInformationMapper();
SimpleTypeInformationMapper mapper = new SimpleTypeInformationMapper();
@Test
void resolvesTypeByLoadingClass() {
@@ -41,6 +44,16 @@ class SimpleTypeInformationMapperUnitTests {
assertThat(type).isEqualTo(expected);
}
@Test // GH-2508
void usesConfiguredClassloader() {
mapper.setBeanClassLoader(HidingClassLoader.hide(SimpleTypeInformationMapperUnitTests.class));
TypeInformation<?> type = mapper
.resolveTypeFrom(Alias.of("org.springframework.data.convert.SimpleTypeInformationMapperUnitTests.User"));
assertThat(type).isNull();
}
@Test
void returnsNullForNonStringKey() {
assertThat(mapper.resolveTypeFrom(Alias.of(new Object()))).isNull();
@@ -63,4 +76,8 @@ class SimpleTypeInformationMapperUnitTests {
assertThat(mapper.createAliasFor(ClassTypeInformation.from(String.class)))
.isEqualTo(Alias.of(String.class.getName()));
}
static class User {
}
}