3 初識綜合查詢【后】 · SpringBoot+Angular入門實例教程

當需要綜合查詢功能時，我們需要在倉庫中繼承JpaSpecificationExecutor接口。`specification`譯為規范、說明書，`Executor`可譯為執行者，所以`JpaSpecificationExecutor`可以譯為Jpa規范的執行者，在此起到的是按JPA規范進行查詢的作用。 repository/StudentRepository.java ``` package com.mengyunzhi.springBootStudy.repository; import com.mengyunzhi.springBootStudy.entity.Student; import org.springframework.data.jpa.repository.JpaSpecificationExecutor; ★ import org.springframework.data.repository.PagingAndSortingRepository; /** * 學生 */ public interface StudentRepository extends PagingAndSortingRepository<Student, Long> , JpaSpecificationExecutor★ { } ``` > 與PagingAndSortingRepository不同，JpaSpecificationExecutor是個相對獨立的接口，其并沒有繼承CrudRepository，所以如果只繼承該接口將缺失基本的CRUD功能。 ![](https://img.kancloud.cn/ac/da/acda1dca2050077b5fb77cfa43593666_1008x456.png) 聲明繼承關系后，我們便可以使用如下方法進行綜合查詢了： ``` public interface JpaSpecificationExecutor<T①> { Optional<T> findOne(@Nullable Specification<T> var1); ? List<T> findAll(@Nullable Specification<T> var1);? Page<T> findAll(@Nullable Specification<T> var1, Pageable var2); ? List<T> findAll(@Nullable Specification<T> var1, Sort var2); ? long count(@Nullable Specification<T> var1); ? } ``` * ① 規定查詢的實體 * ? 根據綜合查詢條件（查詢規范）獲取某一個實體 * ? 根據綜合查詢條件（查詢規范）獲取全部符合條件的實體 * ? 根據綜合查詢條件（查詢規范）及分頁條件，獲取當前頁實體及分頁信息 * ? 根據綜合查詢條件（查詢規范）及排序條件，獲取全部符合條件的實體 * ? 根據綜合查詢條件（查詢規范）獲取符合條件的實體條數 spring官方提供了三種綜合查詢的方法。第一種方法使用簡單，死板，適應能力差；第二、三種方法使相對復雜，但有更高的靈活性，適應能力強。 # 方法一：直接命名 JPA[官方文檔](https://docs.spring.io/spring-data/jpa/docs/2.2.2.RELEASE/reference/html/#jpa.query-methods.query-creation)提供了一系列可以直接在StudentRepository中命名的方法，在前面的章節中我們使用了` List<Klass> findAllByNameContains(String name);` 完成了根據name查詢班級信息。對于本例中的需求，我們可以在倉庫中建立以下名稱的方法： repository/StudentRepository.java ``` public interface StudentRepository extends PagingAndSortingRepository<Student, Long>, JpaSpecificationExecutor { Page<Student> findAllByNameContains?AndSnoStartsWith?AndKlass?(String name①, String sno②, Klass klass③, Pageable pageable); } ``` * ? contains = 包含 * ? StartsWith = 開始于 * ①②③ 分別對應前面???的查詢要素 ## 測試找到對應的測試文件：repository/StudentRepositoryTest.java，初始化如下： ``` @Test public void findAllByNameContainsAndSnoStartsWithAndKlass() { /* 初始化2個班級并持久化*/ Klass klass = new Klass(); klass.setName("testKlass"); this.klassRepository.save(klass); Klass klass1 = new Klass(); klass1.setName("testKlass1"); this.klassRepository.save(klass1); Student student = new Student(); student.setName("testStudentName"); student.setSno("032282"); student.setKlass(klass); this.studentRepository.save(student); /* 初始化2個不同班級的學生并持久化 */ Student student1 = new Student(); student1.setName("testStudentName1"); student1.setSno("032291"); student1.setKlass(klass1); this.studentRepository.save(student1); } ``` 繼續添加綜合查詢的斷言 -- 加入三個查詢條件，查詢斷言查詢到了相關的數據： ``` @Test public void findAllByNameContainsAndSnoStartsWithAndKlass() { ... this.studentRepository.save(student1); Page<Student> studentPage = this.studentRepository.findAllByNameContainsAndSnoStartsWithAndKlass( "testStudentName", "032282", klass, PageRequest.of(0, 2)); Assertions.assertThat(studentPage.getTotalElements()).isEqualTo(1); } ``` ### name字段測試斷言：修改name參數的值，斷言模糊查詢生效： ``` @Test public void findAllByNameContainsAndSnoStartsWithAndKlass() { ... studentPage = this.studentRepository.findAllByNameContainsAndSnoStartsWithAndKlass( "testStude", ① "032282", klass, PageRequest.of(0, 2)); Assertions.assertThat(studentPage.getTotalElements()).isEqualTo(1); studentPage = this.studentRepository.findAllByNameContainsAndSnoStartsWithAndKlass( "tStudentN", ② "032282", klass, PageRequest.of(0, 2)); Assertions.assertThat(studentPage.getTotalElements()).isEqualTo(1); studentPage = this.studentRepository.findAllByNameContainsAndSnoStartsWithAndKlass( "tudentName", ③ "032282", klass, PageRequest.of(0, 2)); Assertions.assertThat(studentPage.getTotalElements()).isEqualTo(1); studentPage = this.studentRepository.findAllByNameContainsAndSnoStartsWithAndKlass( "testStudentName123", ④ "032282", klass, PageRequest.of(0, 2)); Assertions.assertThat(studentPage.getTotalElements()).isEqualTo(0④); } ``` * ① 截取前面部分字符 * ② 截取中間部分字符 * ③ 截取后臺部分字符 * ④ 不在查詢范圍內（保證對name的查詢是生效的) ### sno字段測試 ``` @Test public void findAllByNameContainsAndSnoStartsWithAndKlass() { ... studentPage = this.studentRepository.findAllByNameContainsAndSnoStartsWithAndKlass( "testStudentName", "03228",① klass, PageRequest.of(0, 2)); Assertions.assertThat(studentPage.getTotalElements()).isEqualTo(1); studentPage = this.studentRepository.findAllByNameContainsAndSnoStartsWithAndKlass( "testStudentName", "3228",② klass, PageRequest.of(0, 2)); Assertions.assertThat(studentPage.getTotalElements()).isEqualTo(0); studentPage = this.studentRepository.findAllByNameContainsAndSnoStartsWithAndKlass( "testStudentName", "32282", ③ klass, PageRequest.of(0, 2)); Assertions.assertThat(studentPage.getTotalElements()).isEqualTo(0); } ``` * ① 截取前面部分關鍵字，生效 * ② 截取中間部分關鍵字，失效 * ③ 截取后面部分關鍵字，失效 ### 查詢班級字段 ``` @Test public void findAllByNameContainsAndSnoStartsWithAndKlass() { ... studentPage = this.studentRepository.findAllByNameContainsAndSnoStartsWithAndKlass( "testStudentName", "032282", klass1, ① PageRequest.of(0, 2)); Assertions.assertThat(studentPage.getTotalElements()).isEqualTo(0); } ``` * ① 換為klass1，失效 ## 弊端但該使用方法有一個非常大的弊端：那就是參數不能為null，比如我們如下使用： ``` @Test public void findAllByNameContainsAndSnoStartsWithAndKlass() { ... studentPage = this.studentRepository.findAllByNameContainsAndSnoStartsWithAndKlass( null★, "032282", klass1, PageRequest.of(0, 2)); } ``` 更會得到以下異常： ``` org.springframework.dao.InvalidDataAccessApiUsageException: Value must not be null!; nested exception is java.lang.IllegalArgumentException: Value must not be null! ``` 所以此方法被我們廣泛的應用一些業務的邏輯處理中，而在綜合查詢中基本上所有的查詢條件都**不**能是必須填寫的，也就是說所有的查詢條件都可能為null，此時使用null值進行查詢時，此方法便會發生錯誤。也就是說本查詢方法并不適用于當前的需求。在實際的生產環境中，此方法更多的被用于具有確認性的內部邏輯處理中。 **為與教程代碼保持一致，請刪除本方法涉及的功能及測試代碼后繼續學習** # 方法二：調用List<T> findAll(@Nullable Specification<T> var1) 我們當前的綜合查詢只需要調用findAll方法即可。比如在沒有分頁的情況下，我們調用`List<T> findAll(@Nullable Specification<T> var1)`。該方法中的參數var1的類型Specification是一個接口，其中T與其所在接口`JpaSpecificationExecutor<T>`的T相對應，表示一種約束。可以理解為：如果JpaSpecificationExecutor聲明對某個表`T`進行操作，那么此規范也是必須是對某表`T`的規范。該接口聲明了一個方法： ``` public interface Specification { Predicate toPredicate(Root root, CriteriaQuery query, CriteriaBuilder builder); } ``` 如果想成功的調用findAll的方法，那么就必須創建一個實現了Specification接口的對象。創建該對象的方式有兩種：1先創建一個實現了該接口的實現類，然后通過實例化該實現類的方法來得到對象；2 直接創建一個實現了該接口的對象。在此，我們直接使用第2種方法。 ## Specification 在使用JpaSpecificationExecutor進行綜合查詢以前，我們先使用單元測試的方法來了解下這個接口。打開test測試包下的repository/StudentRepositoryTest.java，然后新建specificationTest方法，并添加些測試代碼\方法以進行一些初始化操作： ``` import javax.persistence.criteria.*; import java.util.List; ... private static final Logger logger = LoggerFactory.getLogger(StudentRepositoryTest.class); ... @Test public void specificationTest() { /* 初始化2個班級并持久化*/ Klass klass = new Klass(); klass.setName("testKlass"); this.klassRepository.save(klass); Klass klass1 = new Klass(); klass1.setName("testKlass1"); this.klassRepository.save(klass1); Student student = new Student(); student.setName("testStudentName"); student.setSno("032282"); student.setKlass(klass); this.studentRepository.save(student); /* 初始化2個不同班級的學生并持久化 */ Student student1 = new Student(); student1.setName("testStudentName1"); student1.setSno("032291"); student1.setKlass(klass1); this.studentRepository.save(student1); /* 斷言存入了2個學生 */ List<Student> studentList = (List<Student>) this.studentRepository.findAll(); logger.info("當前數據庫總計有{}個學生", studentList.size()); Assertions.assertThat(studentList.size()).isEqualTo(2); } ``` * 詳見代碼注釋 ### 精確查詢假設我們想以班級一為查詢條件進行查詢，則需要實現Specification接口規范的對象如下： ``` ... logger.info("當前數據庫總計有{}個學生", studentList.size()); Assertions.assertThat(studentList.size()).isEqualTo(2); /* 初始化查詢條件對象 */ Specification<Student?> klassSpecification = new Specification<Student?>() { /** * 本條件查詢：班級為klassEven的學生 * @param root 根(Student)實體 * @param criteriaQuery 條件查詢 * @param criteriaBuilder 條件創建者 * @return 查詢謂語 */ @Override public Predicate toPredicate(Root<Student?> root, CriteriaQuery<??> criteriaQuery, CriteriaBuilder criteriaBuilder) { return criteriaBuilder.equal?(root.get("klass")?, klass?); } }; /* 加入班級條件后查詢，斷言查詢的數量為1 */ studentList = (List<Student>) this.studentRepository.findAll(klassSpecification);? logger.info("使用班級為條件進行查詢，查詢到{}個學生", studentList.size()); Assertions.assertThat(studentList.size()).isEqualTo(1); } ``` * ? 對類型進行約束，大瓶子外面貼了什么標簽，大瓶子中的小瓶子就必須也貼這個標簽。 * ? `<? extends Object>`的縮寫，表示容器中存的是任意類型的對象，**同時**該容器為只讀容器，無法向該容器中添加新對象。 * ? 當?和?相`等于`時，滿足查詢條件。 * ? root在這代表student實體，root.get("klass")代表student實體上的klass屬性 * ? 前面初始化的第一個班級 * ? 將`查詢規范`做為條件傳入findAll方法，即展開條件查詢測試結果符合預期 ``` 2019-11-27 14:56:33.662 INFO 51770 --- [ main] c.m.s.repository.StudentRepositoryTest : 當前數據庫總計有2個學生 2019-11-27 14:56:33.740 INFO 51770 --- [ main] c.m.s.repository.StudentRepositoryTest : 使用班級為條件進行查詢，查詢到1個學生 ``` ### like%查詢綜合查詢的接口說明了學號需要以0322打頭，斷言查詢到2條數據。 ``` Assertions.assertThat(studentList.size()).isEqualTo(1); /* 學號0322做為查詢條件 */ Specification<Student> snoSpecification = new Specification<Student>() { @Override public Predicate toPredicate(Root<Student> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) { return criteriaBuilder.like(root.get("sno").as(String.class)?, "0322%?"); } }; /* 斷言兩個學生都是以此學號打頭的 */ studentList = (List<Student>) this.studentRepository.findAll(snoSpecification); logger.info("使用學號0322條件進行查詢，查詢到{}個學生", studentList.size()); Assertions.assertThat(studentList.size()).isEqualTo(2); } ``` * ? 用as來指定該定段的類型（更嚴格），減少在運行中可能出現的異常 * ? 將`%`放后面，表示查詢的結果必須以0322打頭以322打頭，斷言查詢到0條數據，以03228打頭，斷言查詢到1條數據： ``` Assertions.assertThat(studentList.size()).isEqualTo(2); /* 學號以322打頭 */ snoSpecification = new Specification<Student>() { @Override public Predicate toPredicate(Root<Student> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) { return criteriaBuilder.like(root.get("sno").as(String.class), "322%"); } }; /* 斷言查詢到0個學生 */ studentList = (List<Student>) this.studentRepository.findAll(snoSpecification); logger.info("使用學號322為條件進行查詢，查詢到{}個學生", studentList.size()); Assertions.assertThat(studentList.size()).isEqualTo(0); /* 學號03228打頭，斷言獲取了一個學生 */ snoSpecification = new Specification<Student>() { @Override public Predicate toPredicate(Root<Student> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) { Root<Student> studentRoot = criteriaQuery.from(Student.class); return criteriaBuilder.like(root.get("sno").as(String.class), "03228%"); } }; studentList = (List<Student>) this.studentRepository.findAll(snoSpecification); logger.info("使用學號03228為條件進行查詢，查詢到{}個學生", studentList.size()); Assertions.assertThat(studentList.size()).isEqualTo(1); ``` 測試結果： ``` 2019-11-27 15:34:39.725 INFO 83358 --- [ main] c.m.s.repository.StudentRepositoryTest : 當前數據庫總計有2個學生 2019-11-27 15:34:39.805 INFO 83358 --- [ main] c.m.s.repository.StudentRepositoryTest : 使用班級為條件進行查詢，查詢到1個學生 2019-11-27 15:34:39.824 INFO 83358 --- [ main] c.m.s.repository.StudentRepositoryTest : 使用學號0322條件進行查詢，查詢到2個學生 2019-11-27 15:34:39.835 INFO 83358 --- [ main] c.m.s.repository.StudentRepositoryTest : 使用學號322為條件進行查詢，查詢到0個學生 2019-11-27 15:34:39.848 INFO 83358 --- [ main] c.m.s.repository.StudentRepositoryTest : 使用學號03228為條件進行查詢，查詢到1個學生 ``` ### %like%查詢有了剛剛的基礎，%like%查詢便很簡單了。 ``` logger.info("使用學號03228為條件進行查詢，查詢到{}個學生", studentList.size()); Assertions.assertThat(studentList.size()).isEqualTo(1); /* 姓名包含StudentN，斷言獲取了兩個學生 */ Specification<Student> nameSpecification = new Specification<Student>() { @Override public Predicate toPredicate(Root<Student> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) { return criteriaBuilder.like(root.get("name").as(String.class), "%StudentN%"); } }; studentList = (List<Student>) this.studentRepository.findAll(nameSpecification); logger.info("姓名包含StudentN進行查詢，查詢到{}個學生", studentList.size()); Assertions.assertThat(studentList.size()).isEqualTo(2); /* 姓名包含Name1，斷言獲取了1個學生 */ nameSpecification = new Specification<Student>() { @Override public Predicate toPredicate(Root<Student> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) { return criteriaBuilder.like(root.get("name").as(String.class), "%Name1%"); } }; studentList = (List<Student>) this.studentRepository.findAll(nameSpecification); logger.info("姓名包含Name1進行查詢，查詢到{}個學生", studentList.size()); Assertions.assertThat(studentList.size()).isEqualTo(1); } ``` 測試結果： ``` 2019-11-27 16:15:23.157 INFO 17360 --- [ main] c.m.s.repository.StudentRepositoryTest : 當前數據庫總計有2個學生 2019-11-27 16:15:23.237 INFO 17360 --- [ main] c.m.s.repository.StudentRepositoryTest : 使用班級為條件進行查詢，查詢到1個學生 2019-11-27 16:15:23.257 INFO 17360 --- [ main] c.m.s.repository.StudentRepositoryTest : 使用學號0322條件進行查詢，查詢到2個學生 2019-11-27 16:15:23.268 INFO 17360 --- [ main] c.m.s.repository.StudentRepositoryTest : 使用學號322為條件進行查詢，查詢到0個學生 2019-11-27 16:15:23.281 INFO 17360 --- [ main] c.m.s.repository.StudentRepositoryTest : 使用學號03228為條件進行查詢，查詢到1個學生 2019-11-27 16:15:23.304 INFO 17360 --- [ main] c.m.s.repository.StudentRepositoryTest : 姓名包含StudentN進行查詢，查詢到2個學生 2019-11-27 16:15:23.321 INFO 17360 --- [ main] c.m.s.repository.StudentRepositoryTest : 姓名包含Name1進行查詢，查詢到1個學生 ``` 至此，我們了解了spring data jpa的綜合查詢方法中的equeal查詢及like查詢，更多綜合查詢的方法我們可以參考Hibernate（Spring Data JPA內置了Hibernate）的官方文檔。 # 全局測試最后我們對整體的項目進行單元測試，以避免本小節中的代碼對其已有功能造成影響。 ![](https://img.kancloud.cn/48/77/4877f4e5ef7a5cadfa9a68ca21125e1d_738x284.png) 這是由于在進行整個項目的單元測試時，單元測試間互相進行了影響。其根本原因在于我們的錯誤假設：我們假設在對某個方法進行單元測試時，數據庫中是沒有數據的。如果不存在其它的單元測試或是不對整個項目進行整體測試，這個理論是正確的。但一旦cf 整個項目進行單元測試，那么就有可能出現：A測試在測試中生成了一些冗余數據，而這些數據對B測試造成了影響。比如上圖，我們期望得到2條數據，最終卻得到了5條。就是由于其它的單元測試進行測試時，生成3條。為了避免單元測試的互相影響，有兩種解決方案：1是在每次測試后，手機的回滾數據；2是在每個單元測試中均假設此單元測試是在一個**非**空數據庫下進行的。在實際的使用中，我們發現第2種解決方案更簡單一些，在此我們也采用第二種，對報錯的方法修正如下： repository/StudentRepository.java ``` @Test public void specificationTest() { List<Student> oldStudentList = (List<Student>) this.studentRepository.findAll(); ① ... logger.info("當前數據庫總計有{}個學生", studentList.size()); Assertions.assertThat(studentList.size()).isEqualTo(2 + oldStudentList.size()); ② ``` * ① 獲取當前數據庫中的歷史記錄 * ② 斷言新增了2條，而非共2條除此以外，我們在單元測試中使用了靜態的“用戶名”、“姓名”也是不對的，這極可能給以后的測試埋下地雷。在它暫不做修正，如果后續踩雷的話，我們再回頭看。 # <? extends Obejct> 在上述查詢中，我們并沒有使用到`CriteriaQuery<?> criteriaQuery`，在生產項目中我們也很少使用該參數，對于其具體的功能筆者不了解所以也無法講述，但`<?>`這種用法是第一次出現，在這簡單用實例進行說明： `<?>`是`<? extends Object>`的簡寫形式，表示：該容器中的對象繼承(或實現)了`Object`，所以只要`Object`中聲明的方法，我們都可以在此對象上調用。但是：由于編譯器無法確定該容器中所包含對象的具體類型，因而我們無法向該容器中寫入新的對象，所以該容器只能是只讀的。比如有如下代碼： ``` private void test() { List<Object> lists = new ArrayList<>(); ① lists.add("test"); ① lists.add(123); ① lists.add(true); ① List<? extends Object?> lists1 = Arrays.asList(123, 456); ? Object index0 = lists1.get(0); ? lists1.add(new Object()); ? lists1.add("test"); ? lists1.add(123); ? lists1.add(true); ? } ``` * ① 編譯通過，正常執行 * ? 中`123`，`456`的類型均繼承了?規定的Object，編譯通過 * ? lists1中元素可讀，編譯通過，獲取的類型為Object。 * ? lists1不可寫入新元素，編譯**失敗** JAVA為什么要這樣做呢？可以在《Head First Java》的570頁附近找到答案，比如Cat和Dog類都實現了Animal接口，如果允許修改容器中的值，那么以下代碼在編譯過程中是可以通過的。 ``` public void go() { ① LIst<Dog> dogs = Arrays.asList(new Dog(1), new Dog(2)); takeAnimals(dogs); Dog dog = dogs.get(0); ? } public void takeAnimals(List<? extends Animals> animals) { ② animals.set(0, new Cat(1)); ? } ``` 觀察得知方法①②（假設animals可寫）的代碼都是沒有問題的。但在運行時，由于?將第0個元素修改為了Cat，所以在?中想獲取Dog時便會發生錯誤。 # 參考文檔 | 名稱 | 鏈接 | 預計學習時長(分） | | --- | --- | --- | | spring jpa query creation| [https://docs.spring.io/spring-data/jpa/docs/2.2.2.RELEASE/reference/html/#jpa.query-methods.query-creation](https://docs.spring.io/spring-data/jpa/docs/2.2.2.RELEASE/reference/html/#jpa.query-methods.query-creation) | 10 | | Hibernate userguide | [https://docs.jboss.org/hibernate/orm/current/userguide/html\_single/Hibernate\_User\_Guide.html#criteria-from-root](https://docs.jboss.org/hibernate/orm/current/userguide/html_single/Hibernate_User_Guide.html#criteria-from-root) | - | | spring data jpa | [https://docs.spring.io/spring-data/jpa/docs/2.2.2.RELEASE/reference/html/#specifications](https://docs.spring.io/spring-data/jpa/docs/2.2.2.RELEASE/reference/html/#specifications) | 10 | | 源碼地址 | [https://github.com/mengyunzhi/spring-boot-and-angular-guild/releases/tag/step4.6.3](https://github.com/mengyunzhi/spring-boot-and-angular-guild/releases/tag/step4.6.3) | - |