SpringBoot中使用Spring Data Jpa 實現簡單的動態查詢的兩種方法

時間 2019-11-09

標籤 springboot 使用 spring data jpa 實現簡單動態查詢兩種方法欄目 Spring 简体版

原文原文鏈接

　　軟件152 尹以操html

首先謝謝大佬的簡書文章：http://www.jianshu.com/p/45ad65690e33#java

這篇文章中講的是spring中使用spring data jpa，使用了xml配置文件。我如今使用的是spring boot ，沒有了xml文件配置就方便多了。我一樣嘗試了兩種方式，也都是簡單的查詢，須要更復雜的查詢，還須要我研究研究。往下看，須要先配置springboot的開發環境，須要大體瞭解springboot,這裏能夠看下面兩篇文章：spring

springboot 項目新建sql

springboot使用小記數據庫

建立實體類：安全

package com.entity;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Table;

/**
 *create by yyc 2017年6月11日上午9:59:59
 */
@Entity
@Table(name="test_user")
public class TestUser {

    @Id
    @GeneratedValue
    private int userId;
    private Integer userAge;
    private String  userName;
    private Integer high;//高
    //省略getter、setter
    
}

爲了測試，先建立一個簡單的實體類。springboot

寫元數據模型：dom

Criteria APIide

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

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

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

package com.entity;

import javax.persistence.metamodel.SingularAttribute;
import javax.persistence.metamodel.StaticMetamodel;
import com.TestUser;
@StaticMetamodel(TestUser.class)
public class TestUser_ {

     public static volatile SingularAttribute<TestUser, Integer> userId;// 用戶ID，自增量
     public static volatile SingularAttribute<TestUser, Integer> userAge;
     public static volatile SingularAttribute<TestUser, String> userName;
     public static volatile SingularAttribute<TestUser, Integer> high;

    }

可移植。API並不依賴具體的數據庫，能夠根據數據庫類型的不一樣生成對應數據庫類型的SQL，因此其爲可移植的。
面向對象。Criteria API是使用的是各類類和對象如CriteriaQuery、Predicate等構建查詢，是面向對象的。而若是直接書寫SQL則相對於面向的是字符串。

如今開始SpringBoot中使用Spring Data Jpa 實現簡單的動態查詢的兩種方式方法

第一種方式：經過JPA的Criteria API實現

EntityManager獲取CriteriaBuilder
CriteriaBuilder建立CriteriaQuery
CriteriaQuery指定要查詢的表，獲得Root<UserInfo>，Root表明要查詢的表
CriteriaBuilder建立條件Predicate，Predicate相對於SQL的where條件，多個Predicate能夠進行與、或操做。
經過EntityManager建立TypedQuery
TypedQuery執行查詢，返回結果

package com.repository;

import java.util.List;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.criteria.Predicate;
import javax.persistence.criteria.Root;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Repository;
import com.entity.TestUser;
import com.entity.TestUser_;

/**
 *create by yyc 2017年6月11日下午9:08:39
 */
@Repository
public class TestUserExtendDao {

//    @Autowired
    @PersistenceContext//@Autowired和@PersistenceContext註解任取一
    EntityManager em;
    
    @SuppressWarnings("unused")
    public List<TestUser> getTestUserInfo(final Integer age, final String name, final Integer high){
         //1
        CriteriaBuilder cb = em.getCriteriaBuilder();
         //2
        CriteriaQuery<TestUser> query = cb.createQuery(TestUser.class);
        
        //3
        //from 
        Root<TestUser> root = query.from(TestUser.class);
        
         //4
         //where
        Predicate p1 = null;
        if (age != 0) {
            System.out.println("正在操做age！！！");
            Predicate p2 = cb.equal(root.get(TestUser_.userAge), age);
            if (p1 != null) {
                p1=cb.and(p1, p2);
            } else {
                p1 = p2;
            }
        }
        if (false==name.isEmpty()) {
            System.out.println("正在操做name！！！");
            Predicate p2 = cb.equal(root.get(TestUser_.userName), name);
            if (p1 != null) {
                p1=cb.and(p1, p2);
            } else {
                p1 = p2;
            }
        }
        if (high != 0) {
            System.out.println("正在操做high！！！");
            Predicate p2 = cb.equal(root.get(TestUser_.high), high);
            if (p1 != null) {
                p1=cb.and(p1, p2);
            } else {
                p1 = p2;
            }
        }
        //5
        query.where(p1);
        //6
        List<TestUser> testUsers = em.createQuery(query).getResultList();
        return testUsers;
    }
}

第二種方式：DAO層接口實現JpaSpecificationExecutor<T>接口

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

這是JpaSpecificationExecutor接口中的方法：

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);
}

TestRepository繼承JpaSpecificationExecutor接口：

package com.repository;

import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
import org.springframework.data.repository.PagingAndSortingRepository;
import com.entity.TestUser;

/**
 *create by yyc 2017年6月11日上午9:36:27
 *測試動態sql
 */
public interface TestRepository extends PagingAndSortingRepository<TestUser, Integer>, JpaSpecificationExecutor<TestUser>{

}

實現Specification：

package com.entity;

import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.criteria.Predicate;
import javax.persistence.criteria.Root;
import org.springframework.data.jpa.domain.Specification;
import com.entity.TestUser;

/**
 * create by yyc 2017年6月11日上午10:17:44
 */
public class TestUserDaoSpec {
    public static Specification<TestUser> getSpec(final Integer age, final String name, final Integer high) {
        return new Specification<TestUser>() {

            @SuppressWarnings("unused")
            @Override
            public Predicate toPredicate(Root<TestUser> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
                Predicate p1 = null;
                if (age != 0) {
                    System.out.println("正在操做age！！！");
                    Predicate p2 = cb.equal(root.get(TestUser_.userAge), age);
                    if (p1 != null) {
                        p1=cb.and(p1, p2);
                    } else {
                        p1 = p2;
                    }
                }
                if (false==name.isEmpty()) {
                    System.out.println("正在操做name！！！");
                    Predicate p2 = cb.equal(root.get(TestUser_.userName), name);
                    if (p1 != null) {
                        p1=cb.and(p1, p2);
                    } else {
                        p1 = p2;
                    }
                }
                if (high != 0) {
                    System.out.println("正在操做high！！！");
                    Predicate p2 = cb.equal(root.get(TestUser_.high), high);
                    if (p1 != null) {
                        p1=cb.and(p1, p2);
                    } else {
                        p1 = p2;
                    }
                }
                return p1;
            }
        };
    }

}

Service層的調用測試類：

package com.service.impl;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.entity.TestUser;
import com.entity.TestUserDaoSpec;
import com.repository.TestRepository;
import com.repository.TestUserExtendDao;
import com.result.Result;//一個方法返回的封裝，這裏直接忽略便可


/**
 *create by yyc 2017年6月11日上午9:40:51
 */
@Service("testService")
public class TestService {

    @Autowired
    private TestRepository testRepository;
    
    @Autowired
    private TestUserExtendDao testUserExtendDao;
    
    //測試第一種方式
    public Result getTestUsersByExtendDao(){
        List<TestUser> list = testUserExtendDao.getTestUserInfo(20, "", 170);//經過兩個條件，string設爲空
        printTestUserInfo(list);
        return new Result("查詢成功！", list);
    }
    
    //測試第二種方式
    public Result getTestUsersByThreeParameter(){
        List<TestUser> list = testRepository.findAll(TestUserDaoSpec.getSpec(20, "yyc", 170));//經過三個條件
        printTestUserInfo(list);
        return new Result("查詢成功！",list);
    }
    public Result getTestUsersByTwoParameter1(){
        List<TestUser> list = testRepository.findAll(TestUserDaoSpec.getSpec(20, "yyc", 0));//經過兩個條件，Integer設爲0
        printTestUserInfo(list);
        return new Result("查詢成功！",list);
    }

    public Result getTestUsersByOneParameter(){
        List<TestUser> list = testRepository.findAll(TestUserDaoSpec.getSpec(0, "lrs", 0));//經過一個條件查詢
        printTestUserInfo(list);
        return new Result("查詢成功！",list);
    }

    private void printTestUserInfo(List<TestUser> list) {
        if (list!=null) {
            for (TestUser testUser : list) {
                System.out.println("userId："+testUser.getUserId()+
                        " userName:"+testUser.getUserName()+
                        " userAge:"+testUser.getUserAge()+
                        " userHigh:"+testUser.getHigh());
            }
        }
        
    }
}