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

简介: 本文深入讲解了在Spring Boot项目中实现分页与排序功能的完整流程。通过实际案例,从Service层接口设计到Mapper层SQL动态生成,再到Controller层参数传递及前端页面交互,逐一剖析每个环节的核心逻辑与实现细节。重点包括分页计算、排序参数校验、动态SQL处理以及前后端联动,确保数据展示高效且安全。适合希望掌握分页排序实现原理的开发者参考学习。

theme: cyanosis

深入理解 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:指定排序字段(如 idusername)。
  • sortDirection:指定排序方向(ascdesc)。

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

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. 排序校验:使用白名单校验 sortFieldsortDirection,避免 SQL 注入攻击。
  3. 动态传参:将 sortFieldsortDirection 传递给 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. 前端页面:动态生成分页链接和排序链接,提升用户体验。
目录
相关文章
|
2月前
|
Java 关系型数据库 MySQL
springboot项目集成dolphinscheduler调度器 实现datax数据同步任务
springboot项目集成dolphinscheduler调度器 实现datax数据同步任务
343 2
|
2月前
|
分布式计算 Java 大数据
springboot项目集成dolphinscheduler调度器 可拖拽spark任务管理
springboot项目集成dolphinscheduler调度器 可拖拽spark任务管理
155 2
|
2月前
|
Java 测试技术 Spring
简单学Spring Boot | 博客项目的测试
本内容介绍了基于Spring Boot的博客项目测试实践,重点在于通过测试驱动开发(TDD)优化服务层代码,提升代码质量和功能可靠性。案例详细展示了如何为PostService类编写测试用例、运行测试并根据反馈优化功能代码,包括两次优化过程。通过TDD流程,确保每项功能经过严格验证,增强代码可维护性与系统稳定性。
151 0
|
2月前
|
存储 Java 数据库连接
简单学Spring Boot | 博客项目的三层架构重构
本案例通过采用三层架构(数据访问层、业务逻辑层、表现层)重构项目,解决了集中式开发导致的代码臃肿问题。各层职责清晰,结合依赖注入实现解耦,提升了系统的可维护性、可测试性和可扩展性,为后续接入真实数据库奠定基础。
261 0
|
4月前
|
消息中间件 缓存 NoSQL
基于Spring Data Redis与RabbitMQ实现字符串缓存和计数功能(数据同步)
总的来说,借助Spring Data Redis和RabbitMQ,我们可以轻松实现字符串缓存和计数的功能。而关键的部分不过是一些"厨房的套路",一旦你掌握了这些套路,那么你就像厨师一样可以准备出一道道饕餮美食了。通过这种方式促进数据处理效率无疑将大大提高我们的生产力。
183 32
|
3月前
|
网络协议 Java
在SpringBoot项目中使用Netty实现远程调用
本文介绍了使用Netty解决网络连接性能问题的方法,重点讲解了Netty的NIO特性及其在SpringBoot中的应用。Netty作为高效的NIO框架,支持非阻塞IO,能通过单线程管理多个客户端连接,简化TCP/UDP套接字服务器开发。文章详细展示了Netty在SpringBoot中实现远程调用的过程,包括服务端与客户端代码实现、依赖配置及测试验证。通过示例代码,如`NettyServer`、`NettyClientUtil`等,清晰说明了Netty的工作原理和实际应用,解决了半包等问题,并提供了完整的测试结果。
503 3
|
4月前
|
安全 Java API
Spring Boot 功能模块全解析:构建现代Java应用的技术图谱
Spring Boot不是一个单一的工具,而是一个由众多功能模块组成的生态系统。这些模块可以根据应用需求灵活组合,构建从简单的REST API到复杂的微服务系统,再到现代的AI驱动应用。
|
Java 数据库 数据安全/隐私保护
《Spring 3.0就这么简单》——1.2 实例功能概述
Spring拥有持久层、业务层和展现层的“原生技术”,分别是Spring JDBC、声明式事务和Spring MVC。为了充分展现Spring本身的魅力,在本章中仅使用Spring的这些原生技术,在以后的章节中,我们将学习其他的持久层和展现层技术,只要用户愿意,就可以平滑地将其过渡到其他技术实现中。
2143 0
|
2月前
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解,它通过@Import导入配置选择器,加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories,改用新格式的.imports文件进行配置。
734 0
|
6月前
|
前端开发 Java 数据库
微服务——SpringBoot使用归纳——Spring Boot集成Thymeleaf模板引擎——Thymeleaf 介绍
本课介绍Spring Boot集成Thymeleaf模板引擎。Thymeleaf是一款现代服务器端Java模板引擎,支持Web和独立环境,可实现自然模板开发,便于团队协作。与传统JSP不同,Thymeleaf模板可以直接在浏览器中打开,方便前端人员查看静态原型。通过在HTML标签中添加扩展属性(如`th:text`),Thymeleaf能够在服务运行时动态替换内容,展示数据库中的数据,同时兼容静态页面展示,为开发带来灵活性和便利性。
316 0