Spring/spring-data-commons
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATACMNS-1157 - Enforce nullable/non-null API constraints on repository query methods.

Browse Source 
We now validate query method invocations to check method parameters whether they accept null values and reject execution if null values are not supported. We derive nullability support from repository interfaces declared using Kotlin and Spring's NonNullApi/Nullable annotations.

We also check whether a query method can return null. If a query method returns null which isn't supposed to do so, then we throw EmptyResultDataAccessException to prevent null return values.

interface UserRepository extends Repository<User, String> {

  List<User> findByLastname(@Nullable String firstname);

  @Nullable
  User findByFirstnameAndLastname(String firstname, String lastname);
}

interface UserRepository : Repository<User, String> {

  fun findByLastname(username: String?): List<User>

  fun findByFirstnameAndLastname(firstname: String, lastname: String): User?
}

Original pull request: #241.
This commit is contained in:
Mark Paluch
2017-09-12 10:14:56 +02:00
committed by Oliver Gierke
parent 2c20377cfa
commit fcf97e1e71
19 changed files with 1026 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
src/test/java/org/springframework/data/util/NullableUtilsUnitTests.java Normal file
View File

@@ -0,0 +1,119 @@
/*
* 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;
import static org.assertj.core.api.Assertions.*;
import java.lang.annotation.ElementType;
import java.lang.reflect.Method;
import org.junit.Test;
import org.springframework.core.MethodParameter;
import org.springframework.data.util.nonnull.NullableAnnotatedType;
import org.springframework.data.util.nonnull.packagelevel.NonNullOnPackage;
import org.springframework.data.util.nonnull.type.Jsr305NonnullAnnotatedType;
import org.springframework.data.util.nonnull.type.NonAnnotatedType;
import org.springframework.data.util.nonnull.type.NonNullableParameters;
import org.springframework.util.ReflectionUtils;
/**
* Unit tests for {@link NullableUtils}.
*
* @author Mark Paluch
*/
public class NullableUtilsUnitTests {
@Test // DATACMNS-1154
public void packageAnnotatedShouldConsiderNonNullAnnotation() {
Method method = ReflectionUtils.findMethod(NonNullOnPackage.class, "nonNullReturnValue");
assertThat(NullableUtils.isNonNull(method, ElementType.METHOD)).isTrue();
assertThat(NullableUtils.isNonNull(method, ElementType.PARAMETER)).isTrue();
assertThat(NullableUtils.isNonNull(method, ElementType.PACKAGE)).isFalse();
}
@Test // DATACMNS-1154
public void packageAnnotatedShouldConsiderNonNullAnnotationForClass() {
assertThat(NullableUtils.isNonNull(NonNullOnPackage.class, ElementType.PARAMETER)).isTrue();
assertThat(NullableUtils.isNonNull(NonNullOnPackage.class, ElementType.PACKAGE)).isFalse();
}
@Test // DATACMNS-1154
public void packageAnnotatedShouldConsiderNonNullAnnotationForMethod() {
assertThat(NullableUtils.isNonNull(NonNullOnPackage.class, ElementType.PARAMETER)).isTrue();
assertThat(NullableUtils.isNonNull(NonNullOnPackage.class, ElementType.PACKAGE)).isFalse();
}
@Test // DATACMNS-1154
public void shouldConsiderJsr305NonNullParameters() {
assertThat(NullableUtils.isNonNull(NonNullableParameters.class, ElementType.PARAMETER)).isTrue();
assertThat(NullableUtils.isNonNull(NonNullableParameters.class, ElementType.FIELD)).isFalse();
}
@Test // DATACMNS-1154
public void shouldConsiderJsr305NonNullAnnotation() {
assertThat(NullableUtils.isNonNull(Jsr305NonnullAnnotatedType.class, ElementType.PARAMETER)).isTrue();
assertThat(NullableUtils.isNonNull(Jsr305NonnullAnnotatedType.class, ElementType.FIELD)).isTrue();
}
@Test // DATACMNS-1154
public void shouldConsiderNonAnnotatedTypeNullable() {
assertThat(NullableUtils.isNonNull(NonAnnotatedType.class, ElementType.PARAMETER)).isFalse();
assertThat(NullableUtils.isNonNull(NonAnnotatedType.class, ElementType.FIELD)).isFalse();
}
@Test // DATACMNS-1154
public void shouldConsiderParametersWithoutNullableAnnotation() {
Method method = ReflectionUtils.findMethod(NullableAnnotatedType.class, "nonNullMethod", String.class);
MethodParameter returnValue = new MethodParameter(method, -1);
MethodParameter parameter = new MethodParameter(method, 0);
assertThat(NullableUtils.isExplicitNullable(returnValue)).isFalse();
assertThat(NullableUtils.isExplicitNullable(parameter)).isFalse();
}
@Test // DATACMNS-1154
public void shouldConsiderParametersNullableAnnotation() {
Method method = ReflectionUtils.findMethod(NullableAnnotatedType.class, "nullableReturn");
assertThat(NullableUtils.isExplicitNullable(new MethodParameter(method, -1))).isTrue();
}
@Test // DATACMNS-1154
public void shouldConsiderParametersJsr305NullableMetaAnnotation() {
Method method = ReflectionUtils.findMethod(NullableAnnotatedType.class, "jsr305NullableReturn");
assertThat(NullableUtils.isExplicitNullable(new MethodParameter(method, -1))).isTrue();
}
@Test // DATACMNS-1154
public void shouldConsiderParametersJsr305NonnullAnnotation() {
Method method = ReflectionUtils.findMethod(NullableAnnotatedType.class, "jsr305NullableReturnWhen");
assertThat(NullableUtils.isExplicitNullable(new MethodParameter(method, -1))).isTrue();
}
}

38
src/test/java/org/springframework/data/util/ReflectionUtilsUnitTests.java
View File

@@ -23,6 +23,8 @@ import java.lang.reflect.Field;
import org.junit.Before;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.MethodParameter;
import org.springframework.data.repository.sample.User;
import org.springframework.data.util.ReflectionUtils.DescribedFieldFilter;
import org.springframework.util.ReflectionUtils.FieldFilter;
@@ -106,6 +108,42 @@ public class ReflectionUtilsUnitTests {
assertThat(ReflectionUtils.findConstructor(ConstructorDetection.class, null, "test")).isNotPresent();
}
@Test // DATACMNS-1154
public void discoversNoReturnType() throws Exception {
MethodParameter parameter = new MethodParameter(DummyInterface.class.getDeclaredMethod("noReturnValue"), -1);
assertThat(ReflectionUtils.isNullable(parameter)).isTrue();
}
@Test // DATACMNS-1154
public void discoversNullableReturnType() throws Exception {
MethodParameter parameter = new MethodParameter(DummyInterface.class.getDeclaredMethod("nullableReturnValue"), -1);
assertThat(ReflectionUtils.isNullable(parameter)).isTrue();
}
@Test // DATACMNS-1154
public void discoversNonNullableReturnType() throws Exception {
MethodParameter parameter = new MethodParameter(DummyInterface.class.getDeclaredMethod("mandatoryReturnValue"), -1);
assertThat(ReflectionUtils.isNullable(parameter)).isFalse();
}
@Test // DATACMNS-1154
public void discoversNullableParameter() throws Exception {
MethodParameter parameter = new MethodParameter(
DummyInterface.class.getDeclaredMethod("nullableParameter", User.class), 0);
assertThat(ReflectionUtils.isNullable(parameter)).isTrue();
}
@Test // DATACMNS-1154
public void discoversNonNullablePrimitiveParameter() throws Exception {
MethodParameter parameter = new MethodParameter(DummyInterface.class.getDeclaredMethod("primitive", int.class), 0);
assertThat(ReflectionUtils.isNullable(parameter)).isFalse();
}
static class Sample {
public String field;

37
src/test/java/org/springframework/data/util/nonnull/NullableAnnotatedType.java Normal file
View File

@@ -0,0 +1,37 @@
/*
* 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.nonnull;
import javax.annotation.meta.When;
import org.springframework.lang.Nullable;
/**
* @author Mark Paluch
*/
public interface NullableAnnotatedType {
String nonNullMethod(String parameter);
@Nullable
String nullableReturn();
@javax.annotation.Nullable
String jsr305NullableReturn();
@javax.annotation.Nonnull(when = When.MAYBE)
String jsr305NullableReturnWhen();
}

24
src/test/java/org/springframework/data/util/nonnull/packagelevel/NonNullOnPackage.java Normal file
View File

@@ -0,0 +1,24 @@
/*
* 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.nonnull.packagelevel;
/**
* @author Mark Paluch
*/
public interface NonNullOnPackage {
String nonNullReturnValue();
}

3
src/test/java/org/springframework/data/util/nonnull/packagelevel/package-info.java Normal file
View File

@@ -0,0 +1,3 @@
@org.springframework.lang.NonNullApi
package org.springframework.data.util.nonnull.packagelevel;

22
src/test/java/org/springframework/data/util/nonnull/type/CustomAnnotatedType.java Normal file
View File

@@ -0,0 +1,22 @@
/*
* 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.nonnull.type;
/**
* @author Mark Paluch
*/
@CustomNonNullAnnotation
public interface CustomAnnotatedType {}

34
src/test/java/org/springframework/data/util/nonnull/type/CustomNonNullAnnotation.java Normal file
View File

@@ -0,0 +1,34 @@
/*
* 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.nonnull.type;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.annotation.Nonnull;
import javax.annotation.meta.TypeQualifierDefault;
/**
* @author Mark Paluch
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Nonnull
@TypeQualifierDefault({ ElementType.FIELD })
@interface CustomNonNullAnnotation {
}

24
src/test/java/org/springframework/data/util/nonnull/type/Jsr305NonnullAnnotatedType.java Normal file
View File

@@ -0,0 +1,24 @@
/*
* 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.nonnull.type;
import javax.annotation.Nonnull;
/**
* @author Mark Paluch
*/
@Nonnull
public interface Jsr305NonnullAnnotatedType {}

21
src/test/java/org/springframework/data/util/nonnull/type/NonAnnotatedType.java Normal file
View File

@@ -0,0 +1,21 @@
/*
* 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.nonnull.type;
/**
* @author Mark Paluch
*/
public class NonAnnotatedType {}

24
src/test/java/org/springframework/data/util/nonnull/type/NonNullableParameters.java Normal file
View File

@@ -0,0 +1,24 @@
/*
* 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.nonnull.type;
import javax.annotation.ParametersAreNonnullByDefault;
/**
* @author Mark Paluch
*/
@ParametersAreNonnullByDefault
public interface NonNullableParameters {}