Cache string query after processing sort

Author: christophstrobl

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/AbstractStringBasedJpaQuery.java

@@ -18,6 +18,8 @@
 import jakarta.persistence.EntityManager;
 import jakarta.persistence.Query;
 
+import java.util.Objects;
+
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.jpa.repository.QueryRewriter;
@@ -28,6 +30,7 @@
 import org.springframework.expression.spel.standard.SpelExpressionParser;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
+import org.springframework.util.ConcurrentLruCache;
 
 /**
  * Base class for {@link String} based JPA queries.
@@ -40,6 +43,7 @@
  * @author Mark Paluch
  * @author Diego Krupitza
  * @author Greg Turnquist
+ * @author Christoph Strobl
  */
 abstract class AbstractStringBasedJpaQuery extends AbstractJpaQuery {
 
@@ -49,6 +53,7 @@ abstract class AbstractStringBasedJpaQuery extends AbstractJpaQuery {
 	private final SpelExpressionParser parser;
 	private final QueryParameterSetter.QueryMetadataCache metadataCache = new QueryParameterSetter.QueryMetadataCache();
 	private final QueryRewriter queryRewriter;
+	private ConcurrentLruCache<CachableQuery, String> queryCache = new ConcurrentLruCache<>(100, this::applySorting);
 
 	/**
 	 * Creates a new {@link AbstractStringBasedJpaQuery} from the given {@link JpaQueryMethod}, {@link EntityManager} and
@@ -106,16 +111,8 @@ public Query doCreateQuery(JpaParametersParameterAccessor accessor) {
 		return parameterBinder.get().bindAndPrepare(query, metadata, accessor);
 	}
 
-	private String applySortingIfNecessary(DeclaredQuery query, Sort sort) {
-
-		if (sort.isUnsorted()) {
-			return query.getQueryString();
-		}
-		return applySorting(query, sort);
-	}
-
 	protected String applySorting(DeclaredQuery query, Sort sort) {
-		return QueryEnhancerFactory.forQuery(query).applySorting(sort, query.getAlias());
+		return queryCache.get(new CachableQuery(query, sort));
 	}
 
 	@Override
@@ -191,4 +188,77 @@ protected String potentiallyRewriteQuery(String originalQuery, Sort sort, @Nulla
 				? queryRewriter.rewrite(originalQuery, pageable) //
 				: queryRewriter.rewrite(originalQuery, sort);
 	}
+
+	String applySorting(CachableQuery cachableQuery) {
+
+		return QueryEnhancerFactory.forQuery(cachableQuery.getDeclaredQuery()).applySorting(cachableQuery.getSort(),
+				cachableQuery.getAlias());
+	}
+
+	private String applySortingIfNecessary(DeclaredQuery query, Sort sort) {
+
+		if (sort.isUnsorted()) {
+			return query.getQueryString();
+		}
+		return applySorting(query, sort);
+	}
+
+	/**
+	 * Value object with optimized {@link Object#equals(Object)} to cache a query based on its query string and
+	 * {@link Sort sorting}.
+	 *
+	 * @since 3.2.3
+	 * @author Christoph Strobl
+	 */
+	static class CachableQuery {
+
+		private DeclaredQuery declaredQuery;
+		private final String queryString;
+		private final Sort sort;
+
+		CachableQuery(DeclaredQuery query, Sort sort) {
+
+			this.declaredQuery = query;
+			this.queryString = query.getQueryString();
+			this.sort = sort;
+		}
+
+		DeclaredQuery getDeclaredQuery() {
+			return declaredQuery;
+		}
+
+		Sort getSort() {
+			return sort;
+		}
+
+		String getAlias() {
+			return declaredQuery.getAlias();
+		}
+
+		@Override
+		public boolean equals(Object o) {
+
+			if (this == o) {
+				return true;
+			}
+			if (o == null || getClass() != o.getClass()) {
+				return false;
+			}
+
+			CachableQuery that = (CachableQuery) o;
+
+			if (!Objects.equals(queryString, that.queryString)) {
+				return false;
+			}
+			return Objects.equals(sort, that.sort);
+		}
+
+		@Override
+		public int hashCode() {
+
+			int result = queryString != null ? queryString.hashCode() : 0;
+			result = 31 * result + (sort != null ? sort.hashCode() : 0);
+			return result;
+		}
+	}
 }

spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/AbstractStringBasedJpaQueryUnitTests.java

@@ -80,6 +80,20 @@ void shouldAppendSortIfSortPresent() {
 		stringQuery.called("applySorting").times(1);
 	}
 
+	@Test // GH-3311
+	void cachesInvocationBasedOnSortArgument() {
+
+		InvocationCapturingStringQueryStub stringQuery = forMethod(TestRepo.class, "find", Sort.class);
+		stringQuery.createQueryWithArguments(Sort.by("name"));
+		stringQuery.called("applySorting").times(1);
+
+		stringQuery.createQueryWithArguments(Sort.by("name"));
+		stringQuery.called("applySorting").times(1);
+
+		stringQuery.createQueryWithArguments(Sort.by("age"));
+		stringQuery.called("applySorting").times(2);
+	}
+
 	interface TestRepo extends Repository<Object, Object> {
 
 		@Query("SELECT e FROM Employee e")
@@ -132,11 +146,11 @@ public EntityManager get() {
 		}
 
 		@Override
-		protected String applySorting(DeclaredQuery query, Sort sort) {
+		protected String applySorting(CachableQuery query) {
 
-			captureInvocation("applySorting", query, sort);
+			captureInvocation("applySorting", query);
 
-			return super.applySorting(query, sort);
+			return super.applySorting(query);
 		}
 
 		@Override