Spring Data JPA 分頁及排序查詢範例 pagination and sorting query example

Spring Data JPA 分頁及排序查詢簡單範例如下。

Message是要被查詢的Entity類，映射資料庫的MESSAGE資料表。
等一下查詢時將以CREATE_TIME欄位來排序。

Message

package com.abc.demo.entity;

import javax.persistence.Entity
import javax.persistence.Table
import javax.persistence.Id
import javax.persistence.Column

@Entity
@Table(name="MESSAGE")
public class Message {

    @Id
    @Column("ID")
    private String id;

    @Column("CONTENT")
    private String content;

    @Column("CREATE_TIME")   // <-- sort by this column
    private Long createTime;

    // getters and setters...
    
}

MessageRepository用來存取資料庫的Repository類，繼承JpaRepository<T, ID>，其Spring Data JPA的實作子類SimpleJpaRepository提供了分頁查詢方法如findAll(Pageable pageable)。

MessageRepository

package com.abc.demo.repository;

import org.springframework.data.jpa.repository
import org.springframework.stereotype.Repository;

import com.abc.demo.entity.Message;

@Repository
public interface MessageRepository extends JpaRepository<Message, String> {

}

下面為使用PageRequest.of(int page, int size, Sort sort)搭配Sort來對資料庫做分頁及排序查詢。

注意page是zero-based index，也就是第一頁是從0起算。

MessageDao

package com.abc.demo.dao;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Sort;
import org.springframework.stereotype.Service;

import com.abc.demo.entity.Message;
import com.abc.demo.repository.MessageRepository

@Service
public class MessageDao {

    @Autowired
    private MessageRepository messageRepository

    public List<Message> getPagedMessages(int page, int size) {
    
        Page<Message> pageResult = messageRepository.findAll(
                PageRequest.of(page,  // 查詢的頁數，從0起算
                                size, // 查詢的每頁筆數
                                Sort.by("createTime").descending())); // 依CREATE_TIME欄位降冪排序
        
        pageResult.getNumberOfElements(); // 本頁筆數
        pageResult.getSize();             // 每頁筆數 
        pageResult.getTotalElements();    // 全部筆數
        pageResult.getTotalPages();       // 全部頁數
        
        List<Message> messageList =  pageResult.getContent();
    
        return messageList;
    
    }

}

返回的Page物件中除了裝載了查詢結果外，還可取得該筆分頁的資訊如查詢筆數等。

參考：

• Pagination and Sorting With Spring Data JPA
• Working with Spring Data Repositories
• Spring Data MongoDB 分頁查詢 page query