Spring Data JPA實現動態查詢的兩種方法

前言

一般在寫業務接口的過程中，很有可能需要實現可以動態組合各種查詢條件的接口。如果我們根據一種查詢條件組合一個方法的做法來寫，那麼將會有大量方法存在，繁瑣，維護起來相當困難。想要實現動態查詢，其實就是要實現拼接SQL語句。無論實現如何復雜，基本都是包括select的字段，from或者join的表，where或者having的條件。在Spring Data JPA有兩種方法可以實現查詢條件的動態查詢，兩種方法都用到了Criteria API。

Criteria API

這套API可用於構建對數據庫的查詢。

類型安全。通過定義元數據模型，在程序編譯階段就可以對類型進行檢查，不像SQL需要與Mysql進行交互後才能發現類型問題。

如下即為元數據模型。創建一個元模型類，類名最後一個字符為下劃線，內部的成員變量與UserInfo.class這個實體類的屬性值相對應。

@StaticMetamodel(UserInfo.class)
public class UserInfo_ {
  public static volatile SingularAttribute<UserInfo, Integer> userId;
  public static volatile SingularAttribute<UserInfo, String> name;
  public static volatile SingularAttribute<UserInfo, Integer> age;
  public static volatile SingularAttribute<UserInfo, Long> high;
}

可移植。API並不依賴具體的數據庫，可以根據數據庫類型的不同生成對應數據庫類型的SQL，所以其為可移植的。

面向對象。Criteria API是使用的是各種類和對象如CriteriaQuery、Predicate等構建查詢，是面向對象的。而如果直接書寫SQL則相對於面向的是字符串。

第一種:通過JPA的Criteria API實現

EntityManager獲取CriteriaBuilder CriteriaBuilder創建CriteriaQuery CriteriaQuery指定要查詢的表，得到Root<UserInfo>，Root代表要查詢的表 CriteriaBuilder創建條件Predicate，Predicate相對於SQL的where條件，多個Predicate可以進行與、或操作。 通過EntityManager創建TypedQuery TypedQuery執行查詢，返回結果

public class UserInfoExtendDao {

 @PersistenceContext(unitName = "springJpa")
 EntityManager em;

 public List<UserInfo> getUserInfo(String name,int age,int high) {
   CriteriaBuilder cb = em.getCriteriaBuilder();
   CriteriaQuery<UserInfo> query = cb.createQuery(UserInfo.class);

   //from
   Root<UserInfo> root = query.from(UserInfo.class);

   //where
   Predicate p1 = null;
   if(name!=null) {
     Predicate p2 = cb.equal(root.get(UserInfo_.name),name);
     if(p1 != null) {
       p1 = cb.and(p1,p2);
     } else {
       p1 = p2;
     }
   }

   if(age!=0) {
     Predicate p2 = cb.equal(root.get(UserInfo_.age), age);
     if(p1 != null) {
       p1 = cb.and(p1,p2);
     } else {
       p1 = p2;
     }
   }

   if(high!=0) {
     Predicate p2 = cb.equal(root.get(UserInfo_.high), high);
     if(p1 != null) {
       p1 = cb.and(p1,p2);
     } else {
       p1 = p2;
     }
   }
   query.where(p1);

   List<UserInfo> userInfos = em.createQuery(query).getResultList();
   return userInfos;
 }
}

第二種:DAO層接口實現JpaSpecificationExecutor<T>接口

JpaSpecificationExecutor如下，方法參數Specification接口有一個方法toPredicate，返回值正好是Criteria API中的Predicate，而Predicate相對於SQL的where條件。與上一個方法相比，這種寫法不需要指定查詢的表是哪一張，也不需要自己通過Criteria API實現排序和分頁，只需要通過新建Pageable、Sort對象並傳參給findAll方法即可，簡便一些。

public interface JpaSpecificationExecutor<T> {
 T findOne(Specification<T> spec);
 List<T> findAll(Specification<T> spec);
 Page<T> findAll(Specification<T> spec, Pageable pageable);
 List<T> findAll(Specification<T> spec, Sort sort);
 long count(Specification<T> spec);
}

UserInfoDao實現JpaSpecificationExecutor

public interface UserInfoDao 
  extends PagingAndSortingRepository<UserInfo, String>, JpaSpecificationExecutor<UserInfo> {}

實現Specification

public static Specification<UserInfo> getSpec(final String name,final int age,final int high) {
   return new Specification<UserInfo>() {
     @Override
     public Predicate toPredicate(Root<UserInfo> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
       Predicate p1 = null;
       if(name!=null) {
         Predicate p2 = cb.equal(root.get(UserInfo_.name),name);
         if(p1 != null) {
           p1 = cb.and(p1,p2);
         } else {
           p1 = p2;
         }
       }

       if(age!=0) {
         Predicate p2 = cb.equal(root.get(UserInfo_.age), age);
         if(p1 != null) {
           p1 = cb.and(p1,p2);
         } else {
           p1 = p2;
         }
       }

       if(high!=0) {
         Predicate p2 = cb.equal(root.get(UserInfo_.high), high);
         if(p1 != null) {
           p1 = cb.and(p1,p2);
         } else {
           p1 = p2;
         }
       }

       return p1;
     }
   };
 }

項目代碼：springdatajpademo_jb51.rar

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持。