Spring data jpa 的使用與詳解（二）：複雜動態查詢及分頁，排序

上一篇介紹了spring data jpa在spring boot中的基本搭建和整合，以及較爲簡單的查詢，這一篇來講spring data jpa中如何實現較爲複雜的查詢及分頁，排序。

1 使用Specification實現複雜查詢

1.1 什麼是Specification

Specification是springDateJpa中的一個接口，他是用於當jpa的一些基本CRUD操做的擴展，能夠把他理解成一個spring jpa的複雜查詢接口。其次咱們須要瞭解Criteria 查詢，這是是一種類型安全和更面向對象的查詢。而Spring Data JPA支持JPA2.0的Criteria查詢，相應的接口是JpaSpecificationExecutor。
而JpaSpecificationExecutor這個接口基本是圍繞着Specification接口來定義的， Specification接口中只定義了以下一個方法：

Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder cb); 
複製代碼

Criteria查詢基本概念
Criteria 查詢是以元模型的概念爲基礎的，元模型是爲具體持久化單元的受管實體定義的，這些實體能夠是實體類，嵌入類或者映射的父類。

CriteriaQuery接口
表明一個specific的頂層查詢對象，它包含着查詢的各個部分，好比：select 、from、where、group by、order by等注意：CriteriaQuery對象只對實體類型或嵌入式類型的Criteria查詢起做用。
Root:
表明Criteria查詢的根對象，Criteria查詢的查詢根定義了實體類型，能爲未來導航得到想要的結果，它與SQL查詢中的FROM子句相似。 Root實例是類型化的，且定義了查詢的FROM子句中可以出現的類型。root表明查詢的實體類,query能夠從中獲得root對象,告訴jpa查詢哪個實體類,還能夠添加查詢條件,還能夠結合EntityManager對象 獲得最終查詢的 TypedQuery對象。 CriteriaBuilder接口
用來構建CritiaQuery的構建器對象Predicate：一個簡單或複雜的謂詞類型，其實就至關於條件或者是條件組合。 可經過 EntityManager.getCriteriaBuilder 而得。

2 使用Specification進行復雜的動態查詢

maven的依賴繼續使用上一章的就能夠，這裏修改一下實體類和controller層。
請求實體類:

@Data
public class AccountRequest {

    //從第幾頁開始
    private Integer page;

    //每一頁查詢多少
    private Integer limit;

    private String id;

    private String name;

    private String pwd;

    private String email;

    private Integer[] types;

}
複製代碼

實體類：

@Data
@Entity
@Table(name = "account")
@ToString
@EntityListeners(AuditingEntityListener.class)
public class Account {

    @Id
    @GenericGenerator(name = "idGenerator", strategy = "uuid")
    @GeneratedValue(generator = "idGenerator")
    private String id;

    @Column(name = "username", unique = true, nullable = false, length = 64)
    private String username;

    @Column(name = "password", nullable = false, length = 64)
    private String password;

    @Column(name = "email", length = 64)
    private String email;

    @Column(name = "type")
    private Short type;

    @CreatedDate
    @Column(name = "create_time", nullable = false)
    private LocalDateTime createTime;

}
複製代碼

Repository層：

public interface AccountRepository extends JpaRepository<Account,String>, JpaSpecificationExecutor<Account> {}
複製代碼

controller層（仍是直接略過service層）

@Autowired
    private AccountRepository repository;


    @PostMapping("/get")
    public List<Account> get(@RequestBody AccountRequest request){
        Specification<Account> specification = new Specification<Account>() {

            @Override
            public Predicate toPredicate(Root<Account> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder builder) {
                //全部的斷言 及條件
                List<Predicate> predicates = new ArrayList<>();
                //精確匹配id pwd
                if (request.getId() != null) {
                    predicates.add(builder.equal(root.get("id"), request.getId()));
                }
                if (request.getPwd() != null) {
                    predicates.add(builder.equal(root.get("password"), request.getPwd()));
                }
                //模糊搜索 name
                if (request.getName() != null && !request.getName().equals("")) {
                    predicates.add(builder.like(root.get("username"), "%" + request.getName() + "%"));
                }
                if (request.getEmail() != null && !request.getEmail().equals("")) {
                    predicates.add(builder.like(root.get("email"), "%" + request.getEmail() + "%"));
                }
                //in範圍查詢
                if (request.getTypes() != null) {
                    CriteriaBuilder.In<Object> types = builder.in(root.get("type"));
                    for (Integer type : request.getTypes()) {
                        types = types.value(type);
                    }
                    predicates.add(types);
                }
                return builder.and(predicates.toArray(new Predicate[predicates.size()]));
            }
        };
        List<Account> accounts = repository.findAll(specification);

        return accounts;
    }
複製代碼

經過重寫Specification的toPredicate的方法，這樣一個複雜的動態sql查詢就完成了，經過post請求直接就能夠調用了。

3 分頁及排序

@PostMapping("/page")
    public List<Account> getPage(@RequestBody AccountRequest request){

        Specification<Account> specification = new Specification<Account>() {
            @Override
            public Predicate toPredicate(Root<Account> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
                List<Predicate> predicates = new ArrayList<>();
                //do anything
                return criteriaBuilder.and(predicates.toArray(new Predicate[predicates.size()]));
            }
        };
        //表示經過createTime進行 ASC排序
        PageRequest page = new PageRequest(request.getPage() - 1, request.getLimit(), Sort.Direction.ASC, "createTime");
        Page<Account> pageInfo = repository.findAll(specification, page);

        return pageInfo.getContent();
    }
複製代碼

上面的代碼是在通過複雜查詢並進行分頁與排序，經過PageRequest來構建分頁排序的規則。傳入起始頁及每頁的數量，還有排序的規則及以哪一個屬性排序。jpa中是以第0頁開始的，因此傳參的時候須要注意！
固然，若是你不須要進行復雜的查詢也能夠對數據進行分頁及排序查詢。
修改repository，使其繼承PagingAndSortingRepository。

@Repository
public interface AccountRepository extends JpaRepository<Account,String>, JpaSpecificationExecutor<Account> , PagingAndSortingRepository<Account,String> {
    Page<Account> findByAge(int age, Pageable pageable);
}
複製代碼

使用時先建立pageable參數，而後傳進去就能夠了。

//顯示第1頁每頁顯示3條
PageRequest pr = new PageRequest(1,3);
//根據年齡進行查詢
Page<Account> stus = accountPageRepository.findByAge(22,pr); 
複製代碼

排序也是同樣的，在repository中建立方法

List<Account> findByPwd(String pwd, Sort sort);
複製代碼

調用的時候傳入sort對象

//設置排序方式爲username降序
List<Account> accs = accountPageRepository.findByAge("123456",new Sort(Sort.Direction.DESC,"username"));
//設置排序以username和type進行升序
acc = accountPageRepository.findByAge("123456",new Sort(Sort.Direction.ASC,"username","type"));
//設置排序方式以name升序，以address降序
Sort sort = new Sort(new Sort.Order(Sort.Direction.ASC,"name"),new Sort.Order(Sort.Direction.DESC,"type"));
accs = accountPageRepository.findByAge("123456",sort);
複製代碼