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

Relax query parameter validation.

Browse Source 
This change allows to use collection/array arguments with scalar operators when targeting a collection like property.

Closes #3356
Original pull request: #3359
This commit is contained in:
Christoph Strobl
2024-02-09 11:19:12 +01:00
committed by Mark Paluch
parent 764a3ed3d5
commit 21e62a6ad3
3 changed files with 33 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/PartTreeJpaQuery.java
View File

@@ -166,10 +166,14 @@ public class PartTreeJpaQuery extends AbstractJpaQuery {
JpaParameter parameter = parameters.getBindableParameter(index);
if (expectsCollection(type) && !parameterIsCollectionLike(parameter)) {
throw new IllegalStateException(wrongParameterTypeMessage(methodName, property, type, "Collection", parameter));
} else if (!expectsCollection(type) && !parameterIsScalarLike(parameter)) {
throw new IllegalStateException(wrongParameterTypeMessage(methodName, property, type, "scalar", parameter));
if (expectsCollection(type)) {
if (!parameterIsCollectionLike(parameter)) {
throw new IllegalStateException(wrongParameterTypeMessage(methodName, property, type, "Collection", parameter));
}
} else {
if (!part.getProperty().isCollection() && !parameterIsScalarLike(parameter)) {
throw new IllegalStateException(wrongParameterTypeMessage(methodName, property, type, "scalar", parameter));
}
}
}
@@ -319,7 +323,7 @@ public class PartTreeJpaQuery extends AbstractJpaQuery {
returnedType = processor.getReturnedType();
}
if (accessor != null && accessor.getScrollPosition()instanceof KeysetScrollPosition keyset) {
if (accessor != null && accessor.getScrollPosition() instanceof KeysetScrollPosition keyset) {
return new JpaKeysetScrollQueryCreator(tree, returnedType, builder, provider, entityInformation, keyset);
}

15
spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/QueryUtils.java
View File

@@ -39,7 +39,16 @@ import jakarta.persistence.metamodel.SingularAttribute;
import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Member;
import java.util.*;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
@@ -568,7 +577,7 @@ public abstract class QueryUtils {
*
* @param originalQuery must not be {@literal null} or empty.
* @return Guaranteed to be not {@literal null}.
* @deprecated use {@link DeclaredQuery#deriveCountQuery(String, String)} instead.
* @deprecated use {@link DeclaredQuery#deriveCountQuery(String)} instead.
*/
@Deprecated
public static String createCountQueryFor(String originalQuery) {
@@ -582,7 +591,7 @@ public abstract class QueryUtils {
* @param countProjection may be {@literal null}.
* @return a query String to be used a count query for pagination. Guaranteed to be not {@literal null}.
* @since 1.6
* @deprecated use {@link DeclaredQuery#deriveCountQuery(String, String)} instead.
* @deprecated use {@link DeclaredQuery#deriveCountQuery(String)} instead.
*/
@Deprecated
public static String createCountQueryFor(String originalQuery, @Nullable String countProjection) {

12
spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/PartTreeJpaQueryIntegrationTests.java
View File

@@ -30,6 +30,7 @@ import java.lang.reflect.Method;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Set;
import org.hibernate.Version;
import org.junit.jupiter.api.BeforeEach;
@@ -228,6 +229,13 @@ class PartTreeJpaQueryIntegrationTests {
.withMessageContaining("UserRepository"); // the repository
}
@Test // GH-3356
void allowsCollectionArgForCollectionProperty() throws Exception {
new PartTreeJpaQuery(getQueryMethod("findByAttributes", Set.class), entityManager);
new PartTreeJpaQuery(getQueryMethod("findByAttributes", String[].class), entityManager);
}
private void testIgnoreCase(String methodName, Object... values) throws Exception {
Class<?>[] parameterTypes = new Class[values.length];
@@ -297,6 +305,10 @@ class PartTreeJpaQueryIntegrationTests {
// Wrong property name
User findByNoSuchProperty(String x);
List<User> findByAttributes(Set<String> attributes);
List<User> findByAttributes(String... attributes);
}
}