PageHelper-Spring-Boot 教程
1. 项目介绍
PageHelper 是一个针对 MyBatis 的分页插件,它提供了方便的分页功能,只需简单的配置就能轻松实现复杂的分页需求。PageHelper-Spring-Boot 是该插件的 Spring Boot 集成版,它帮助用户无缝地将 PageHelper 引入到 Spring Boot 应用程序中,无需繁琐的配置。
2. 项目快速启动
2.1 添加依赖
首先,在你的 pom.xml
文件中添加 PageHelper-Spring-Boot Starter 的依赖:
<dependencies>
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>2.1.0</version>
</dependency>
</dependencies>
2.2 配置 application.properties
在 application.properties
文件中添加以下配置以启用 PageHelper:
pagehelper.helperDialect=mysql # 数据库类型
pagehelper.reasonable=true # 是否合理处理count查询
pagehelper.supportMethodsArguments=true # 支持通过Map传入分页参数
pagehelper.params=count=countSql # 自定义参数
2.3 使用示例
在 Service 或 Repository 类中,使用 PageHelper 开启分页:
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
@Service
public class UserService {
@Autowired
private UserRepository userRepository;
public Page<User> getUserList(int pageNum, int pageSize) {
PageHelper.startPage(pageNum, pageSize);
return userRepository.findAll();
}
}
在 Controller 类中,接收请求并调用 Service 方法:
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 Object getUsers(@RequestParam(defaultValue="1") Integer pageNum,
@RequestParam(defaultValue="10") Integer pageSize) {
return userService.getUserList(pageNum, pageSize);
}
}
3. 应用案例与最佳实践
3.1 异步 Count 支持
从版本 2.0.0 开始,PageHelper 支持异步计算总数。要开启此功能,可以在启动分页时调用 enableAsyncCount()
:
PageHelper.startPage(pageNum, pageSize).enableAsyncCount();
3.2 自定义 SQL 解析器
你可以通过 SPI 方式或构造函数参数替换默认的 SQL 解析器,例如替换 CountSqlParser:
PageHelper.startPage(pageNum, pageSize)
.setCountSqlParser(new YourCustomCountSqlParser());
4. 典型生态项目
PageHelper-Spring-Boot 适用于任何基于 Spring Boot 并使用 MyBatis 的应用程序。它可以与其他 Spring Boot 生态组件如 Spring Data JPA、MyBatis-Spring-Boot-Starter、Swagger 等结合使用,构建强大的数据访问层。
本教程覆盖了 PageHelper-Spring-Boot 的基本使用方法,包括配置、快速启动示例以及一些高级特性。结合官方文档和示例项目,可以进一步了解如何在实际项目中充分利用这一工具。