Springboot整合Thymeleaf-分页查询

'# Springboot整合Thymeleaf-分页查询

一、背景与问题

在企业级Web应用开发中，分页查询是数据展示的核心需求之一。传统Web开发中，开发者需要手动处理分页逻辑，包括计算总页数、生成分页控件、处理翻页请求等。Spring Boot与Thymeleaf的结合，为开发者提供了优雅的解决方案。

然而，实际开发中常遇到以下问题：

分页参数传递机制不清晰，容易出现越界或非法值
Thymeleaf模板中分页控件的动态生成逻辑复杂
分页查询时性能优化不足，导致数据库负载过高
分页数据与前端交互时的安全隐患（如SQL注入）
分页策略在不同业务场景下的适用性差异

二、基本原理

Spring Boot整合Thymeleaf的分页查询主要涉及三个核心组件：

Spring Data JPA：提供分页查询的基础设施
Pageable接口：定义分页参数的抽象接口
Thymeleaf模板引擎：处理前端分页控件的动态渲染

核心流程如下：

前端通过URL参数传递page和size参数
Spring Boot接收参数并创建Pageable对象
Repository层使用Pageable进行分页查询
返回Page<T>对象包含分页数据
Thymeleaf模板解析Page<T>对象生成分页控件

三、环境准备

# application.properties
spring.datasource.url=jdbc:mysql://localhost:3306/mydb?useSSL=false&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=root
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true

// pom.xml 依赖
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

四、核心实现

1. 实体类定义

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    private String name;
    private String email;
    
    // getters and setters
}

2. Repository接口

public interface UserRepository extends JpaRepository<User, Long> {
    Page<User> findAll(Pageable pageable);
}

3. Controller层

@Controller
public class UserController {
    @Autowired
    private UserRepository userRepository;
    
    @GetMapping("/users")
    public String users(@RequestParam(defaultValue = "0") int page,
                      @RequestParam(defaultValue = "10") int size,
                      Model model) {
        Pageable pageable = PageRequest.of(page, size);
        Page<User> users = userRepository.findAll(pageable);
        model.addAttribute("users", users);
        return "users";
    }
}

4. Thymeleaf模板

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>用户列表</title>
</head>
<body>
    <h1>用户列表</h1>
    
    <table border="1">
        <thead>
            <tr>
                <th>姓名</th>
                <th>邮箱</th>
            </tr>
        </thead>
        <tbody>
            <tr th:each="user : ${users.content}">
                <td th:text="${user.name}">用户</td>
                <td th:text="${user.email}">邮箱</td>
            </tr>
        </tbody>
    </table>
    
    <div>
        <span th:if="${users.totalPages > 0}">
            <a th:href="@{/users(page=${users.number - 1}, size=${users.size})}" 
               th:unless="${users.number == 0}">上一页</a>
            
            <span th:each="i : ${#range(0, users.totalPages)}">
                <a th:href="@{/users(page=${i}, size=${users.size})}" 
                   th:text="${i + 1}" 
                   th:class="${users.number == i} ? 'active' : ''"/>
            </span>
            
            <a th:href="@{/users(page=${users.number + 1}, size=${users.size})}" 
               th:if="${users.number < users.totalPages - 1}">下一页</a>
        </span>
    </div>
</body>
</html>

五、完整案例

1. 项目结构

src
├── main
│   ├── java
│   │   └── com.example.demo
│   │       ├── controller
│   │       │   └── UserController.java
│   │       ├── repository
│   │       │   └── UserRepository.java
│   │       ├── entity
│   │       │   └── User.java
│   │       └── DemoApplication.java
│   └── resources
│       └── templates
│           └── users.html

2. 启动类

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

3. 启动后访问

访问 http://localhost:8080/users，将看到带分页功能的用户列表页面

六、源码解析

1. Pageable的创建

Pageable pageable = PageRequest.of(page, size);

PageRequest.of()方法创建Pageable对象
page参数从0开始，对应数据库的offset计算
size参数控制每页数据量，默认10
如果不指定size，Spring Boot会使用默认值

2. 分页查询的执行

Page<User> users = userRepository.findAll(pageable);

Spring Data JPA会自动处理分页逻辑
实际执行的SQL会包含LIMIT和OFFSET子句
可通过spring.jpa.show-sql=true查看生成的SQL

3. Thymeleaf模板解析

<span th:if="${users.totalPages > 0}">

users.totalPages表示总页数
users.number表示当前页码（从0开始）
users.size表示每页大小
users.content表示当前页的数据列表

七、进阶使用

1. 自定义分页参数

@GetMapping("/users")
public String users(@RequestParam(defaultValue = "0") int page,
                  @RequestParam(defaultValue = "10") int size,
                  Model model) {
    Pageable pageable = PageRequest.of(page, size);
    Page<User> users = userRepository.findAll(pageable);
    model.addAttribute("users", users);
    return "users";
}

2. 分页参数校验

@Valid
public String users(@RequestParam(defaultValue = "0") @Min(0) int page,
                  @RequestParam(defaultValue = "10") @Max(100) int size,
                  Model model) {
    // ...
}

3. 分页参数传递方式

<a th:href="@{/users(page=0, size=20)}">第一页</a>

八、性能与工程实践

1. 性能优化

索引优化：在查询字段上添加索引
分页查询优化：使用WHERE id > ? + ORDER BY id的方式
分页大小限制：设置最大分页大小（如100）
缓存策略：对热点分页数据进行缓存

2. 安全风险

SQL注入风险：避免直接拼接SQL语句
越权访问：确保分页数据属于当前用户
参数验证：校验分页参数的合法性
XSS攻击：对用户输入进行过滤

3. 分页策略比较

策略	优点	缺点
Pageable	简单易用	无法灵活控制分页逻辑
自定义	灵活可控	需要手动处理分页逻辑
SQL分页	高度控制	需要处理offset问题

九、常见问题与踩坑

1. 分页参数越界问题

// 错误示例
@GetMapping("/users")
public String users(@RequestParam int page, @RequestParam int size, Model model) {
    Pageable pageable = PageRequest.of(page, size);
    // ...
}

问题：未设置默认值，可能导致空指针异常

解决：使用@RequestParam(defaultValue = "0")设置默认值

2. 分页控件生成错误

<!-- 错误示例 -->
<span th:each="i : ${#range(0, users.totalPages)}">
    <a th:href="@{/users(page=${i}, size=${users.size})}" 
       th:text="${i + 1}"/>
</span>

问题：页面索引从0开始，但显示的是1-based

解决：使用i + 1进行转换

3. 分页数据不刷新

原因：浏览器缓存导致页面未刷新

解决：在URL中添加随机参数 ?_=randomNumber

4. 分页性能问题

问题：分页数据量过大时，前端加载缓慢

解决：使用懒加载，分页数据按需加载

十、最佳实践

统一分页接口：所有分页接口使用相同的参数格式
分页参数校验：添加@Min/@Max注解校验参数合法性
分页大小限制：设置最大分页大小（如100）
分页控件优化：使用分页组件库（如Bootstrap Paginator）
分页日志记录：记录分页查询日志，便于排查问题
分页数据缓存：对热点数据进行缓存，提升性能
分页安全控制：确保分页数据属于当前用户

十一、总结

Spring Boot整合Thymeleaf实现分页查询，是企业级Web开发中不可或缺的核心能力。本文深入解析了分页查询的实现原理，通过完整的代码示例展示了实际开发中的实现方式。在实际开发中，需要根据业务场景选择合适的分页策略，注意分页参数的校验和安全控制，同时关注性能优化。对于大数据量的分页查询，建议采用更高级的分页策略，如基于游标的分页或分页数据库查询优化技术。通过合理的设计和实现，可以构建出高效、安全、可维护的分页系统。