Browse Source

DATACMNS-1171 - Limit Kotlin reflection support to regular classes.

We now only inspect regular Kotlin classes with inspection to adapt Kotlin-specific behavior. Multipart-, synthetic and unknown classes are not supported. In such cases we fall back to the JVM reflection mechanism.

Non-regular classes are typically synthetic stubs, lambdas and SAM conversion which do not represent typical domain objects but rather technical bridge code.

Original pull request: #245.
pull/246/head
Mark Paluch 8 years ago committed by Oliver Gierke
parent
commit
d9d0d594e5
  1. 2
      src/main/java/org/springframework/data/convert/KotlinClassGeneratingEntityInstantiator.java
  2. 2
      src/main/java/org/springframework/data/mapping/model/PreferredConstructorDiscoverer.java
  3. 5
      src/main/java/org/springframework/data/repository/core/support/MethodInvocationValidator.java
  4. 32
      src/main/java/org/springframework/data/util/ReflectionUtils.java
  5. 18
      src/test/java/org/springframework/data/util/ReflectionUtilsUnitTests.java
  6. 11
      src/test/kotlin/org/springframework/data/mapping/model/PreferredConstructorDiscovererUnitTests.kt
  7. 25
      src/test/kotlin/org/springframework/data/mapping/model/TypeCreatingSyntheticClass.kt
  8. 25
      src/test/kotlin/org/springframework/data/util/TypeCreatingSyntheticClass.kt

2
src/main/java/org/springframework/data/convert/KotlinClassGeneratingEntityInstantiator.java

@ -50,7 +50,7 @@ public class KotlinClassGeneratingEntityInstantiator extends ClassGeneratingEnti @@ -50,7 +50,7 @@ public class KotlinClassGeneratingEntityInstantiator extends ClassGeneratingEnti
PreferredConstructor<?, ?> constructor = entity.getPersistenceConstructor();
if (ReflectionUtils.isKotlinClass(entity.getType()) && constructor != null) {
if (ReflectionUtils.isSupportedKotlinClass(entity.getType()) && constructor != null) {
PreferredConstructor<?, ?> defaultConstructor = new DefaultingKotlinConstructorResolver(entity)
.getDefaultConstructor();

2
src/main/java/org/springframework/data/mapping/model/PreferredConstructorDiscoverer.java

@ -187,7 +187,7 @@ public interface PreferredConstructorDiscoverer<T, P extends PersistentProperty< @@ -187,7 +187,7 @@ public interface PreferredConstructorDiscoverer<T, P extends PersistentProperty<
* @return the appropriate discoverer for {@code type}.
*/
private static Discoverers findDiscoverer(Class<?> type) {
return ReflectionUtils.isKotlinClass(type) ? KOTLIN : DEFAULT;
return ReflectionUtils.isSupportedKotlinClass(type) ? KOTLIN : DEFAULT;
}
/**

5
src/main/java/org/springframework/data/repository/core/support/MethodInvocationValidator.java

@ -59,7 +59,7 @@ public class MethodInvocationValidator implements MethodInterceptor { @@ -59,7 +59,7 @@ public class MethodInvocationValidator implements MethodInterceptor {
*/
public static boolean supports(Class<?> repositoryInterface) {
return ReflectionUtils.isKotlinClass(repositoryInterface)
return ReflectionUtils.isSupportedKotlinClass(repositoryInterface)
|| NullableUtils.isNonNull(repositoryInterface, ElementType.METHOD)
|| NullableUtils.isNonNull(repositoryInterface, ElementType.PARAMETER);
}
@ -153,7 +153,8 @@ public class MethodInvocationValidator implements MethodInterceptor { @@ -153,7 +153,8 @@ public class MethodInvocationValidator implements MethodInterceptor {
private static boolean isNullableParameter(MethodParameter parameter) {
return requiresNoValue(parameter) || NullableUtils.isExplicitNullable(parameter)
|| (ReflectionUtils.isKotlinClass(parameter.getDeclaringClass()) && ReflectionUtils.isNullable(parameter));
|| (ReflectionUtils.isSupportedKotlinClass(parameter.getDeclaringClass())
&& ReflectionUtils.isNullable(parameter));
}
private static boolean requiresNoValue(MethodParameter parameter) {

32
src/main/java/org/springframework/data/util/ReflectionUtils.java

@ -18,6 +18,9 @@ package org.springframework.data.util; @@ -18,6 +18,9 @@ package org.springframework.data.util;
import kotlin.reflect.KFunction;
import kotlin.reflect.KType;
import kotlin.reflect.jvm.ReflectJvmMapping;
import kotlin.reflect.jvm.internal.impl.load.kotlin.header.KotlinClassHeader;
import kotlin.reflect.jvm.internal.impl.load.kotlin.header.KotlinClassHeader.Kind;
import kotlin.reflect.jvm.internal.impl.load.kotlin.reflect.ReflectKotlinClass;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import lombok.experimental.UtilityClass;
@ -348,7 +351,7 @@ public class ReflectionUtils { @@ -348,7 +351,7 @@ public class ReflectionUtils {
}
/**
* Return true if the specified class is a Kotlin one.
* Return {@literal true} if the specified class is a Kotlin one.
*
* @return {@literal true} if {@code type} is a Kotlin class.
* @since 2.0
@ -360,6 +363,31 @@ public class ReflectionUtils { @@ -360,6 +363,31 @@ public class ReflectionUtils {
.anyMatch(annotation -> annotation.getName().equals("kotlin.Metadata"));
}
/**
* Return {@literal true} if the specified class is a supported Kotlin class. Currently supported are only
* {@link Kind#CLASS regular Kotlin classes}. Other class types (synthetic, SAM, lambdas) are not supported via
* reflection.
*
* @return {@literal true} if {@code type} is a supported Kotlin class.
* @since 2.0
*/
public static boolean isSupportedKotlinClass(Class<?> type) {
if (!isKotlinClass(type)) {
return false;
}
ReflectKotlinClass kotlinClass = ReflectKotlinClass.Factory.create(type);
if (kotlinClass == null) {
return false;
}
KotlinClassHeader classHeader = kotlinClass.getClassHeader();
return classHeader.getKind() == Kind.CLASS;
}
/**
* Returns {@literal} whether the given {@link MethodParameter} is nullable. Nullable parameters are reference types
* and ones that are defined in Kotlin as such.
@ -373,7 +401,7 @@ public class ReflectionUtils { @@ -373,7 +401,7 @@ public class ReflectionUtils {
return true;
}
if (isKotlinClass(parameter.getDeclaringClass())) {
if (isSupportedKotlinClass(parameter.getDeclaringClass())) {
KFunction<?> kotlinFunction = ReflectJvmMapping.getKotlinFunction(parameter.getMethod());

18
src/test/java/org/springframework/data/util/ReflectionUtilsUnitTests.java

@ -24,12 +24,16 @@ import org.junit.Before; @@ -24,12 +24,16 @@ import org.junit.Before;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.MethodParameter;
import org.springframework.data.mapping.model.TypeCreatingSyntheticClassKt;
import org.springframework.data.repository.sample.User;
import org.springframework.data.util.ReflectionUtils.DescribedFieldFilter;
import org.springframework.util.ReflectionUtils.FieldFilter;
/**
* Unit tests for {@link ReflectionUtils}.
*
* @author Oliver Gierke
* @author Mark Paluch
*/
public class ReflectionUtilsUnitTests {
@ -143,6 +147,20 @@ public class ReflectionUtilsUnitTests { @@ -143,6 +147,20 @@ public class ReflectionUtilsUnitTests {
MethodParameter parameter = new MethodParameter(DummyInterface.class.getDeclaredMethod("primitive", int.class), 0);
assertThat(ReflectionUtils.isNullable(parameter)).isFalse();
}
@Test // DATACMNS-1171
public void discoversKotlinClass() {
assertThat(ReflectionUtils.isKotlinClass(TypeCreatingSyntheticClass.class)).isTrue();
assertThat(ReflectionUtils.isSupportedKotlinClass(TypeCreatingSyntheticClass.class)).isTrue();
}
@Test // DATACMNS-1171
public void discoversUnsupportedKotlinClass() {
assertThat(ReflectionUtils.isKotlinClass(TypeCreatingSyntheticClassKt.class)).isTrue();
assertThat(ReflectionUtils.isSupportedKotlinClass(TypeCreatingSyntheticClassKt.class)).isFalse();
}
static class Sample {

11
src/test/kotlin/org/springframework/data/mapping/model/PreferredConstructorDiscovererUnitTests.kt

@ -74,6 +74,17 @@ class PreferredConstructorDiscovererUnitTests { @@ -74,6 +74,17 @@ class PreferredConstructorDiscovererUnitTests {
Assertions.assertThat(constructor.parameters.size).isEqualTo(3)
}
@Test // DATACMNS-1171
@Suppress("UNCHECKED_CAST")
fun `should not resolve constructor for synthetic Kotlin class`() {
val c = Class.forName("org.springframework.data.mapping.model.TypeCreatingSyntheticClassKt") as Class<Any>
val constructor = PreferredConstructorDiscoverer.discover<Any, SamplePersistentProperty>(c)
Assertions.assertThat(constructor).isNull()
}
data class Simple(val firstname: String)

25
src/test/kotlin/org/springframework/data/mapping/model/TypeCreatingSyntheticClass.kt

@ -0,0 +1,25 @@ @@ -0,0 +1,25 @@
/*
* Copyright 2017 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.mapping.model
/**
* @author Mark Paluch
*/
class TypeCreatingSyntheticClass {
}
fun foobar(args: Array<String>) {
}

25
src/test/kotlin/org/springframework/data/util/TypeCreatingSyntheticClass.kt

@ -0,0 +1,25 @@ @@ -0,0 +1,25 @@
/*
* Copyright 2017 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
/**
* @author Mark Paluch
*/
class TypeCreatingSyntheticClass {
}
fun foobar(args: Array<String>) {
}
Loading…
Cancel
Save