Skip to content

Added fallback mechanism for QueryEnhancer. #2639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@
import jakarta.persistence.EntityManager;
import jakarta.persistence.Query;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.repository.QueryRewriter;
Expand Down Expand Up @@ -65,8 +62,8 @@ abstract class AbstractStringBasedJpaQuery extends AbstractJpaQuery {
* @param queryRewriter must not be {@literal null}.
*/
public AbstractStringBasedJpaQuery(JpaQueryMethod method, EntityManager em, String queryString,
@Nullable String countQueryString, QueryRewriter queryRewriter, QueryMethodEvaluationContextProvider evaluationContextProvider,
SpelExpressionParser parser) {
@Nullable String countQueryString, QueryRewriter queryRewriter,
QueryMethodEvaluationContextProvider evaluationContextProvider, SpelExpressionParser parser) {

super(method, em);

Expand All @@ -77,7 +74,7 @@ public AbstractStringBasedJpaQuery(JpaQueryMethod method, EntityManager em, Stri

this.evaluationContextProvider = evaluationContextProvider;
this.query = new ExpressionBasedStringQuery(queryString, method.getEntityInformation(), parser,
method.isNativeQuery());
method.isNativeQuery(), method.getQueryEnhancerChoice());

DeclaredQuery countQuery = query.deriveCountQuery(countQueryString, method.getCountQueryProjection());
this.countQuery = ExpressionBasedStringQuery.from(countQuery, method.getEntityInformation(), parser,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
* @author Diego Krupitza
* @since 2.0.3
*/
interface DeclaredQuery {
public interface DeclaredQuery {

/**
* Creates a {@literal DeclaredQuery} from a query {@literal String}.
Expand Down Expand Up @@ -111,4 +111,27 @@ default boolean usesPaging() {
default boolean isNativeQuery() {
return false;
}

/**
* Gets the {@link QueryEnhancer} used for this Query.
*
* @return the concrete {@link QueryEnhancer} implementation used for this given Query
*/
@Nullable
QueryEnhancer getQueryEnhancer();

/**
* Returns the methods {@link QueryEnhancerChoice} annotation
*
* @return
*/
@Nullable
QueryEnhancerChoice getQueryEnhancerChoice();

/**
* Returns whether the method has a {@link QueryEnhancerChoice} or not
*
* @return
*/
boolean hasQueryEnhancerChoice();
}
Original file line number Diff line number Diff line change
Expand Up @@ -26,41 +26,35 @@
* @author Diego Krupitza
* @since 2.7.0
*/
public class DefaultQueryEnhancer implements QueryEnhancer {

private final DeclaredQuery query;
public class DefaultQueryEnhancer extends QueryEnhancer {

public DefaultQueryEnhancer(DeclaredQuery query) {
this.query = query;
super(query);
}

@Override
public String applySorting(Sort sort, @Nullable String alias) {
return QueryUtils.applySorting(this.query.getQueryString(), sort, alias);
return QueryUtils.applySorting(this.getQuery().getQueryString(), sort, alias);
}

@Override
public String detectAlias() {
return QueryUtils.detectAlias(this.query.getQueryString());
return QueryUtils.detectAlias(this.getQuery().getQueryString());
}

@Override
public String createCountQueryFor(@Nullable String countProjection) {
return QueryUtils.createCountQueryFor(this.query.getQueryString(), countProjection);
return QueryUtils.createCountQueryFor(this.getQuery().getQueryString(), countProjection);
}

@Override
public String getProjection() {
return QueryUtils.getProjection(this.query.getQueryString());
return QueryUtils.getProjection(this.getQuery().getQueryString());
}

@Override
public Set<String> getJoinAliases() {
return QueryUtils.getOuterJoinAliases(this.query.getQueryString());
return QueryUtils.getOuterJoinAliases(this.getQuery().getQueryString());
}

@Override
public DeclaredQuery getQuery() {
return this.query;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
* NULL-Object pattern implementation for {@link DeclaredQuery}.
*
* @author Jens Schauder
* @author Diego Krupitza
* @since 2.0.3
*/
class EmptyDeclaredQuery implements DeclaredQuery {
Expand Down Expand Up @@ -76,4 +77,19 @@ public DeclaredQuery deriveCountQuery(@Nullable String countQuery, @Nullable Str
public boolean usesJdbcStyleParameters() {
return false;
}

@Override
public QueryEnhancer getQueryEnhancer() {
return null;
}

@Override
public QueryEnhancerChoice getQueryEnhancerChoice() {
return null;
}

@Override
public boolean hasQueryEnhancerChoice() {
return false;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,13 @@
import org.springframework.expression.ParserContext;
import org.springframework.expression.spel.standard.SpelExpressionParser;
import org.springframework.expression.spel.support.StandardEvaluationContext;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

/**
* Extension of {@link StringQuery} that evaluates the given query string as a SpEL template-expression.
* <p>
* Currently the following template variables are available:
* Currently, the following template variables are available:
* <ol>
* <li>{@code #entityName} - the simple class name of the given entity</li>
* <ol>
Expand Down Expand Up @@ -60,7 +61,23 @@ class ExpressionBasedStringQuery extends StringQuery {
*/
public ExpressionBasedStringQuery(String query, JpaEntityMetadata<?> metadata, SpelExpressionParser parser,
boolean nativeQuery) {
super(renderQueryIfExpressionOrReturnQuery(query, metadata, parser), nativeQuery && !containsExpression(query));
super(renderQueryIfExpressionOrReturnQuery(query, metadata, parser), nativeQuery && !containsExpression(query),
null);
}

/**
* Creates a new {@link ExpressionBasedStringQuery} for the given query and {@link EntityMetadata}.
*
* @param query must not be {@literal null} or empty.
* @param metadata must not be {@literal null}.
* @param parser must not be {@literal null}.
* @param nativeQuery is a given query is native or not
* @param queryEnhancerChoice may be {@literal null}.
*/
public ExpressionBasedStringQuery(String query, JpaEntityMetadata<?> metadata, SpelExpressionParser parser,
boolean nativeQuery, @Nullable QueryEnhancerChoice queryEnhancerChoice) {
super(renderQueryIfExpressionOrReturnQuery(query, metadata, parser), nativeQuery && !containsExpression(query),
queryEnhancerChoice);
}

/**
Expand All @@ -74,7 +91,8 @@ public ExpressionBasedStringQuery(String query, JpaEntityMetadata<?> metadata, S
*/
static ExpressionBasedStringQuery from(DeclaredQuery query, JpaEntityMetadata<?> metadata,
SpelExpressionParser parser, boolean nativeQuery) {
return new ExpressionBasedStringQuery(query.getQueryString(), metadata, parser, nativeQuery);
return new ExpressionBasedStringQuery(query.getQueryString(), metadata, parser, nativeQuery,
query.getQueryEnhancerChoice());
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@
*/
package org.springframework.data.jpa.repository.query;

import static org.springframework.data.jpa.repository.query.JSqlParserUtils.getJSqlCount;
import static org.springframework.data.jpa.repository.query.JSqlParserUtils.getJSqlLower;
import static org.springframework.data.jpa.repository.query.QueryUtils.checkSortExpression;
import static org.springframework.data.jpa.repository.query.JSqlParserUtils.*;
import static org.springframework.data.jpa.repository.query.QueryUtils.*;

import net.sf.jsqlparser.JSQLParserException;
import net.sf.jsqlparser.expression.Alias;
Expand All @@ -29,11 +28,23 @@
import net.sf.jsqlparser.statement.delete.Delete;
import net.sf.jsqlparser.statement.insert.Insert;
import net.sf.jsqlparser.statement.merge.Merge;
import net.sf.jsqlparser.statement.select.*;
import net.sf.jsqlparser.statement.select.OrderByElement;
import net.sf.jsqlparser.statement.select.PlainSelect;
import net.sf.jsqlparser.statement.select.Select;
import net.sf.jsqlparser.statement.select.SelectBody;
import net.sf.jsqlparser.statement.select.SelectExpressionItem;
import net.sf.jsqlparser.statement.select.SelectItem;
import net.sf.jsqlparser.statement.select.SetOperationList;
import net.sf.jsqlparser.statement.select.WithItem;
import net.sf.jsqlparser.statement.update.Update;
import net.sf.jsqlparser.statement.values.ValuesStatement;

import java.util.*;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;

import org.springframework.data.domain.Sort;
Expand All @@ -50,17 +61,15 @@
* @author Geoffrey Deremetz
* @since 2.7.0
*/
public class JSqlParserQueryEnhancer implements QueryEnhancer {
public class JSqlParserQueryEnhancer extends QueryEnhancer {

private final DeclaredQuery query;
private final ParsedType parsedType;

/**
* @param query the query we want to enhance. Must not be {@literal null}.
*/
public JSqlParserQueryEnhancer(DeclaredQuery query) {

this.query = query;
super(query);
this.parsedType = detectParsedType();
}

Expand All @@ -72,7 +81,7 @@ public JSqlParserQueryEnhancer(DeclaredQuery query) {
private ParsedType detectParsedType() {

try {
Statement statement = CCJSqlParserUtil.parse(this.query.getQueryString());
Statement statement = CCJSqlParserUtil.parse(this.getQuery().getQueryString());

if (statement instanceof Insert) {
return ParsedType.INSERT;
Expand All @@ -95,7 +104,7 @@ private ParsedType detectParsedType() {
@Override
public String applySorting(Sort sort, @Nullable String alias) {

String queryString = query.getQueryString();
String queryString = this.getQuery().getQueryString();
Assert.hasText(queryString, "Query must not be null or empty");

if (this.parsedType != ParsedType.SELECT) {
Expand Down Expand Up @@ -192,7 +201,7 @@ Set<String> getSelectionAliases() {
return new HashSet<>();
}

Select selectStatement = parseSelectStatement(this.query.getQueryString());
Select selectStatement = parseSelectStatement(this.getQuery().getQueryString());
PlainSelect selectBody = (PlainSelect) selectStatement.getSelectBody();
return this.getSelectionAliases(selectBody);
}
Expand Down Expand Up @@ -280,7 +289,7 @@ private OrderByElement getOrderClause(final Set<String> joinAliases, final Set<S

@Override
public String detectAlias() {
return detectAlias(this.query.getQueryString());
return detectAlias(this.getQuery().getQueryString());
}

/**
Expand Down Expand Up @@ -354,18 +363,18 @@ private String detectAlias(Merge mergeStatement) {
public String createCountQueryFor(@Nullable String countProjection) {

if (this.parsedType != ParsedType.SELECT) {
return this.query.getQueryString();
return this.getQuery().getQueryString();
}

Assert.hasText(this.query.getQueryString(), "OriginalQuery must not be null or empty");
Assert.hasText(this.getQuery().getQueryString(), "OriginalQuery must not be null or empty");

Select selectStatement = parseSelectStatement(this.query.getQueryString());
Select selectStatement = parseSelectStatement(this.getQuery().getQueryString());

/*
We only support count queries for {@link PlainSelect}.
*/
if (!(selectStatement.getSelectBody() instanceof PlainSelect)) {
return this.query.getQueryString();
return this.getQuery().getQueryString();
}

PlainSelect selectBody = (PlainSelect) selectStatement.getSelectBody();
Expand Down Expand Up @@ -423,9 +432,9 @@ public String getProjection() {
return "";
}

Assert.hasText(query.getQueryString(), "Query must not be null or empty");
Assert.hasText(this.getQuery().getQueryString(), "Query must not be null or empty");

Select selectStatement = parseSelectStatement(query.getQueryString());
Select selectStatement = parseSelectStatement(this.getQuery().getQueryString());

if (selectStatement.getSelectBody() instanceof ValuesStatement) {
return "";
Expand All @@ -451,7 +460,7 @@ public String getProjection() {

@Override
public Set<String> getJoinAliases() {
return this.getJoinAliases(this.query.getQueryString());
return this.getJoinAliases(this.getQuery().getQueryString());
}

/**
Expand Down Expand Up @@ -492,11 +501,6 @@ private boolean onlyASingleColumnProjection(List<SelectItem> projection) {
&& (((SelectExpressionItem) projection.get(0)).getExpression()) instanceof Column;
}

@Override
public DeclaredQuery getQuery() {
return this.query;
}

/**
* An enum to represent the top level parsed statement of the provided query.
* <ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
* @author Сергей Цыпанов
* @author Réda Housni Alaoui
* @author Greg Turnquist
* @author Diego Krupitza
*/
public class JpaQueryMethod extends QueryMethod {

Expand Down Expand Up @@ -98,6 +99,7 @@ public class JpaQueryMethod extends QueryMethod {
private final Lazy<Boolean> isProcedureQuery;
private final Lazy<JpaEntityMetadata<?>> entityMetadata;
private final Map<Class<? extends Annotation>, Optional<Annotation>> annotationCache;
private final Lazy<QueryEnhancerChoice> queryEnhancerChoice;

/**
* Creates a {@link JpaQueryMethod}.
Expand Down Expand Up @@ -140,6 +142,11 @@ protected JpaQueryMethod(Method method, RepositoryMetadata metadata, ProjectionF
this.isProcedureQuery = Lazy.of(() -> AnnotationUtils.findAnnotation(method, Procedure.class) != null);
this.entityMetadata = Lazy.of(() -> new DefaultJpaEntityMetadata<>(getDomainClass()));
this.annotationCache = new ConcurrentReferenceHashMap<>();
this.queryEnhancerChoice = Lazy.of(() -> //
Optional.ofNullable(AnnotatedElementUtils.findMergedAnnotation(method, QueryEnhancerChoice.class)) //
.orElseGet(
() -> AnnotatedElementUtils.findMergedAnnotation(method.getDeclaringClass(), QueryEnhancerChoice.class)) //
);

Assert.isTrue(!(isModifyingQuery() && getParameters().hasSpecialParameter()),
String.format("Modifying method must not contain %s", Parameters.TYPES));
Expand Down Expand Up @@ -387,6 +394,25 @@ boolean isNativeQuery() {
return this.isNativeQuery.get();
}

/**
* Returns the methods {@link QueryEnhancerChoice} annotation
*
* @return
*/
@Nullable
QueryEnhancerChoice getQueryEnhancerChoice() {
return this.queryEnhancerChoice.getNullable();
}

/**
* Returns whether the method has a {@link QueryEnhancerChoice} or not
*
* @return
*/
boolean hasQueryEnhancerChoice() {
return this.queryEnhancerChoice.getOptional().isPresent();
}

@Override
public String getNamedQueryName() {

Expand Down
Loading