pagehelper原理:拦截后面第一条执行sql查询的语句,添加如mysql的limit分页关键词与分页参数,并顺带生成一个查询总数的sql。优点:封装分页sql,使我们不需要每个地方都去写分页的查询语句;同时,使我们select的sql语句向下兼容,换了数据库也不需要更改sql分页代码。
一。pom.xml中添加依赖:
<!-- https://mvnrepository.com/artifact/com.github.pagehelper/pagehelper-spring-boot-starter -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.10</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.6</version>
<scope>provided</scope>
</dependency>
二。application.properties中添加配置:
## pagehelper分页插件配置 ##
#标识是哪一种数据库
pagehelper.helperDialect=mysql
#启用合理化,如果pageNum<1会查询第一页,如果pageNum>pages会查询最后一页
pagehelper.reasonable=true
#为了支持startPage(Object params)方法,增加了该参数来配置参数映射,用于从对象中根据属性名取值, 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值, 默认值为pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero
pagehelper.params=count=countSql
#支持通过 Mapper 接口参数来传递分页参数,默认值false,分页插件会从查询方法的参数值中,自动根据上面 params 配置的字段中取值,查找到合适的值时就会自动分页
pagehelper.supportMethodsArguments=true
#如果 pageSize=0 就会查询出全部的结果(相当于没有执行分页查询)
pagehelper.page-size-zero=true
三。代码中使用(伪代码):
3.1 ServiceMock业务逻辑层分页查询:
package demo.page;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.springframework.stereotype.Service;
import java.util.ArrayList;
import java.util.List;
/**
* description:
* author: yangzihe
* date: 2019-04-02 09:58
**/
@Service
public class ServiceMock {
public HttpResponse getAll(int pageNum, int pageSize) {
//排序实现: 数据库字段 + " desc" 或 数据库字段 + " asc"
//PageHelper.startPage(1, 10, "create_time desc");
PageHelper.startPage(pageNum, pageSize);
//List<User> userList = daoMock.selectAll();
List<User> userList = new ArrayList<>();
PageInfo<User> userPageInfo = new PageInfo<>(userList);
Page<User> userPage = new Page<>(userPageInfo);
HttpResponse httpResponse = new HttpResponse(0, "查询成功", userPage);
System.out.println(httpResponse);
return httpResponse;
}
}
其中,User是自定义的实体对象,PageInfo是PageHelper提供的分页对象,属性介绍如下:
//当前页
private int pageNum;
//每页的数量
private int pageSize;
//当前页的数量
private int size;
//当前页面第一个元素在数据库中的行号
private int startRow;
//当前页面最后一个元素在数据库中的行号
private int endRow;
//总记录数
private long total;
//总页数
private int pages;
//结果集
private List<T> list;
//第一页
private int firstPage;
//前一页
private int prePage;
//是否为第一页
private boolean isFirstPage;
//是否为最后一页
private boolean isLastPage;
//是否有前一页
private boolean hasPreviousPage;
//是否有下一页
private boolean hasNextPage;
//导航页码数
private int navigatePages;
//所有导航页号
private int[] navigatepageNums;
Page是自定义的分页对象,属性介绍如下:
package demo.page;
import com.github.pagehelper.PageInfo;
import lombok.Data;
import lombok.ToString;
import java.util.List;
/**
* description: 自定义分页对象
* author: yangzihe
* date: 2019-04-02 09:23
**/
@ToString
@Data
public class Page<T> {
private int pageNum;//当前页数
private int pageSize;//页大小
private int totalSize;//总页数
private List<T> list;
public Page(PageInfo<T> pageInfo) {
this.pageNum = pageInfo.getPageNum();
this.pageSize = pageInfo.getPageSize();
this.totalSize = pageInfo.getPages();
this.list = pageInfo.getList();
}
}
HttpResponse是自定义的http接口响应对象,属性如下:
package demo.page;
import lombok.Data;
import lombok.ToString;
/**
* description:
* author: yangzihe
* date: 2019-04-02 09:34
**/
@ToString
@Data
public class HttpResponse<T> {
private int code;
private String message;
private T data;
public HttpResponse(int code, String message, T data) {
this.code = code;
this.message = message;
this.data = data;
}
}