Spring Data JPA,一種動態(tài)條件查詢的寫法
我們在使用SpringData JPA框架時,進行條件查詢,如果是固定條件的查詢,我們可以使用符合框架規(guī)則的自定義方法以及@Query注解實現(xiàn)。
如果是查詢條件是動態(tài)的,框架也提供了查詢接口。
JpaSpecificationExecutor
和其他接口使用方式一樣,只需要在你的Dao接口繼承即可(官網(wǎng)代碼)。
public interface CustomerRepository extends CrudRepository<Customer, Long>, JpaSpecificationExecutor {
…
}
JpaSpecificationExecutor提供很多條件查詢方法。
public interface JpaSpecificationExecutor<T> {
T findOne(Specification<T> var1);
List<T> findAll(Specification<T> var1);
Page<T> findAll(Specification<T> var1, Pageable var2);
List<T> findAll(Specification<T> var1, Sort var2);
long count(Specification<T> var1);
}
比如方法:
List<T> findAll(Specification<T> var1);
就可以查找出符合條件的所有數(shù)據(jù),如果你的框架使用的是前段分頁的技術(shù),那么這個方法就挺簡便的。
那么這個方法該如何使用呢?我們看到它需要的參數(shù)是一個
org.springframework.data.jpa.domain.Specification
對象。那我們就創(chuàng)建這個對象先看看。
Specification specification = new Specification() {
@Override
public Predicate toPredicate(Root root, CriteriaQuery criteriaQuery, CriteriaBuilder criteriaBuilder) {
return null;
}
}
IDE自動生成了要重寫的方法toPredicate。
root參數(shù)是我們用來對應(yīng)實體的信息的。criteriaBuilder可以幫助我們制作查詢信息。
/**
* A root type in the from clause.
* Query roots always reference entities.
*
* @param <X> the entity type referenced by the root
* @since Java Persistence 2.0
*/
public interface Root<X> extends From<X, X> {...}
/**
* Used to construct criteria queries, compound selections,
* expressions, predicates, orderings.
*
* <p> Note that <code>Predicate</code> is used instead of <code>Expression<Boolean></code>
* in this API in order to work around the fact that Java
* generics are not compatible with varags.
*
* @since Java Persistence 2.0
*/
public interface CriteriaBuilder {...}
CriteriaBuilder對象里有很多條件方法,比如制定條件:某條數(shù)據(jù)的創(chuàng)建日期小于今天。
criteriaBuilder.lessThan(root.get("createDate"), today)
該方法返回的對象類型是Predicate。正是toPredicate需要返回的值。
如果有多個條件,我們就可以創(chuàng)建一個Predicate集合,最后用CriteriaBuilder的and和or方法進行組合,得到最后的Predicate對象。
/**
* Create a conjunction of the given restriction predicates.
* A conjunction of zero predicates is true.
*
* @param restrictions zero or more restriction predicates
*
* @return and predicate
*/
Predicate and(Predicate... restrictions);
/**
* Create a disjunction of the given restriction predicates.
* A disjunction of zero predicates is false.
*
* @param restrictions zero or more restriction predicates
*
* @return or predicate
*/
Predicate or(Predicate... restrictions);
示例:
public List<WeChatGzUserInfoEntity> findByCondition(Date minDate, Date maxDate, String nickname){
List<WeChatGzUserInfoEntity> resultList = null;
Specification querySpecifi = new Specfication<WeChatGzUserInfoEntity>() {
@Override
public Predicate toPredicate(Root<WeChatGzUserInfoEntity> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
List<Predicate> predicates = new ArrayList<>();
if(null != minDate){
predicates.add(criteriaBuilder.greaterThan(root.get("subscribeTime"), minDate));
}
if(null != maxDate){
predicates.add(criteriaBuilder.lessThan(root.get("subscribeTime"), maxDate));
}
if(null != nickname){
predicates.add(criteriaBuilder.like(root.get("nickname"), "%"+nickname+"%"));
}
return criteriaBuilder.and(predicates.toArray(new Predicate[predicates.size()]));
}
};
resultList = this.weChatGzUserInfoRepository.findAll(querySpecifi);
return resultList;
}
and到一起的話所有條件就是且關(guān)系,or就是或關(guān)系了。
其實也是在Stack Overflow上看到的。