wip: handle named parameters

Author: diamondT

src/main/java/org/springframework/data/elasticsearch/annotations/Query.java

@@ -52,4 +52,11 @@
 	 * @since 4.2
 	 */
 	boolean count() default false;
+
+	/**
+	 * Returns whether the query defined should be built using named parameters instead of positional parameters.
+	 * 
+	 * @return false by default
+	 */
+	boolean useNamedParameters() default false;
 }

src/main/java/org/springframework/data/elasticsearch/repository/query/AbstractReactiveElasticsearchRepositoryQuery.java

@@ -83,7 +83,8 @@ private Object execute(ElasticsearchParameterAccessor parameterAccessor) {
 		ResultProcessor processor = queryMethod.getResultProcessor().withDynamicProjection(parameterAccessor);
 
 		Query query = createQuery(
-				new ConvertingParameterAccessor(elasticsearchOperations.getElasticsearchConverter(), parameterAccessor));
+				new ConvertingParameterAccessor(elasticsearchOperations.getElasticsearchConverter(), parameterAccessor),
+				queryMethod.hasNamedParameters());
 
 		if (queryMethod.hasAnnotatedHighlight()) {
 			query.setHighlightQuery(queryMethod.getAnnotatedHighlightQuery());
@@ -108,9 +109,10 @@ private ReactiveElasticsearchQueryExecution getExecution(ElasticsearchParameterA
 	 * Creates a {@link Query} instance using the given {@link ParameterAccessor}
 	 *
 	 * @param accessor must not be {@literal null}.
+	 * @param useNamedParameters whether to use named parameters or not
 	 * @return
 	 */
-	protected abstract Query createQuery(ElasticsearchParameterAccessor accessor);
+	protected abstract Query createQuery(ElasticsearchParameterAccessor accessor, boolean useNamedParameters);
 
 	private ReactiveElasticsearchQueryExecution getExecutionToWrap(ElasticsearchParameterAccessor accessor,
 			ReactiveElasticsearchOperations operations) {

src/main/java/org/springframework/data/elasticsearch/repository/query/ConvertingParameterAccessor.java

@@ -16,11 +16,12 @@
 package org.springframework.data.elasticsearch.repository.query;
 
 import java.util.Iterator;
-import java.util.Optional;
 
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.elasticsearch.core.convert.ElasticsearchConverter;
+import org.springframework.data.repository.query.Parameter;
+import org.springframework.data.repository.query.Parameters;
 import org.springframework.lang.Nullable;
 
 /**
@@ -39,6 +40,16 @@ public ConvertingParameterAccessor(ElasticsearchConverter converter, Elasticsear
 		this.delegate = delegate;
 	}
 
+	@Override
+	public Parameters<?, ?> getParameters() {
+		return delegate.getParameters();
+	}
+
+	@Override
+	public <T> T getValue(Parameter parameter) {
+		return delegate.getValue(parameter);
+	}
+
 	@Override
 	public Object[] getValues() {
 		return delegate.getValues();

src/main/java/org/springframework/data/elasticsearch/repository/query/ElasticsearchParameterAccessor.java

@@ -15,14 +15,22 @@
  */
 package org.springframework.data.elasticsearch.repository.query;
 
+import org.springframework.data.repository.query.Parameter;
 import org.springframework.data.repository.query.ParameterAccessor;
+import org.springframework.data.repository.query.Parameters;
+import org.springframework.lang.Nullable;
 
 /**
  * @author Christoph Strobl
  * @since 3.2
  */
 public interface ElasticsearchParameterAccessor extends ParameterAccessor {
 
+	Parameters<?, ?> getParameters();
+
+	@Nullable
+	<T> T getValue(Parameter parameter);
+
 	/**
 	 * Returns the raw parameter values of the underlying query method.
 	 *

src/main/java/org/springframework/data/elasticsearch/repository/query/ElasticsearchParametersParameterAccessor.java

@@ -18,7 +18,9 @@
 import java.util.Arrays;
 import java.util.List;
 
+import org.springframework.data.repository.query.Parameter;
 import org.springframework.data.repository.query.ParametersParameterAccessor;
+import org.springframework.lang.Nullable;
 
 /**
  * @author Christoph Strobl
@@ -41,6 +43,12 @@ class ElasticsearchParametersParameterAccessor extends ParametersParameterAccess
 		this.values = Arrays.asList(values);
 	}
 
+	@Nullable
+	@Override
+	public <T> T getValue(Parameter parameter) {
+		return super.getValue(parameter.getIndex());
+	}
+
 	@Override
 	public Object[] getValues() {
 		return values.toArray();

src/main/java/org/springframework/data/elasticsearch/repository/query/ElasticsearchQueryMethod.java

@@ -247,4 +247,10 @@ public boolean hasCountQueryAnnotation() {
 		return queryAnnotation != null && queryAnnotation.count();
 	}
 
+	/**
+	 * @return {@literal true} if the method is annotated with {@link Query}(useNamedParameters = true)
+	 */
+	public boolean hasNamedParameters() {
+		return queryAnnotation != null && queryAnnotation.useNamedParameters();
+	}
 }

src/main/java/org/springframework/data/elasticsearch/repository/query/ElasticsearchStringQuery.java

@@ -23,7 +23,6 @@
 import org.springframework.data.elasticsearch.core.mapping.IndexCoordinates;
 import org.springframework.data.elasticsearch.core.query.StringQuery;
 import org.springframework.data.elasticsearch.repository.support.StringQueryUtil;
-import org.springframework.data.repository.query.ParametersParameterAccessor;
 import org.springframework.data.util.StreamUtils;
 import org.springframework.util.Assert;
 
@@ -56,9 +55,10 @@ public boolean isCountQuery() {
 	public Object execute(Object[] parameters) {
 
 		Class<?> clazz = queryMethod.getResultProcessor().getReturnedType().getDomainType();
-		ParametersParameterAccessor accessor = new ParametersParameterAccessor(queryMethod.getParameters(), parameters);
+		ElasticsearchParametersParameterAccessor accessor = new ElasticsearchParametersParameterAccessor(queryMethod,
+				parameters);
 
-		StringQuery stringQuery = createQuery(accessor);
+		StringQuery stringQuery = createQuery(accessor, queryMethod.hasNamedParameters());
 
 		Assert.notNull(stringQuery, "unsupported query");
 
@@ -97,9 +97,10 @@ public Object execute(Object[] parameters) {
 				: result;
 	}
 
-	protected StringQuery createQuery(ParametersParameterAccessor parameterAccessor) {
-		String queryString = new StringQueryUtil(elasticsearchOperations.getElasticsearchConverter().getConversionService())
-				.replacePlaceholders(this.query, parameterAccessor);
+	protected StringQuery createQuery(ElasticsearchParametersParameterAccessor parameterAccessor,
+			boolean useNamedParameters) {
+		String queryString = new StringQueryUtil(elasticsearchOperations.getElasticsearchConverter().getConversionService(),
+				useNamedParameters).replacePlaceholders(this.query, parameterAccessor);
 		return new StringQuery(queryString);
 	}
 

src/main/java/org/springframework/data/elasticsearch/repository/query/ReactiveElasticsearchStringQuery.java

@@ -46,10 +46,10 @@ public ReactiveElasticsearchStringQuery(String query, ReactiveElasticsearchQuery
 	}
 
 	@Override
-	protected StringQuery createQuery(ElasticsearchParameterAccessor parameterAccessor) {
+	protected StringQuery createQuery(ElasticsearchParameterAccessor parameterAccessor, boolean useNamedParameters) {
 		String queryString = new StringQueryUtil(
-				getElasticsearchOperations().getElasticsearchConverter().getConversionService()).replacePlaceholders(this.query,
-						parameterAccessor);
+				getElasticsearchOperations().getElasticsearchConverter().getConversionService(), useNamedParameters)
+						.replacePlaceholders(this.query, parameterAccessor);
 		return new StringQuery(queryString);
 	}
 

src/main/java/org/springframework/data/elasticsearch/repository/query/ReactivePartTreeElasticsearchQuery.java

@@ -40,7 +40,7 @@ public ReactivePartTreeElasticsearchQuery(ReactiveElasticsearchQueryMethod query
 	}
 
 	@Override
-	protected Query createQuery(ElasticsearchParameterAccessor accessor) {
+	protected Query createQuery(ElasticsearchParameterAccessor accessor, boolean useNamedParameters) {
 		CriteriaQuery query = new ElasticsearchQueryCreator(tree, accessor, getMappingContext()).createQuery();
 
 		if (tree.isLimiting()) {

src/main/java/org/springframework/data/elasticsearch/repository/support/StringQueryUtil.java

@@ -21,6 +21,7 @@
 import java.util.stream.Collectors;
 
 import org.springframework.core.convert.ConversionService;
+import org.springframework.data.elasticsearch.repository.query.ElasticsearchParameterAccessor;
 import org.springframework.data.repository.query.ParameterAccessor;
 import org.springframework.util.NumberUtils;
 
@@ -34,11 +35,17 @@ final public class StringQueryUtil {
 
 	private final ConversionService conversionService;
 
-	public StringQueryUtil(ConversionService conversionService) {
+	private final boolean useNamedParameters;
+
+	public StringQueryUtil(ConversionService conversionService, boolean useNamedParameters) {
 		this.conversionService = conversionService;
+		this.useNamedParameters = useNamedParameters;
 	}
 
-	public String replacePlaceholders(String input, ParameterAccessor accessor) {
+	public String replacePlaceholders(String input, ElasticsearchParameterAccessor accessor) {
+		if (useNamedParameters) {
+			return replaceNamedParameters(input, accessor);
+		}
 
 		Matcher matcher = PARAMETER_PLACEHOLDER.matcher(input);
 		String result = input;
@@ -51,6 +58,14 @@ public String replacePlaceholders(String input, ParameterAccessor accessor) {
 		return result;
 	}
 
+	private String replaceNamedParameters(String input, ElasticsearchParameterAccessor accessor) {
+
+		final String[] result = { input };
+		accessor.getParameters().forEach(parameter -> result[0] = result[0]
+				.replaceAll(Pattern.quote(parameter.getPlaceholder()), getParameterWithIndex(accessor, parameter.getIndex())));
+		return result[0];
+	}
+
 	private String getParameterWithIndex(ParameterAccessor accessor, int index) {
 
 		Object parameter = accessor.getBindableValue(index);