org.springframework.data.jpa.repository.support.QuerydslJpaPredicateExecutor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-jpa Show documentation
Show all versions of spring-data-jpa Show documentation
Spring Data module for JPA repositories.
/*
* Copyright 2008-2021 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.jpa.repository.support;
import java.util.List;
import java.util.Optional;
import javax.persistence.EntityManager;
import javax.persistence.LockModeType;
import org.springframework.dao.IncorrectResultSizeDataAccessException;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.repository.EntityGraph;
import org.springframework.data.querydsl.EntityPathResolver;
import org.springframework.data.querydsl.QSort;
import org.springframework.data.querydsl.QuerydslPredicateExecutor;
import org.springframework.data.repository.support.PageableExecutionUtils;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import com.querydsl.core.NonUniqueResultException;
import com.querydsl.core.types.EntityPath;
import com.querydsl.core.types.OrderSpecifier;
import com.querydsl.core.types.Predicate;
import com.querydsl.core.types.dsl.PathBuilder;
import com.querydsl.jpa.JPQLQuery;
import com.querydsl.jpa.impl.AbstractJPAQuery;
/**
* Querydsl specific fragment for extending {@link SimpleJpaRepository} with an implementation of
* {@link QuerydslPredicateExecutor}.
*
* @author Oliver Gierke
* @author Thomas Darimont
* @author Mark Paluch
* @author Jocelyn Ntakpe
* @author Christoph Strobl
* @author Jens Schauder
*/
public class QuerydslJpaPredicateExecutor implements QuerydslPredicateExecutor {
private final JpaEntityInformation entityInformation;
private final EntityPath path;
private final Querydsl querydsl;
private final EntityManager entityManager;
private final CrudMethodMetadata metadata;
/**
* Creates a new {@link QuerydslJpaPredicateExecutor} from the given domain class and {@link EntityManager} and uses
* the given {@link EntityPathResolver} to translate the domain class into an {@link EntityPath}.
*
* @param entityInformation must not be {@literal null}.
* @param entityManager must not be {@literal null}.
* @param resolver must not be {@literal null}.
* @param metadata maybe {@literal null}.
*/
public QuerydslJpaPredicateExecutor(JpaEntityInformation entityInformation, EntityManager entityManager,
EntityPathResolver resolver, @Nullable CrudMethodMetadata metadata) {
this.entityInformation = entityInformation;
this.metadata = metadata;
this.path = resolver.createPath(entityInformation.getJavaType());
this.querydsl = new Querydsl(entityManager, new PathBuilder(path.getType(), path.getMetadata()));
this.entityManager = entityManager;
}
/*
* (non-Javadoc)
* @see org.springframework.data.querydsl.QuerydslPredicateExecutor#findOne(com.mysema.query.types.Predicate)
*/
@Override
public Optional findOne(Predicate predicate) {
Assert.notNull(predicate, "Predicate must not be null!");
try {
return Optional.ofNullable(createQuery(predicate).select(path).fetchOne());
} catch (NonUniqueResultException ex) {
throw new IncorrectResultSizeDataAccessException(ex.getMessage(), 1, ex);
}
}
/*
* (non-Javadoc)
* @see org.springframework.data.querydsl.QuerydslPredicateExecutor#findAll(com.mysema.query.types.Predicate)
*/
@Override
public List findAll(Predicate predicate) {
Assert.notNull(predicate, "Predicate must not be null!");
return createQuery(predicate).select(path).fetch();
}
/*
* (non-Javadoc)
* @see org.springframework.data.querydsl.QuerydslPredicateExecutor#findAll(com.mysema.query.types.Predicate, com.mysema.query.types.OrderSpecifier[])
*/
@Override
public List findAll(Predicate predicate, OrderSpecifier... orders) {
Assert.notNull(predicate, "Predicate must not be null!");
Assert.notNull(orders, "Order specifiers must not be null!");
return executeSorted(createQuery(predicate).select(path), orders);
}
/*
* (non-Javadoc)
* @see org.springframework.data.querydsl.QuerydslPredicateExecutor#findAll(com.mysema.query.types.Predicate, org.springframework.data.domain.Sort)
*/
@Override
public List findAll(Predicate predicate, Sort sort) {
Assert.notNull(predicate, "Predicate must not be null!");
Assert.notNull(sort, "Sort must not be null!");
return executeSorted(createQuery(predicate).select(path), sort);
}
/*
* (non-Javadoc)
* @see org.springframework.data.querydsl.QuerydslPredicateExecutor#findAll(com.mysema.query.types.OrderSpecifier[])
*/
@Override
public List findAll(OrderSpecifier... orders) {
Assert.notNull(orders, "Order specifiers must not be null!");
return executeSorted(createQuery(new Predicate[0]).select(path), orders);
}
/*
* (non-Javadoc)
* @see org.springframework.data.querydsl.QuerydslPredicateExecutor#findAll(com.querydsl.core.types.Predicate, org.springframework.data.domain.Pageable)
*/
@Override
public Page findAll(Predicate predicate, Pageable pageable) {
Assert.notNull(predicate, "Predicate must not be null!");
Assert.notNull(pageable, "Pageable must not be null!");
final JPQLQuery countQuery = createCountQuery(predicate);
JPQLQuery query = querydsl.applyPagination(pageable, createQuery(predicate).select(path));
return PageableExecutionUtils.getPage(query.fetch(), pageable, countQuery::fetchCount);
}
/*
* (non-Javadoc)
* @see org.springframework.data.querydsl.QueryDslPredicateExecutor#count(com.mysema.query.types.Predicate)
*/
@Override
public long count(Predicate predicate) {
return createQuery(predicate).fetchCount();
}
/*
* (non-Javadoc)
* @see org.springframework.data.querydsl.QueryDslPredicateExecutor#exists(com.mysema.query.types.Predicate)
*/
@Override
public boolean exists(Predicate predicate) {
return createQuery(predicate).fetchCount() > 0;
}
/**
* Creates a new {@link JPQLQuery} for the given {@link Predicate}.
*
* @param predicate
* @return the Querydsl {@link JPQLQuery}.
*/
protected JPQLQuery createQuery(Predicate... predicate) {
Assert.notNull(predicate, "Predicate must not be null!");
AbstractJPAQuery query = doCreateQuery(getQueryHints().withFetchGraphs(entityManager), predicate);
CrudMethodMetadata metadata = getRepositoryMethodMetadata();
if (metadata == null) {
return query;
}
LockModeType type = metadata.getLockModeType();
return type == null ? query : query.setLockMode(type);
}
/**
* Creates a new {@link JPQLQuery} count query for the given {@link Predicate}.
*
* @param predicate, can be {@literal null}.
* @return the Querydsl count {@link JPQLQuery}.
*/
protected JPQLQuery createCountQuery(@Nullable Predicate... predicate) {
return doCreateQuery(getQueryHintsForCount(), predicate);
}
@Nullable
private CrudMethodMetadata getRepositoryMethodMetadata() {
return metadata;
}
/**
* Returns {@link QueryHints} with the query hints based on the current {@link CrudMethodMetadata} and potential
* {@link EntityGraph} information.
*
* @return
*/
private QueryHints getQueryHints() {
return metadata == null ? QueryHints.NoHints.INSTANCE : DefaultQueryHints.of(entityInformation, metadata);
}
/**
* Returns {@link QueryHints} with the query hints based on the current {@link CrudMethodMetadata} and potential
* {@link EntityGraph} information and filtered for those hints that are to be applied to count queries.
*
* @return
*/
private QueryHints getQueryHintsForCount() {
return metadata == null ? QueryHints.NoHints.INSTANCE
: DefaultQueryHints.of(entityInformation, metadata).forCounts();
}
private AbstractJPAQuery doCreateQuery(QueryHints hints, @Nullable Predicate... predicate) {
AbstractJPAQuery query = querydsl.createQuery(path);
if (predicate != null) {
query = query.where(predicate);
}
hints.forEach(query::setHint);
return query;
}
/**
* Executes the given {@link JPQLQuery} after applying the given {@link OrderSpecifier}s.
*
* @param query must not be {@literal null}.
* @param orders must not be {@literal null}.
* @return
*/
private List executeSorted(JPQLQuery query, OrderSpecifier... orders) {
return executeSorted(query, new QSort(orders));
}
/**
* Executes the given {@link JPQLQuery} after applying the given {@link Sort}.
*
* @param query must not be {@literal null}.
* @param sort must not be {@literal null}.
* @return
*/
private List executeSorted(JPQLQuery query, Sort sort) {
return querydsl.applySorting(sort, query).fetch();
}
}