SpringBoot框架中集成了TKMybatis+PageHelper实现高效查询和分页。
Mybatis 通用 Mapper 极其方便的使用 Mybatis 单表的增删改查,支持单表操作,不支持通用的多表联合查询
优点:
(1)通用 Mapper 可以极大的方便开发人员。(2)通用 Mapper 可以缓存,全部针对单表操作,每个实体类都需要继承通用 Mapper 接口来获得通用方法。
接下来开始学习PageHelper
1、首先需要在pom文件中加入:
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>4.0.0</version>
</dependency>
2、配置文件mybatis-config.xml中加入如下配置:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<settings>
<!-- 对在此配置文件下的所有cache 进行全局性开/关设置。 -->
<setting name="cacheEnabled" value="true"/>
<!-- 全局性设置懒加载。如果设为‘false’,则所有相关联的都会被初始化加载。 -->
<setting name="lazyLoadingEnabled" value="true"/>
<!-- 允许和不允许单条语句返回多个数据集(取决于驱动需求) -->
<setting name="multipleResultSetsEnabled" value="true"/>
<!-- 使用列标签代替列名称。不同的驱动器有不同的作法。参考一下驱动器文档,或者用这两个不同的选项进行测试一下。 -->
<setting name="useColumnLabel" value="true"/>
<!-- 配置和设定执行器,SIMPLE 执行器执行其它语句。REUSE 执行器可能重复使用prepared statements 语句,BATCH执行器可以重复执行语句和批量更新。 -->
<setting name="defaultExecutorType" value="REUSE"/>
<!-- 设置一个时限,以决定让驱动器等待数据库回应的多长时间为超时 -->
<setting name="defaultStatementTimeout" value="25000"/>
<!-- 允许JDBC 生成主键。需要驱动器支持。如果设为了true,这个设置将强制使用被生成的主键,有一些驱动器不兼容不过仍然可以执行。 -->
<setting name="useGeneratedKeys" value="false" />
<!-- 配置和设定执行器,SIMPLE 执行器执行其它语句。REUSE 执行器可能重复使用prepared statements 语句,BATCH执行器可以重复执行语句和批量更新。 -->
<setting name="defaultExecutorType" value="SIMPLE" />
<!-- 映射空字段 -->
<setting name="callSettersOnNulls" value="true"/>
</settings>
<plugins>
<!-- com.github.pagehelper为PageHelper类所在包名 -->
<plugin interceptor="com.github.pagehelper.PageHelper">
<!-- 4.0.0以后版本可以不设置该参数 -->
<property name="dialect" value="mysql"/>
<!-- 该参数默认为false -->
<!-- 设置为true时,会将RowBounds第一个参数offset当成pageNum页码使用 -->
<!-- 和startPage中的pageNum效果一样-->
<property name="offsetAsPageNum" value="true"/>
<!-- 该参数默认为false -->
<!-- 设置为true时,使用RowBounds分页会进行count查询 -->
<property name="rowBoundsWithCount" value="true"/>
<!-- 设置为true时,如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果 -->
<!-- (相当于没有执行分页查询,但是返回结果仍然是Page类型)-->
<property name="pageSizeZero" value="true"/>
<!-- 3.3.0版本可用 - 分页参数合理化,默认false禁用 -->
<!-- 启用合理化时,如果pageNum<1会查询第一页,如果pageNum>pages会查询最后一页 -->
<!-- 禁用合理化时,如果pageNum<1或pageNum>pages会返回空数据 -->
<property name="reasonable" value="true"/>
<!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->
<!-- 增加了一个`params`参数来配置参数映射,用于从Map或ServletRequest中取值 -->
<!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,orderBy,不配置映射的用默认值 -->
<!-- 不理解该含义的前提下,不要随便复制该配置 -->
<property name="params" value="pageNum=start;pageSize=limit;"/>
<!-- 支持通过Mapper接口参数来传递分页参数 -->
<property name="supportMethodsArguments" value="true"/>
<!-- always总是返回PageInfo类型,check检查返回类型是否为PageInfo,none返回Page -->
<property name="returnPageInfo" value="check"/>
</plugin>
</plugins>
</configuration>
目前Pagehelper插件支持Oracle,Mysql,MariaDB,SQLite,Hsqldb,PostgreSQL六种数据库分页,不同数据库只需要修改helperDialect就行。
3、java代码中的使用如下:
PageHelper.startPage(page, rows);
List<Map> list = testService.find(); //获取数据
PageInfo<Map> pageInfo = new PageInfo<>(list);
第一行是设置页数和每页显示几条,插件会自动对接下来的sql语句加上分页方式。PageInfo中是分页的一些信息,包括总页数,当前页,总数据等。
PageInfo也可以这样设置:
PageInfo<T> findPage(T t, Integer pageNum, Integer pageSize);
demo:根据前台传来page参数,来进行分页。
(1)根据前台page参数传递来返回分页信息
pageNo: 1, pageSize: 10,
(2)后台返回
/**
* 主页面分页查询方法
* @param map
* @param request
* @param response
* @return
*/
@RequestMapping(value="/getCommodity")
@ResponseBody
public PageInfo<Map<String, Object>> getCommodityList(@RequestBody Map<String,Object> map,HttpServletRequest request, HttpServletResponse response){
int pageNo = Integer.parseInt(map.get("pageNo") + "");
int pageSize = Integer.parseInt(map.get("pageSize") + "");
PageHelper.startPage(pageNo, pageSize);
PageInfo<Map<String, Object>> page = new PageInfo(userService.getCommodity(map));
return page;
}
(3)前台接收page数据来显示
第一种:使用jQuery分页插件pagination.js
<div id="pages"></div>
$.pagination($("#pages"), result.total, result.pageSize, function(page, rows) {
/**
* jq : 分页栏放置jq对象
* total : 总记录数
* rows : 每页显示多少条
* jumpPageFun :点具体页或者跳页执行函数 (page,rows)
* currPage : 当前页 默认1 默认第几页选中
*/
})
第二种:使用bootstrap-paginator.js 分页插件
扩展说明:如果遇到返回List数据变成分页时,只需要传page参数就行。