深入理解 Spring Boot 项目中的分页与排序功能

WanderInk
438 阅读4分钟

深入理解 Spring Boot 项目中的分页与排序功能

在日常开发中，我们经常需要处理大量数据，比如用户列表、订单信息或者商品清单。当数据量较大时，分页和排序功能就显得尤为重要。分页能帮助我们将数据分批展示，提升用户体验；排序则能让用户快速找到他们想要的信息。

今天，我们就从一个实际的 Spring Boot 项目出发，一步步实现分页和排序功能，并详细剖析其中的设计思路和代码细节。如果你也对这个问题感兴趣，下面的内容将为你揭开分页与排序的实现奥秘。

image.png

什么是分页和排序？

分页和排序是数据展示的两大核心功能：

  1. 分页：通过将数据分成多页，用户可以逐页浏览，避免一次性加载过多数据导致页面性能问题。例如：用户列表中每页展示 10 个用户。
  2. 排序：按照某个字段（如用户 ID、注册时间）升序或降序排列数据，让重要信息更直观。

在开发中，分页和排序通常结合使用，比如：

  • 用户希望按照注册时间倒序查看最近注册的用户。
  • 管理员分页查看用户，并根据用户名排序。

实现分页和排序的整体思路

要实现分页和排序，我们需要关注几个核心问题：

  1. 如何接收分页和排序的参数：用户需要指定当前页、每页大小、排序字段以及排序方向。
  2. 如何在服务层处理分页逻辑：计算偏移量（offset）和限制值（limit）。
  3. 如何在数据库层支持动态排序：通过动态 SQL，支持多字段、多方向的排序。
  4. 如何在前端传递分页和排序参数：在分页按钮和表格标题中动态传递参数。

实现分页和排序的步骤

我们以一个用户管理功能为例，讲解分页和排序的完整实现。

1. 修改 Service 层接口

首先，我们在服务层的接口中定义支持分页和排序的 getAllUsers 方法。

代码修改前：

List<User> getAllUsers(int page, int size);

这段代码只能处理分页，没有排序参数。

代码修改后：

List<User> getAllUsers(int page, int size, String sortField, String sortDirection);

新增内容：

  • sortField：指定排序字段（如 id、username）。
  • sortDirection：指定排序方向（asc 或 desc）。

通过新增参数，我们可以让分页和排序变得灵活，不再局限于单一排序规则。

2. 修改 Service 层实现类

在服务层实现类中，我们要根据分页和排序参数动态生成查询逻辑。

修改前：

@Override
public List<User> getAllUsers(int page, int size) {
    int offset = (page - 1) * size; // 计算偏移量
    return userMapper.findAll(offset, size);
}

这段代码只能分页，不能动态排序。

修改后：

@Override
public List<User> getAllUsers(int page, int size, String sortField, String sortDirection) {
    int offset = (page - 1) * size;

    // 校验排序字段，防止 SQL 注入
    if (!List.of("id", "username", "email", "created_at").contains(sortField)) {
        sortField = "id"; // 默认按 ID 排序
    }
    if (!List.of("asc", "desc").contains(sortDirection.toLowerCase())) {
        sortDirection = "asc"; // 默认升序
    }

    return userMapper.findAll(offset, size, sortField, sortDirection);
}

核心逻辑解析：

  1. 分页计算：offset = (page - 1) * size，计算数据查询的起始位置。
  2. 排序校验：使用白名单校验 sortField 和 sortDirection，避免 SQL 注入攻击。
  3. 动态传参：将 sortField 和 sortDirection 传递给 Mapper 层，支持动态排序。

3. 修改 Mapper 层

为了支持动态排序，我们需要在 SQL 中引入排序字段和排序方向。

修改前：

@Select("SELECT * FROM user LIMIT #{offset}, #{limit}")
List<User> findAll(@Param("offset") int offset, @Param("limit") int limit);

这段代码只支持分页，不支持排序。

修改后：

@Select("SELECT * FROM user ORDER BY ${sortField} ${sortDirection} LIMIT #{offset}, #{limit}")
List<User> findAll(@Param("offset") int offset,
                   @Param("limit") int limit,
                   @Param("sortField") String sortField,
                   @Param("sortDirection") String sortDirection);

核心逻辑解析：

  1. 动态排序字段：ORDER BY ${sortField}，通过参数指定排序字段。
  2. 动态排序方向：${sortDirection}，支持升序（asc）和降序（desc）。
  3. 分页查询：LIMIT #{offset}, #{limit}，限制查询结果的条数。

4. 修改 Controller 层

在控制器中，我们需要接收前端传递的分页和排序参数，并将参数传递给服务层。

修改前：

@GetMapping("/users")
public String listUsers(@RequestParam(defaultValue = "1") int page,
                        @RequestParam(defaultValue = "10") int size,
                        Model model) {
    List<User> users = userService.getAllUsers(page, size);
    model.addAttribute("users", users);
    return "auth/manage-users";
}

这段代码只处理分页。

修改后：

@GetMapping("/users")
public String listUsers(@RequestParam(defaultValue = "1") int page,
                        @RequestParam(defaultValue = "10") int size,
                        @RequestParam(defaultValue = "id") String sortField,
                        @RequestParam(defaultValue = "asc") String sortDirection,
                        Model model) {
    List<User> users = userService.getAllUsers(page, size, sortField, sortDirection);
    model.addAttribute("users", users);

    // 传递分页和排序参数到前端
    model.addAttribute("currentPage", page);
    model.addAttribute("pageSize", size);
    model.addAttribute("sortField", sortField);
    model.addAttribute("sortDirection", sortDirection);

    return "auth/manage-users";
}

5. 修改前端页面

在前端页面中，我们需要动态传递分页和排序参数。

表头排序链接：

<th><a th:href="@{'/admin/users'(sortField='username', sortDirection=${sortDirection == 'asc' ? 'desc' : 'asc'})}">Username</a></th>

分页链接：

<div>
    <a th:href="@{'/admin/users'(page=${currentPage - 1}, size=${pageSize}, sortField=${sortField}, sortDirection=${sortDirection})}" 
       th:if="${currentPage > 1}">Previous</a>
    <span th:text="'Page ' + ${currentPage}"></span>
    <a th:href="@{'/admin/users'(page=${currentPage + 1}, size=${pageSize}, sortField=${sortField}, sortDirection=${sortDirection})}" 
       th:if="${currentPage < totalPages}">Next</a>
</div>

总结

通过以上步骤，我们实现了一个支持分页和排序的用户管理功能。从后端到前端的每一步都紧密相连，每个模块都有其独特的职责：

  1. Service 层：计算分页偏移量，校验排序参数。
  2. Mapper 层：动态生成 SQL，实现分页和排序。
  3. Controller 层：接收参数，传递给服务层，并返回给前端。
  4. 前端页面：动态生成分页链接和排序链接，提升用户体验。
avatar
文章
阅读
粉丝