Add support for SpEL in @query

Author: puppylpg

src/main/antora/modules/ROOT/pages/elasticsearch/repositories/elasticsearch-repository-queries.adoc

@@ -316,7 +316,7 @@ Repository methods can be defined to have the following return types for returni
 
 .Declare query on the method using the `@Query` annotation.
 ====
-The arguments passed to the method can be inserted into placeholders in the query string. the placeholders are of the form `?0`, `?1`, `?2` etc. for the first, second, third parameter and so on.
+The arguments passed to the method can be inserted into placeholders in the query string. The placeholders are of the form `?0`, `?1`, `?2` etc. for the first, second, third parameter and so on.
 [source,java]
 ----
 interface BookRepository extends ElasticsearchRepository<Book, String> {

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

@@ -17,11 +17,22 @@
 
 import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
 import org.springframework.data.elasticsearch.core.query.BaseQuery;
-import org.springframework.data.elasticsearch.core.query.Query;
 import org.springframework.data.elasticsearch.core.query.StringQuery;
 import org.springframework.data.elasticsearch.repository.support.StringQueryUtil;
+import org.springframework.data.repository.query.QueryMethodEvaluationContextProvider;
+import org.springframework.expression.EvaluationContext;
+import org.springframework.expression.Expression;
+import org.springframework.expression.ParserContext;
+import org.springframework.expression.TypeConverter;
+import org.springframework.expression.common.LiteralExpression;
+import org.springframework.expression.spel.standard.SpelExpressionParser;
+import org.springframework.expression.spel.support.StandardEvaluationContext;
+import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
 /**
  * ElasticsearchStringQuery
  *
@@ -30,16 +41,27 @@
  * @author Mark Paluch
  * @author Taylor Ono
  * @author Peter-Josef Meisch
+ * @author Haibo Liu
  */
 public class ElasticsearchStringQuery extends AbstractElasticsearchRepositoryQuery {
 
 	private final String queryString;
+	private static final SpelExpressionParser PARSER = new SpelExpressionParser();
+	private Map<String, Expression> queryExpressions = new ConcurrentHashMap<>();
+	private final QueryMethodEvaluationContextProvider evaluationContextProvider;
+	private final TypeConverter typeConverter;
 
 	public ElasticsearchStringQuery(ElasticsearchQueryMethod queryMethod, ElasticsearchOperations elasticsearchOperations,
-			String queryString) {
+			String queryString, QueryMethodEvaluationContextProvider evaluationContextProvider,
+			TypeConverter typeConverter) {
 		super(queryMethod, elasticsearchOperations);
 		Assert.notNull(queryString, "Query cannot be empty");
+		Assert.notNull(evaluationContextProvider, "ExpressionEvaluationContextProvider must not be null");
+		Assert.notNull(typeConverter, "TypeConverter must not be null");
+
 		this.queryString = queryString;
+		this.evaluationContextProvider = evaluationContextProvider;
+		this.typeConverter = typeConverter;
 	}
 
 	@Override
@@ -58,12 +80,36 @@ protected boolean isExistsQuery() {
 	}
 
 	protected BaseQuery createQuery(ElasticsearchParametersParameterAccessor parameterAccessor) {
-
 		String queryString = new StringQueryUtil(elasticsearchOperations.getElasticsearchConverter().getConversionService())
 				.replacePlaceholders(this.queryString, parameterAccessor);
 
-		var query = new StringQuery(queryString);
+		var query = new StringQuery(parseSpEL(queryString, parameterAccessor));
 		query.addSort(parameterAccessor.getSort());
 		return query;
 	}
+
+	private String parseSpEL(String queryString, ElasticsearchParametersParameterAccessor parameterAccessor) {
+		Expression expr = getQueryExpression(queryString);
+		if (expr != null) {
+			EvaluationContext context = evaluationContextProvider.getEvaluationContext(parameterAccessor.getParameters(),
+					parameterAccessor.getValues());
+			if (context instanceof StandardEvaluationContext standardEvaluationContext) {
+				standardEvaluationContext.setTypeConverter(typeConverter);
+			}
+
+			String parsed = expr.getValue(context, String.class);
+			Assert.notNull(parsed, "Query parsed by SpEL should not be null");
+			return parsed;
+		}
+		return queryString;
+	}
+
+	@Nullable
+	private Expression getQueryExpression(String queryString) {
+		return queryExpressions.computeIfAbsent(queryString, f -> {
+			Expression expr = PARSER.parseExpression(queryString, ParserContext.TEMPLATE_EXPRESSION);
+			return expr instanceof LiteralExpression ? null : expr;
+		});
+
+	}
 }

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

@@ -0,0 +1,78 @@
+/*
+ * Copyright 2024 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
+ *
+ *      https://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.elasticsearch.repository.support;
+
+import org.springframework.core.convert.ConversionService;
+import org.springframework.core.convert.TypeDescriptor;
+import org.springframework.core.convert.converter.GenericConverter;
+import org.springframework.lang.Nullable;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Set;
+import java.util.StringJoiner;
+import java.util.regex.Matcher;
+
+/**
+ * Convert a collection into string for value part of the elasticsearch query.
+ * The string should be wrapped with square brackets, with each element quoted
+ * therefore escaped if quotes exist in the original element.
+ * <p>
+ * eg: {@code ["hello \"Stranger\"","Another string"]} for terms query
+ * {@code { 'bool' : { 'must' : { 'terms' : { 'name' : ["hello \"Stranger\"","Another string"] } } } }}
+ *
+ * @author Haibo Liu
+ */
+public class ElasticsearchCollectionToStringConverter implements GenericConverter {
+
+	private static final String DELIMITER = ",";
+
+	private final ConversionService conversionService;
+
+
+	public ElasticsearchCollectionToStringConverter(ConversionService conversionService) {
+		this.conversionService = conversionService;
+	}
+
+	@Override
+	public Set<ConvertiblePair> getConvertibleTypes() {
+		return Collections.singleton(new ConvertiblePair(Collection.class, String.class));
+	}
+
+	@Override
+	@Nullable
+	public Object convert(@Nullable Object source, TypeDescriptor sourceType, TypeDescriptor targetType) {
+		if (source == null) {
+			return null;
+		}
+		Collection<?> sourceCollection = (Collection<?>) source;
+		if (sourceCollection.isEmpty()) {
+			return "[]";
+		}
+		StringJoiner sb = new StringJoiner(DELIMITER, "[", "]");
+		for (Object sourceElement : sourceCollection) {
+			Object targetElement = this.conversionService.convert(
+					sourceElement, sourceType.elementTypeDescriptor(sourceElement), targetType);
+			sb.add("\"" + escape(targetElement) + "\"");
+		}
+		return sb.toString();
+	}
+
+	private String escape(@Nullable Object target) {
+		// escape the quotes in the string, because the string should already be quoted manually
+		return String.valueOf(target).replaceAll("\"", Matcher.quoteReplacement("\\\""));
+	}
+}

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

@@ -15,6 +15,9 @@
  */
 package org.springframework.data.elasticsearch.repository.support;
 
+import org.springframework.core.convert.ConversionService;
+import org.springframework.core.convert.converter.ConverterRegistry;
+import org.springframework.core.convert.support.DefaultConversionService;
 import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
 import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
 import org.springframework.data.elasticsearch.repository.query.ElasticsearchPartQuery;
@@ -34,6 +37,8 @@
 import org.springframework.data.repository.query.QueryLookupStrategy.Key;
 import org.springframework.data.repository.query.QueryMethodEvaluationContextProvider;
 import org.springframework.data.repository.query.RepositoryQuery;
+import org.springframework.expression.TypeConverter;
+import org.springframework.expression.spel.support.StandardTypeConverter;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
@@ -54,6 +59,7 @@
  * @author Sascha Woo
  * @author Peter-Josef Meisch
  * @author Ezequiel Antúnez Camacho
+ * @author Haibo Liu
  */
 public class ElasticsearchRepositoryFactory extends RepositoryFactorySupport {
 
@@ -96,11 +102,24 @@ private static boolean isQueryDslRepository(Class<?> repositoryInterface) {
 	@Override
 	protected Optional<QueryLookupStrategy> getQueryLookupStrategy(@Nullable Key key,
 			QueryMethodEvaluationContextProvider evaluationContextProvider) {
-		return Optional.of(new ElasticsearchQueryLookupStrategy());
+		return Optional.of(new ElasticsearchQueryLookupStrategy(evaluationContextProvider));
 	}
 
 	private class ElasticsearchQueryLookupStrategy implements QueryLookupStrategy {
 
+		QueryMethodEvaluationContextProvider evaluationContextProvider;
+		private TypeConverter typeConverter;
+
+		ElasticsearchQueryLookupStrategy(QueryMethodEvaluationContextProvider evaluationContextProvider) {
+			this.evaluationContextProvider = evaluationContextProvider;
+
+			// register elasticsearch custom type converter for conversion service
+			ConversionService conversionService = new DefaultConversionService();
+			ConverterRegistry converterRegistry = (ConverterRegistry) conversionService;
+			converterRegistry.addConverter(new ElasticsearchCollectionToStringConverter(conversionService));
+			typeConverter = new StandardTypeConverter(conversionService);
+		}
+
 		/*
 		 * (non-Javadoc)
 		 * @see org.springframework.data.repository.query.QueryLookupStrategy#resolveQuery(java.lang.reflect.Method, org.springframework.data.repository.core.RepositoryMetadata, org.springframework.data.projection.ProjectionFactory, org.springframework.data.repository.core.NamedQueries)
@@ -115,9 +134,11 @@ public RepositoryQuery resolveQuery(Method method, RepositoryMetadata metadata,
 
 			if (namedQueries.hasQuery(namedQueryName)) {
 				String namedQuery = namedQueries.getQuery(namedQueryName);
-				return new ElasticsearchStringQuery(queryMethod, elasticsearchOperations, namedQuery);
+				return new ElasticsearchStringQuery(queryMethod, elasticsearchOperations, namedQuery,
+						evaluationContextProvider, typeConverter);
 			} else if (queryMethod.hasAnnotatedQuery()) {
-				return new ElasticsearchStringQuery(queryMethod, elasticsearchOperations, queryMethod.getAnnotatedQuery());
+				return new ElasticsearchStringQuery(queryMethod, elasticsearchOperations, queryMethod.getAnnotatedQuery(),
+						evaluationContextProvider, typeConverter);
 			}
 			return new ElasticsearchPartQuery(queryMethod, elasticsearchOperations);
 		}

src/test/java/org/springframework/data/elasticsearch/repositories/custommethod/CustomMethodRepositoryELCIntegrationTests.java

@@ -25,6 +25,7 @@
 
 /**
  * @author Peter-Josef Meisch
+ * @author Haibo Liu
  * @since 4.4
  */
 @ContextConfiguration(classes = { CustomMethodRepositoryELCIntegrationTests.Config.class })
@@ -40,5 +41,13 @@ static class Config {
 		IndexNameProvider indexNameProvider() {
 			return new IndexNameProvider("custom-method-repository");
 		}
+
+		/**
+		 * a normal bean referenced by SpEL in query
+		 */
+		@Bean
+		QueryParam queryParam() {
+			return new QueryParam("abc");
+		}
 	}
 }