数据分页与排序 - 分页查询 - 实现分页功能

Java - Web - Spring 《数据分页与排序 - 分页查询 - 实现分页功能》

在 Web 应用开发中，当我们需要处理大量数据时，一次性将所有数据展示给用户显然是不现实的，不仅会影响页面加载速度，还会给服务器带来较大的压力。因此，数据分页查询是一个非常重要的功能。本文将详细介绍在 Spring 框架中如何实现分页功能。

1. 环境准备

我们假设你已经搭建好了一个基于 Spring Boot 的项目，并且使用 Spring Data JPA 来进行数据库操作。如果你还没有搭建好项目，可以使用 Spring Initializr 快速创建一个包含 Spring Web 和 Spring Data JPA 依赖的项目。

2. 数据库实体类

首先，我们需要创建一个数据库实体类，这里以一个简单的 User 类为例：

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private int age;
    // 构造函数、Getter 和 Setter 方法
    public User() {}
    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}

3. 数据访问层（Repository）

接下来，我们创建一个 UserRepository 接口，继承自 JpaRepository，Spring Data JPA 会自动为我们提供基本的 CRUD 操作和分页查询功能：

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.repository.JpaRepository;
public interface UserRepository extends JpaRepository<User, Long> {
    Page<User> findAll(Pageable pageable);
}

这里的 findAll(Pageable pageable) 方法是 Spring Data JPA 提供的默认分页查询方法，Pageable 接口用于封装分页和排序信息。

4. 服务层（Service）

创建一个 UserService 类，调用 UserRepository 的分页查询方法：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.stereotype.Service;
@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;
    public Page<User> getUsersByPage(Pageable pageable) {
        return userRepository.findAll(pageable);
    }
}

5. 控制器层（Controller）

最后，创建一个 UserController 类，接收前端传递的分页参数，并返回分页数据：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
    @Autowired
    private UserService userService;
    @GetMapping("/users")
    public Page<User> getUsers(
            @RequestParam(defaultValue = "0") int page,
            @RequestParam(defaultValue = "10") int size
    ) {
        Pageable pageable = PageRequest.of(page, size);
        return userService.getUsersByPage(pageable);
    }
}

在 getUsers 方法中，我们通过 @RequestParam 注解接收前端传递的 page 和 size 参数，分别表示当前页码和每页显示的记录数。然后使用 PageRequest.of(page, size) 方法创建一个 Pageable 对象，调用 UserService 的 getUsersByPage 方法进行分页查询。

6. 测试

启动 Spring Boot 项目，访问 http://localhost:8080/users?page=0&size=5，即可获取第一页的 5 条用户数据。

总结

通过以上步骤，我们就可以在 Spring 框架中轻松实现数据的分页查询功能。分页查询不仅可以提高用户体验，还可以减轻服务器的负担，是 Web 应用开发中不可或缺的一部分。