PageHelper 分页插件加依赖加配置使用
加依赖
com.github.pagehelper
pagehelper-spring-boot-starter
1.2.5
加配置
pagehelper:
# 类型
helperDialect: mysql
reasonable: true
supportMethodsArguments: true
pageSizeZero: true
params: count=countSql
使用
// 设置分页
Page page = PageHelper.startPage(pageEntity.
PageHelper是Java开发中常用的MyBatis分页插件，尤其在Spring Boot项目中，它极大地简化了数据库分页查询的实现。以下是对PageHelper分页插件的详细说明：
**1. 插件介绍**
PageHelper是针对MyBatis进行优化的一个插件，其主要功能是提供自动的分页处理。在传统的MyBatis中，我们需要手动添加分页SQL，而PageHelper通过拦截器的方式，自动在查询语句后面添加分页条件，降低了代码的复杂性，提高了开发效率。
**2. 添加依赖**
在Spring Boot项目中，添加PageHelper依赖非常简单。需要在`pom.xml`文件中引入`pagehelper-spring-boot-starter`，如下所示：
```xml
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.5</version>
</dependency>
```
确保版本号与项目兼容，因为随着时间的推移，新版本可能会包含更多的功能和修复。
**3. 配置**
在`application.properties`或`application.yml`文件中，配置PageHelper的相关参数。以下是一些基本配置示例：
```properties
# application.properties 示例
pagehelper.helperDialect=mysql
pagehelper.reasonable=true
pagehelper.supportMethodsArguments=true
pagehelper.pageSizeZero=true
pagehelper.params=count=countSql
```
- `helperDialect`: 指定数据库方言，如mysql、postgresql等。
- `reasonable`: 是否开启合理化处理，如果为true，当设置的页码大于实际总页数时，会返回实际的最后一页数据。
- `supportMethodsArguments`: 是否支持通过Map传入start, end进行分页。
- `pageSizeZero`: 当设置分页大小为0时，是否返回所有数据，默认为false，设置为true则返回所有数据。
- `params`: 自定义参数配置，例如`count=countSql`表示统计SQL使用`countSql`作为计数查询。
**4. 使用方法**
在代码中，可以使用PageHelper提供的`startPage()`方法来启动分页，然后进行正常的查询操作。下面是一个简单的使用示例：
```java
// 创建Page对象，通常是从请求参数中获取页码和每页数量
PageHelper.Page(pageEntity.getPage(), pageEntity.getLimit());
// 正常执行查询，不需要手动添加分页条件
List<Project> list = projectDao.getProject(map);
// 获取总记录数
long total = new PageInfo<>(list).getTotal();
```
在上述例子中，`pageEntity`通常包含了页码和每页数量的信息，`projectDao.getProject(map)`是你实际的查询方法，`map`可能包含了查询条件。PageHelper会自动处理分页逻辑，返回的结果集`list`已经是分页后的结果，而`total`则是总记录数。
PageHelper分页插件通过简单的配置和调用，即可实现复杂的分页功能，使得开发者可以更专注于业务逻辑，而不是分页细节。在实际开发中，它是一个非常实用的工具，极大地提升了开发效率和代码的可维护性。
