Add Custom QuerydslPredicateBuilder

To facilitate the use of queryDsl - related to spring-projects#2266

Author: Rodrigo Dos Santos

src/main/java/org/springframework/data/querydsl/binding/PathInformation.java

@@ -29,7 +29,7 @@
  * @author Oliver Gierke
  * @since 1.13
  */
-interface PathInformation {
+public interface PathInformation {
 
 	/**
 	 * The root property owner type.

src/main/java/org/springframework/data/querydsl/binding/QuerydslBindings.java

@@ -184,7 +184,7 @@ boolean isPathAvailable(String path, Class<?> type) {
 	 * @param type
 	 * @return
 	 */
-	boolean isPathAvailable(String path, TypeInformation<?> type) {
+	public boolean isPathAvailable(String path, TypeInformation<?> type) {
 
 		Assert.notNull(path, "Path must not be null");
 		Assert.notNull(type, "Type must not be null");
@@ -241,7 +241,7 @@ Optional<Path<?>> getExistingPath(PathInformation path) {
 	 * @return
 	 */
 	@Nullable
-	PathInformation getPropertyPath(String path, TypeInformation<?> type) {
+	public PathInformation getPropertyPath(String path, TypeInformation<?> type) {
 
 		Assert.notNull(path, "Path must not be null");
 		Assert.notNull(type, "Type information must not be null");

src/main/java/org/springframework/data/querydsl/binding/QuerydslPredicateBuilder.java

@@ -140,8 +140,8 @@ public static boolean isEmpty(Predicate predicate) {
 	 * @param values must not be {@literal null}.
 	 * @return
 	 */
-	private Optional<Predicate> invokeBinding(PathInformation dotPath, QuerydslBindings bindings,
-			Collection<Object> values) {
+	protected Optional<Predicate> invokeBinding(PathInformation dotPath, QuerydslBindings bindings,
+												Collection<Object> values) {
 
 		Path<?> path = getPath(dotPath, bindings);
 
@@ -173,7 +173,7 @@ private Path<?> getPath(PathInformation path, QuerydslBindings bindings) {
 	 * @param path must not be {@literal null}.
 	 * @return
 	 */
-	private Collection<Object> convertToPropertyPathSpecificType(List<?> source, PathInformation path) {
+	protected Collection<Object> convertToPropertyPathSpecificType(List<?> source, PathInformation path) {
 
 		if (source.isEmpty() || isSingleElementCollectionWithEmptyItem(source)) {
 			return Collections.emptyList();
@@ -237,7 +237,7 @@ private static TypeDescriptor getTargetTypeDescriptor(PathInformation path) {
 	 * @param source must not be {@literal null}.
 	 * @return
 	 */
-	private static boolean isSingleElementCollectionWithEmptyItem(List<?> source) {
+	protected static boolean isSingleElementCollectionWithEmptyItem(List<?> source) {
 		return source.size() == 1 && ObjectUtils.isEmpty(source.get(0));
 	}
 
@@ -247,7 +247,7 @@ private static boolean isSingleElementCollectionWithEmptyItem(List<?> source) {
 	 * @param builder
 	 * @return
 	 */
-	private static Predicate getPredicate(BooleanBuilder builder) {
+	protected static Predicate getPredicate(BooleanBuilder builder) {
 
 		Predicate predicate = builder.getValue();
 		return predicate == null ? new BooleanBuilder() : predicate;

src/main/java/org/springframework/data/web/config/QuerydslWebConfiguration.java

@@ -15,8 +15,7 @@
  */
 package org.springframework.data.web.config;
 
-import java.util.List;
-
+import com.querydsl.core.types.Predicate;
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -29,11 +28,12 @@
 import org.springframework.data.querydsl.EntityPathResolver;
 import org.springframework.data.querydsl.SimpleEntityPathResolver;
 import org.springframework.data.querydsl.binding.QuerydslBindingsFactory;
+import org.springframework.data.querydsl.binding.QuerydslPredicateBuilder;
 import org.springframework.data.web.querydsl.QuerydslPredicateArgumentResolver;
 import org.springframework.web.method.support.HandlerMethodArgumentResolver;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
-import com.querydsl.core.types.Predicate;
+import java.util.List;
 
 /**
  * Querydsl-specific web configuration for Spring Data. Registers a {@link HandlerMethodArgumentResolver} that builds up
@@ -60,9 +60,15 @@ public class QuerydslWebConfiguration implements WebMvcConfigurer {
 	@Lazy
 	@Bean
 	public QuerydslPredicateArgumentResolver querydslPredicateArgumentResolver() {
-		return new QuerydslPredicateArgumentResolver(
-				beanFactory.getBean("querydslBindingsFactory", QuerydslBindingsFactory.class),
-				conversionService.getIfUnique(DefaultConversionService::getSharedInstance));
+		if (beanFactory.containsBean("querydslPredicateBuilder")) { //TODO It might have a better way to check if object exists...
+			return new QuerydslPredicateArgumentResolver(
+					beanFactory.getBean("querydslBindingsFactory", QuerydslBindingsFactory.class),
+					beanFactory.getBean(QuerydslPredicateBuilder.class));
+		} else {
+			return new QuerydslPredicateArgumentResolver(
+					beanFactory.getBean("querydslBindingsFactory", QuerydslBindingsFactory.class),
+					conversionService.getIfUnique(DefaultConversionService::getSharedInstance));
+		}
 	}
 
 	@Lazy

src/main/java/org/springframework/data/web/querydsl/QuerydslPredicateArgumentResolver.java

@@ -23,6 +23,7 @@
 import org.springframework.core.convert.ConversionService;
 import org.springframework.core.convert.support.DefaultConversionService;
 import org.springframework.data.querydsl.binding.QuerydslBindingsFactory;
+import org.springframework.data.querydsl.binding.QuerydslPredicateBuilder;
 import org.springframework.lang.Nullable;
 import org.springframework.util.LinkedMultiValueMap;
 import org.springframework.util.MultiValueMap;
@@ -69,6 +70,16 @@ public QuerydslPredicateArgumentResolver(QuerydslBindingsFactory factory, Conver
 		super(factory, conversionService);
 	}
 
+	/**
+	 * Create a new {@link QuerydslPredicateArgumentResolver}.
+	 *
+	 * @param factory the {@link QuerydslBindingsFactory} to use, must not be {@literal null}.
+	 * @param querydslPredicateBuilder the {@link QuerydslPredicateBuilder} to use, must not be {@literal null}.
+	 */
+	public QuerydslPredicateArgumentResolver(QuerydslBindingsFactory factory, QuerydslPredicateBuilder querydslPredicateBuilder) {
+		super(factory, querydslPredicateBuilder);
+	}
+
 	@Nullable
 	@Override
 	public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,

src/main/java/org/springframework/data/web/querydsl/QuerydslPredicateArgumentResolverSupport.java

@@ -72,6 +72,21 @@ protected QuerydslPredicateArgumentResolverSupport(QuerydslBindingsFactory facto
 		this.predicateBuilder = new QuerydslPredicateBuilder(conversionService, factory.getEntityPathResolver());
 	}
 
+	/**
+	 * Creates a new {@link QuerydslPredicateArgumentResolver} using the given {@link QuerydslPredicateBuilder}.
+	 * @param factory
+	 * @param querydslPredicateBuilder
+	 */
+	public QuerydslPredicateArgumentResolverSupport(QuerydslBindingsFactory factory,
+													   QuerydslPredicateBuilder querydslPredicateBuilder) {
+
+		Assert.notNull(factory, "QuerydslBindingsFactory must not be null");
+		Assert.notNull(querydslPredicateBuilder, "querydslPredicateBuilder must not be null");
+
+		this.bindingsFactory = factory;
+		this.predicateBuilder = querydslPredicateBuilder;
+	}
+
 	public boolean supportsParameter(MethodParameter parameter) {
 
 		ResolvableType type = ResolvableType.forMethodParameter(parameter);

src/test/java/com/custom/querydslpredicatebuilder/QuerydslPredicateBuilderCustom.java

@@ -0,0 +1,66 @@
+package com.custom.querydslpredicatebuilder;
+
+import com.querydsl.core.BooleanBuilder;
+import com.querydsl.core.types.Predicate;
+import org.springframework.core.convert.support.DefaultConversionService;
+import org.springframework.data.querydsl.SimpleEntityPathResolver;
+import org.springframework.data.querydsl.binding.PathInformation;
+import org.springframework.data.querydsl.binding.QuerydslBindings;
+import org.springframework.data.querydsl.binding.QuerydslBindingsFactory;
+import org.springframework.data.querydsl.binding.QuerydslPredicateBuilder;
+import org.springframework.data.util.TypeInformation;
+import org.springframework.stereotype.Component;
+import org.springframework.util.Assert;
+import org.springframework.util.MultiValueMap;
+
+import java.util.Collection;
+import java.util.Optional;
+
+@Component("querydslPredicateBuilder")
+public class QuerydslPredicateBuilderCustom extends QuerydslPredicateBuilder {
+    /**
+     * Creates a custom {@link QuerydslPredicateBuilder}
+     *
+     */
+    public QuerydslPredicateBuilderCustom() {
+        super(DefaultConversionService.getSharedInstance(), new QuerydslBindingsFactory(SimpleEntityPathResolver.INSTANCE).getEntityPathResolver());
+    }
+
+    //TODO Copy same logic as original class and just changed 'builder::or'
+    @Override
+    public Predicate getPredicate(TypeInformation<?> type, MultiValueMap<String, ?> values, QuerydslBindings bindings) {
+        Assert.notNull(bindings, "Context must not be null");
+
+        BooleanBuilder builder = new BooleanBuilder();
+
+        if (values.isEmpty()) {
+            return getPredicate(builder);
+        }
+
+        for (var entry : values.entrySet()) {
+
+            if (isSingleElementCollectionWithEmptyItem(entry.getValue())) {
+                continue;
+            }
+
+            String path = entry.getKey();
+
+            if (!bindings.isPathAvailable(path, type)) {
+                continue;
+            }
+
+            PathInformation propertyPath = bindings.getPropertyPath(path, type);
+
+            if (propertyPath == null) {
+                continue;
+            }
+
+            Collection<Object> value = convertToPropertyPathSpecificType(entry.getValue(), propertyPath);
+            Optional<Predicate> predicate = invokeBinding(propertyPath, bindings, value);
+
+            predicate.ifPresent(builder::or);
+        }
+
+        return getPredicate(builder);
+    }
+}

src/test/java/org/springframework/data/web/config/EnableSpringDataWebSupportIntegrationTests.java

@@ -15,37 +15,35 @@
  */
 package org.springframework.data.web.config;
 
-import static org.assertj.core.api.Assertions.*;
-import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
-import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
-
-import java.util.Arrays;
-
+import com.custom.querydslpredicatebuilder.QuerydslPredicateBuilderCustom;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.Test;
-
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.convert.ConversionService;
 import org.springframework.data.classloadersupport.HidingClassLoader;
 import org.springframework.data.geo.Distance;
 import org.springframework.data.geo.Point;
 import org.springframework.data.querydsl.EntityPathResolver;
+import org.springframework.data.querydsl.QUser;
 import org.springframework.data.querydsl.SimpleEntityPathResolver;
 import org.springframework.data.querydsl.binding.QuerydslBindingsFactory;
-import org.springframework.data.web.PageableHandlerMethodArgumentResolver;
-import org.springframework.data.web.PagedResourcesAssemblerArgumentResolver;
-import org.springframework.data.web.ProxyingHandlerMethodArgumentResolver;
-import org.springframework.data.web.SortHandlerMethodArgumentResolver;
-import org.springframework.data.web.WebTestUtils;
+import org.springframework.data.web.*;
 import org.springframework.hateoas.Link;
 import org.springframework.test.util.ReflectionTestUtils;
 import org.springframework.test.web.servlet.setup.MockMvcBuilders;
 import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;
 import org.springframework.web.util.UriComponentsBuilder;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
+import java.util.Arrays;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
 /**
  * Integration tests for {@link EnableSpringDataWebSupport}.
@@ -101,6 +99,17 @@ SimpleEntityPathResolver entityPathResolver() {
 		}
 	}
 
+	@Configuration
+	@EnableWebMvc
+	@EnableSpringDataWebSupport
+	@ComponentScan(basePackageClasses = QuerydslPredicateBuilderCustom.class)
+	static class SampleConfigWithCustomQuerydslPredicateBuilder {
+		@Bean
+		SampleController controller() {
+			return new SampleController();
+		}
+	}
+
 	@Test // DATACMNS-330
 	void registersBasicBeanDefinitions() throws Exception {
 
@@ -187,6 +196,29 @@ void createsProxyForInterfaceBasedControllerMethodParameter() throws Exception {
 				andExpect(status().isOk());
 	}
 
+	@Test
+	void createsTestForCustomPredicate() throws Exception {
+
+		var applicationContext = WebTestUtils.createApplicationContext(SampleConfigWithCustomQuerydslPredicateBuilder.class);
+		var mvc = MockMvcBuilders.webAppContextSetup(applicationContext).build();
+
+		var builder = UriComponentsBuilder.fromUriString("/predicate");
+		builder.queryParam("firstname", "Foo");
+		builder.queryParam("lastname", "Bar");
+
+		mvc.perform(post(builder.build().toString())).
+				andExpect(status().isOk())
+				.andExpect(content().string(QUser.user.firstname.eq("Foo").or(QUser.user.lastname.eq("Bar")).toString()));
+
+		//Default should be and
+		applicationContext = WebTestUtils.createApplicationContext(SampleConfig.class);
+		mvc = MockMvcBuilders.webAppContextSetup(applicationContext).build();
+
+		mvc.perform(post(builder.build().toString())).
+				andExpect(status().isOk())
+				.andExpect(content().string(QUser.user.firstname.eq("Foo").and(QUser.user.lastname.eq("Bar")).toString()));
+	}
+
 	@Test // DATACMNS-660
 	void picksUpWebConfigurationMixins() {
 

src/test/java/org/springframework/data/web/config/SampleController.java

@@ -15,16 +15,20 @@
  */
 package org.springframework.data.web.config;
 
-import static org.assertj.core.api.Assertions.*;
-
-import java.util.Collection;
-import java.util.Date;
-
+import com.querydsl.core.types.Predicate;
+import org.springframework.data.querydsl.User;
+import org.springframework.data.querydsl.binding.QuerydslPredicate;
 import org.springframework.data.web.ProjectedPayload;
 import org.springframework.format.annotation.DateTimeFormat;
 import org.springframework.format.annotation.DateTimeFormat.ISO;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+import java.util.Collection;
+import java.util.Date;
+
+import static org.assertj.core.api.Assertions.assertThat;
 
 /**
  * @author Oliver Gierke
@@ -52,6 +56,12 @@ String someMethod(SampleDto sampleDto) {
 		return "view";
 	}
 
+	@RequestMapping("/predicate")
+	@ResponseBody
+	String generateCustomPredicate(@QuerydslPredicate(root = User.class) Predicate predicate) {
+		return predicate.toString();
+	}
+
 	@ProjectedPayload
 	interface SampleDto {