springboot~mybatis-pagehelper原理与使用
原理
PageHelper
是一个用于MyBatis的分页插件,pagehelper-spring-boot-starter
是其在Spring Boot中的集成组件。下面简要介绍PageHelper
的分页原理:
PageHelper的分页原理
-
拦截器机制:
PageHelper
通过MyBatis的拦截器机制实现分页功能。它会在SQL执行前拦截并修改SQL语句,添加分页相关的信息。 -
ThreadLocal存储分页参数:在调用分页查询之前,会将分页参数(如页码、每页数量)存储在当前线程的
ThreadLocal
中,确保每次查询都能获取到正确的分页信息。 -
自动构建分页SQL:根据存储在
ThreadLocal
中的分页参数,在拦截器中自动构建带有分页逻辑的SQL语句,例如使用LIMIT
和OFFSET
来限制返回结果集。 -
执行分页查询:当执行带有分页参数的查询时,
PageHelper
会拦截该查询并根据分页参数重新构建SQL语句,然后执行查询操作。 -
封装分页结果:在查询完成后,
PageHelper
会将查询结果封装成包含分页信息的对象,方便在业务逻辑中使用。
PageHelper-Spring-Boot-Starter的集成原理
-
自动配置:
pagehelper-spring-boot-starter
提供了自动配置类,可以根据配置文件中的属性自动配置PageHelper
的相关参数,简化了在Spring Boot项目中集成PageHelper
的步骤。 -
注入拦截器:在自动配置过程中,会向MyBatis的
SqlSessionFactory
中注入PageInterceptor
,这个拦截器负责拦截SQL并处理分页逻辑。 -
配置参数:通过在
application.properties
或application.yml
中配置pagehelper
相关属性,可以定制化地设置分页参数,如页码参数名、每页数量等。
总的来说,PageHelper
通过拦截器机制、ThreadLocal
存储分页参数以及自动构建分页SQL来实现对MyBatis的分页支持,而pagehelper-spring-boot-starter
则在Spring Boot中简化了PageHelper
的集成和配置过程。
实战
下面是一个简单的示例,演示如何在Spring Boot项目中使用pagehelper-spring-boot-starter
来实现分页查询:
1. 添加依赖
首先,在pom.xml
文件中添加pagehelper-spring-boot-starter
的依赖:
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>{version}</version>
</dependency>
2. 配置属性
在application.properties
或application.yml
中配置pagehelper
相关属性,例如:
# PageHelper配置
pagehelper.helperDialect=mysql
pagehelper.reasonable=true
pagehelper.supportMethodsArguments=true
pagehelper.params=count=countSql
3. 编写Mapper接口和XML文件
编写MyBatis的Mapper接口和对应的XML文件,定义分页查询的方法。
4. 在Service中调用分页查询
在Service类中调用分页查询方法,示例代码如下:
@Service
public class UserService {
@Autowired
private UserMapper userMapper;
public PageInfo<User> findUsers(int pageNum, int pageSize) {
PageHelper.startPage(pageNum, pageSize);
List<User> userList = userMapper.selectUsers();
return new PageInfo<>(userList);
}
}
5. Controller层调用Service进行分页查询
在Controller层调用Service中的方法进行分页查询,并返回分页结果给前端。示例代码如下:
@RestController
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/users")
public PageInfo<User> getUsers(@RequestParam("pageNum") int pageNum, @RequestParam("pageSize") int pageSize) {
return userService.findUsers(pageNum, pageSize);
}
}
通过以上步骤,你就可以在Spring Boot项目中使用pagehelper-spring-boot-starter
来实现分页查询功能。记得根据具体的业务需求和数据库类型配置相应的pagehelper
属性。