分页插件PageHelper配置步骤(mybatis)
https://blog.csdn.net/houysx/article/details/80229991
https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/Changelog.md#504---2017-08-01
原理:
mybatis执行sql步骤:
通过sqlsessionFactory sqlsession Exector (执行器对象)mappedstatement(sql语句封装)
在执行mappedstatement前在sql语句上加上limit即可实现分页
步骤:
一、引入pageHelper的jar包
二、在mybatis的xml文件中配置分页插件
<!-- plugins在配置文件中的位置必须符合要求,否则会报错,顺序如下: properties?, settings?, typeAliases?, typeHandlers?, objectFactory?,objectWrapperFactory?, plugins?, environments?, databaseIdProvider?, mappers? --> <plugins> <!-- com.github.pagehelper为PageHelper类所在包名 --> <plugin interceptor="com.github.pagehelper.PageHelper"> <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"/> </plugin> </plugins>
这里的com.github.pagehelper.PageHelper使用完整的类路径。
其他五个参数说明:
- 增加dialect属性,使用时必须指定该属性,可选值为oracle,mysql,mariadb,sqlite,hsqldb,postgresql,没有默认值,必须指定该属性。
- 增加offsetAsPageNum属性,默认值为false,使用默认值时不需要增加该配置,需要设为true时,需要配置该参数。当该参数设置为true时,使用RowBounds分页时,会将offset参数当成pageNum使用,可以用页码和页面大小两个参数进行分页。
- 增加rowBoundsWithCount属性,默认值为false,使用默认值时不需要增加该配置,需要设为true时,需要配置该参数。当该参数设置为true时,使用RowBounds分页会进行count查询。
- 增加pageSizeZero属性,默认值为false,使用默认值时不需要增加该配置,需要设为true时,需要配置该参数。当该参数设置为true时,如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果(相当于没有执行分页查询,但是返回结果仍然是Page类型)。
- 增加reasonable属性,默认值为false,使用默认值时不需要增加该配置,需要设为true时,需要配置该参数。具体作用请看上面配置文件中的注释内容。
也可以在spring的xml文件中配置
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <property name="dataSource" ref="dataSource"/> <property name="mapperLocations"> <array> <value>classpath:mapper/*.xml</value> </array> </property> <property name="typeAliasesPackage" value="com.isea533.ssm.model"/> <property name="plugins"> <array> <bean class="com.github.pagehelper.PageHelper"> <property name="properties"> <value> dialect=hsqldb reasonable=true </value> </property> </bean> </array> </property> </bean>
三、配置完成后再调用类中配置分页属性:
步骤: 只需将查询的条件放入PageInfo中,设置分页属性即可
//查询所需数据条件 List<TbItem> list = ibItemMapper.selectByExample(new TbItemExample()); //设置分页信息(第几页,每页数量) PageHelper.startPage(pageNum, pageSize); //取记录总条数 PageInfo<TbItem> pageInfo = new PageInfo<>(list); long sum = pageInfo.getTotal();
原理: 执行自定义( 例如 :ibItemMapper.selectByExample(new TbItemExample())) 查询语句时,
会在mappedstatement执行前将分页的sql语句追加到查询语句后。
page的一些属性:
page.getPageNum(); page.getPageSize(); page.getStartRow(); page.getEndRow(); page.getTotal(); page.getPages(); page.getFirstPage(); page.getLastPage(); page.isFirstPage(); page.isLastPage(); page.isHasPreviousPage(); page.isHasNextPage();
注意事项:
-
PageHelper.startPage方法后的一个个查询方法才会被分页。
- 不支持带有for update的语句分页。
- 不支持关联结果查询。