使用 Spring Data JPA 进行分页和排序

最新推荐文章于 2022-12-02 16:48:34 发布

陆理手记

最新推荐文章于 2022-12-02 16:48:34 发布

阅读量260

点赞数

点击左上角蓝字，关注“锅外的大佬” 640?wx_fmt=gif

专注分享国外最新技术内容

了解如何使用 Spring Data JPA 实现分页和排序。

概览

当处理大量数据时，延迟处理通常是必不可少的。即使服务返回大量数据，消费者也不太可能使用它。想象一个购物网站，客户在网站上搜索产品，网站有数千种产品可供展示。获取数千种产品并将他们显示网页上将非常耗时。在大多数情况下，客户甚至可能不会查看所有产品。

对于这种情况，一种被叫做分页的技术被使用了。首先只显示一小部分产品（页面），客户可以要求查看下一部分（页面）等。

要了解 JPA 和 Spring Data JPA 的基础知识，请查看以下链接：

Hands-on Spring Data JPA (A Spring Data JPA Learning Series)
What is JPA, Spring Data and Spring Data JPA

实体（Entity）

为了本教程的目的，我们将考虑 Employee 实体的最简单实例。下面是 Employee实体类。

@Entity	
public class Employee {	
    @Id	
    private Long name;	
    private String firstName;	
    private String lastName;	
    private Date dateOfBirth;	
    private Integer age;	
    private String designation;	
    private double salary;	
    private Date dateOfJoining;	
    public Long getName() {	
        return name;	
    }	
    public void setName(Long name) {	
        this.name = name;	
    }	
    public String getFirstName() {	
        return firstName;	
    }	
    public void setFirstName(String firstName) {	
        this.firstName = firstName;	
    }	
    public String getLastName() {	
        return lastName;	
    }	
    public void setLastName(String lastName) {	
        this.lastName = lastName;	
    }	
    public Date getDateOfBirth() {	
        return dateOfBirth;	
    }	
    public void setDateOfBirth(Date dateOfBirth) {	
        this.dateOfBirth = dateOfBirth;	
    }	
    public Integer getAge() {	
        return age;	
    }	
    public void setAge(Integer age) {	
        this.age = age;	
    }	
    public String getDesignation() {	
        return designation;	
    }	
    public void setDesignation(String designation) {	
        this.designation = designation;	
    }	
    public double getSalary() {	
        return salary;	
    }	
    public void setSalary(double salary) {	
        this.salary = salary;	
    }	
    public Date getDateOfJoining() {	
        return dateOfJoining;	
    }	
    public void setDateOfJoining(Date dateOfJoining) {	
        this.dateOfJoining = dateOfJoining;	
    }	
}

想了解更多关于在 Spring 和 Spring Boot 中使用 Java 持久化 API （JPA）的信息？

查看一下附加链接：

Spring Boot with Spring Data JPA
Spring Data JPA Composite Key with @EmbeddedId
Spring Data JPA find by @EmbeddedId Partially
Java Persistence API Guide
Spring Data JPA Query Methods

Employee 存储库（Repository）

在文章《Spring Data JPA Query Methods》中，我们已经了解了 Spring 存储库接口和查询方法。这里，我们需要学习分页，所以我们将使用 Spring 的 PagingAndSortingRepository。

@Repository	
public interface EmployeeRepository extends PagingAndSortingRepository<Employee, Long> {	
    Page<Employee> findAll(Pageable pageable);	
    Page<Employee> findByFirstName(String firstName, Pageable pageable);	
    Slice<Employee> findByFirstNameAndLastName(String firstName, String lastName, Pageable pageable);	
}

分页（Pagination）

看一看 EmployeeRepository。该方法接受 Pageable 参数。 Pageable 是一个由 Spring 定义的接口，它拥有一个 PageRequest。让我们看看如何创建一个 PageRequest。

Pageable pageable = PageRequest.of(0, 10);	
Page<Employee> page = employeeRepository.findAll(pageable);

在第一行，我们创建了一个 10 个员工的 PageRequest，并请求第一页（0）。该页面请求被传递给 findAll 以获取 Employee 的页面作为响应。

如果我们要访问下一页，我们可以每次增加页码。

PageRequest.of(1, 10);	
PageRequest.of(2, 10);	
PageRequest.of(3, 10);	
...

排序

Spring Data JPA 提供了一个 Sort 对象以提供排序机制。让我们看看排序的方式。

employeeRepository.findAll(Sort.by("fistName"));	
employeeRepository.findAll(Sort.by("fistName").ascending().and(Sort.by("lastName").descending());

显然，第一个按“firstName”简单的排序，另一个按“firstName”升序和“lastName”降序排序。

同时分页和排序

Pageable pageable = PageRequest.of(0, 20, Sort.by("firstName"));	
Pageable pageable = PageRequest.of(0, 20, Sort.by("fistName").ascending().and(Sort.by("lastName").descending());

切片（Slice） Vs. 页（Page）

在 EmployeeRepository 中，我们看到其中一个方法返回 Slice，另一个返回 Page。它们都是 Spring Data JPA， Page 是 Slice 的子接口。他们都用于保存并返回数据的子集。让我们一个一个看看它们。

分片（Slice）

Slice 知道它是否有内容以及它是否是第一个或最后一个分片。它还能够返回当前和之前分片使用的 Pageable。我们来看看 Slice 的一些重要方法。

List<T> getContent(); // get content of the slice	
Pageable getPageable(); // get current pageable	
boolean hasContent(); 	
boolean isFirst();	
boolean isLast();	
Pageable nextPageable(); // pageable of the next slice	
Pageable previousPageable(); // pageable of the previous slice

页（Page）

Page 是 Slice 的子接口并有几个额外的方法。它知道表中的总页数以及记录总数。以下是 Page 的一些重要方法。

static <T> Page<T> empty; //create an empty page	
long getTotalElements(); // number of total elements in the table	
int totalPages() // number of total pages in the table