springboot帶分頁的條件查詢

QueryDSL簡介

　　QueryDSL僅僅是一個通用的查詢框架，專注於通過Java API構建類型安全的SQL查詢。
　　Querydsl可以通過一組通用的查詢API為用戶構建出適合不同類型ORM框架或者是SQL的查詢語句，也就是說QueryDSL是基於各種ORM框架以及SQL之上的一個通用的查詢框架。
借助QueryDSL可以在任何支持的ORM框架或者SQL平台上以一種通用的API方式來構建查詢。目前QueryDSL支持的平台包括JPA,JDO,SQL,Java Collections,RDF,Lucene,Hibernate Search。
官網地址:http://www.querydsl.com/static/querydsl/4.1.3/reference/html_single/

 

　　Querydsl 是一個類型安全的 Java 查詢框架，支持 JPA, JDO, JDBC, Lucene, Hibernate Search 等標准。類型安全（ Type safety ）和一致性（ Consistency ）是它設計的兩大准則。在 Spring Boot 中可以很好的彌補 JPA 的不靈活，實現更強大的邏輯。

1.配置到項目

第一步:Maven引入依賴:
　　首先對於queryDSL有兩個版本,com.mysema.querydsl和com.querydsl,前者是3.X系列后者是4.X系列,這里使用的是后者.

<dependency>
    <groupId>com.querydsl</groupId>
    <artifactId>querydsl-apt</artifactId>
    <scope>provided</scope>
</dependency>

<dependency>
    <groupId>com.querydsl</groupId>
    <artifactId>querydsl-jpa</artifactId>
</dependency>

第二步:加入插件,用於生成查詢實例，因為是類型安全的，所以還需要加上 Maven APT plugin ，使用 APT 自動生成一些類:

<project>
  <build>
  <plugins>
    ...
    <plugin>
    <groupId>com.mysema.maven</groupId>
    <artifactId>apt-maven-plugin</artifactId>
    <version>1.1.3</version>
    <executions>
        <execution>
            <phase>generate-sources</phase>
            <goals>
                <goal>process</goal>
            </goals>
            <configuration>
                <outputDirectory>target/generated-sources</outputDirectory>
                <processor>com.querydsl.apt.jpa.JPAAnnotationProcessor</processor>
            </configuration>
        </execution>
    </executions>
</plugin>
    ...
  </plugins>
  </build>
</project>

　　執行mvn compile之后,可以找到該target/generated-sources/java,然后IDEA標示為源代碼目錄即可

3.基本概念

　　每一個 Model (使用  @javax.persistence.Entity  注解的)， Querydsl 都會在同一個包下生成一個以 Q 開頭（默認，可配置）的類，來實現便利的查詢操作。
　Spring 提供了一個便捷的方式使用 Querydsl ，只需要在 Repository 中繼承  QueryDslPredicateExecutor  即可：

 @Repository public interface NoticeRespository extends JpaRepository<Notice,Long>, QueryDslPredicateExecutor<Notice> { } 

然后就可以使用 UserRepository 無縫和 Querydsl 連接， QueryDslPredicateExecutor 接口提供了如下方法：

public interface QueryDslPredicateExecutor<T> {  
  
    T findOne(Predicate predicate);  
  
    Iterable<T> findAll(Predicate predicate);  
  
    Iterable<T> findAll(Predicate predicate, Sort sort);  
  
    Iterable<T> findAll(Predicate predicate, OrderSpecifier<?>... orders);  
  
    Iterable<T> findAll(OrderSpecifier<?>... orders);  
  
    Page<T> findAll(Predicate predicate, Pageable pageable);  
  
    long count(Predicate predicate);  
  
    boolean exists(Predicate predicate);  
}  

4.Spring 參數支持解析 com.querydsl.core.types.Predicate

　　根據用戶請求的參數自動生成 Predicate，這樣搜索方法不用自己寫啦，比如

@GetMapping("posts")
public Object posts(@QuerydslPredicate(root = Post.class) Predicate predicate) {
    return postRepository.findAll(predicate);
}
// 或者順便加上分頁
@GetMapping("posts")
public Object posts(@QuerydslPredicate(root = Post.class) Predicate predicate, Pageable pageable) {
    return postRepository.findAll(predicate, pageable);
}

　　

然后請求：

/posts?title=title01 // 返回文章 title 為 title01 的文章 /posts?id=2 // 返回文章 id 為 2 的文章 /posts?category.name=Python // 返回分類為 Python 的文章（你沒看錯，可以嵌套，訪問關系表中父類屬性） /posts?user.id=2&category.name=Java // 返回用戶 ID 為 2 且分類為 Java 的文章

　　 Pageable  是Spring Data庫中定義的一個接口，該接口是所有分頁相關信息的一個抽象，通過該接口，我們可以得到和分頁相關所有信息（例如 pageNumber 、 pageSize 等）。
　　Pageable定義了很多方法，但其核心的信息只有兩個：一是分頁的信息（ page 、 size ），二是排序的信息。
　　在springmvc的請求中只需要在方法的參數中直接定義一個 pageable 類型的參數，當Spring發現這個參數時，Spring會自動的根據request的參數來組裝該pageable對象，Spring支持的request參數如下：
 page ，第幾頁，從0開始，默認為第0頁
 size ，每一頁的大小，默認為20
 sort ，排序相關的信息，以property,property(,ASC|DESC)的方式組織，例如sort=firstname&sort=lastname,desc表示在按firstname正序排列基礎上按lastname倒序排列。

　　這樣，我們就可以通過url的參數來進行多樣化、個性化的查詢。
Spring data提供了 @PageableDefault 幫助我們個性化的設置pageable的默認配置。例如 @PageableDefault(value = 15, sort = { "id" }, direction = Sort.Direction.DESC) 表示默認情況下我們按照id倒序排列，每一頁的大小為15。

@ResponseBody  
@RequestMapping(value = "list", method=RequestMethod.GET)  
public Page<blog> listByPageable(@PageableDefault(value = 15, sort = { "id" }, direction = Sort.Direction.DESC)   
    Pageable pageable) {  
    return blogRepository.findAll(pageable);  
}  

4.注意，這樣不會產生 SQL 注入問題的，因為不存在的屬性寫了是不起效果的， Spring 已經進行了判斷。

　　 再補充一點，你還可以修改默認行為，繼承 QueryDslPredicateExecutor 接口：

@Repository
public interface NoticeRespository extends JpaRepository<Notice,Long>, QueryDslPredicateExecutor<Notice>,QuerydslBinderCustomizer<QNotice> {

    default void customize(QuerydslBindings bindings,QNotice notice){
        bindings.bind(notice.content).first((path,value) ->path.contains(value).or(notice.title.contains(value)));
        bindings.bind(notice.firsttime).first((path,value) ->notice.pushdate.after(value));
        bindings.bind(notice.secondtime).first((path,value) ->notice.pushdate.before(value));
    }

}

　　這樣你再訪問  /list?content=keywords  時，返回的是文章標題包含 keywords 或者內容包含keywords，而不是僅僅等於的所有文章啦! 

　　而且訪問 /list?firsttime=2018.1.10&secontime=2018.1.11 時，返回的是pushdate在firsttime和secondtime之間的文章，只輸入firsttime是之后的所有，只輸入secondtime則是之前的所有文章。這樣大大簡化了操作！

5.實例

 

package com.xunao.rubber.web.admin.notice;

import com.xunao.rubber.domain.*;
import com.xunao.rubber.repository.NoticeRespository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.*;
import org.springframework.data.querydsl.binding.QuerydslPredicate;
import org.springframework.data.web.PageableDefault;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;
import org.springframework.data.domain.Pageable;
import com.querydsl.core.types.Predicate;

/**
 * @author jinzhe
 * @date 2018/1/10
 */
@Controller
@RequestMapping("/admin/notice")
public class AdminNoticeRecordController {

    @Autowired
    private NoticeRespository noticeRespository;

    @GetMapping("/list")
    public String notice(Model model,Notice notice,
                         @PageableDefault(sort = "id", direction = Sort.Direction.DESC) Pageable pageable,
                         @QuerydslPredicate(root = Notice.class) Predicate predicate) {
        Page<Notice> notices = noticeRespository.findAll(predicate, pageable);
        model.addAttribute("notices", notices);
        return "admin/notice/list";
    }
}

 

 

 

　　 predicate 除了之前在Respository里寫的默認的條件外，還可以自己添加新的條件，例如：

predicate = QNotice.notice.pushdate.between(firsttime, secondtime).and(predicate); 

predicate = QNotice.notice.content.contains(keywords).and(predicate);