PageHelper 分页插件

一、PageHelper的介绍
PageHelper是国内非常优秀的一款开源的mybatis分页插件,它支持基本主流与常用的数据库,例如mysql、oracle、mariaDB、DB2、SQLite、Hsqldb等。

PageHelper以我目前浅浅的了解是:其本质是封装了一个pagebean类,我们所查询传递过来的currentpage(当前页)和pagesize(每页要显示的条数)封装到一个bean类中,在这个框架中的这个类是 PageInfo 。里面有当前的页数、当前页的记录数、总页数、总的记录数、每页显示的数据的集合等等其他的。

下面是在GitHub和码云上的更为详细的参考文档
本项目在 github 的项目地址
本项目在 gitosc 的项目地址

二、PageHelper入门使用
这个是在maven中的使用,使用的是SSM的框架,下面是一个简单搭建PageHelper。
1、在pom.xml中添加如下依赖

<dependency>
	<groupId>com.github.pagehelper</groupId>
	<artifactId>pagehelper</artifactId>
	<version>5.1.2</version>
</dependency>

2、配置

注意:在 MyBatis 配置 xml 中配置拦截器插件 和 在 Spring 配置文件中配置拦截器插件,只需要在使用一个配置就可以,二者选其一就可以了。

2.2.1、在 MyBatis 配置 xml 中配置拦截器插件

<!--
	plugins在配置文件中的位置必须符合要求,否则会报错,顺序如下:
	properties?, settings?,
	typeAliases?, typeHandlers?,
	objectFactory?,objectWrapperFactory?,
	plugins?,
	environments?, databaseIdProvider?, mappers?
-->
<plugins>
	<!-- com.github.pagehelper为PageHelper类所在包名 -->
	<plugin interceptor="com.github.pagehelper.PageInterceptor">
	<!-- 使用下面的方式配置参数,后面会有所有的参数介绍 -->
	<property name="param1" value="value1"/>
	</plugin>
</plugins>

2.2.2、在 Spring 配置文件中配置拦截器插件

<!-- 把交给IOC管理 SqlSessionFactory -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <!-- 传入PageHelper的插件 -->
        <property name="plugins">
            <array>
                <!--传入插件的对象-->
                <bean class="com.github.pagehelper.PageInterceptor">
                    <property name="properties">
                        <!--使用下面的方式配置参数,一行配置一个 -->
                        <props>
                            <!--分页插件会自动检测当前的数据库链接,自动选择合适的分页方式。
                             你可以配置  helperDialect 属性来指定分页插件使用哪种方言-->
                            <prop key="helperDialect">oracle</prop>
                            <!--分页合理化参数,默认值为false 。
                                当该参数设置为 true 时, pageNum<=0 时会查询第一页,
                                pageNum>pages (超过总数时),会查询最后一页。
                                默认false 时,直接根据参数进行查询。-->
                            <prop key="reasonable">true</prop>
                        </props>
                    </property>
                </bean>
            </array>
        </property>
    </bean>

2.2.3、基本使用
2.2.3.1、PageHelper.startPage 静态方法调用
这种方式是我们要掌握的 在你需要进行分页的 MyBatis 查询方法前调用PageHelper.startPage 静态方法即可,紧跟在这个方法后的第一个MyBatis 查询方法会被进行分页。
例:在service中的使用

//获取第1页,10条内容,默认查询总数count
PageHelper.startPage(1, 10);
//紧跟着的第一个select方法会被分页
List list = countryMapper.selectIf(1);

2.2.4、在controller中的使用

//查询所有的订单  --分页
@RequestMapping("/findAllFenYe.do")
public ModelAndView findAllFenYe(@RequestParam(name = "page", required = true, defaultValue = "1") Integer page, @RequestParam(name = "pageSize", required = true, defaultValue = "4") Integer pageSize) throws Exception{
    ModelAndView mv = new ModelAndView();

    List<Orders> orders=ordersService.findAllFenYe(page,pageSize);
    //PageInfo 就是一个分页的bean
    PageInfo pageInfo = new PageInfo(orders);

    mv.addObject("pageInfo",pageInfo);
    mv.setViewName("orders-page-list");

    return mv;
}

2.2.5、分页插件参数介绍

helperDialect :分页插件会自动检测当前的数据库链接,自动选择合适的分页方式。 你可以配置
helperDialect 属性来指定分页插件使用哪种方言。配置时,可以使用下面的缩写值:
oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver201
2 , derby
特别注意:使用 SqlServer2012 数据库时,需要手动指定为 sqlserver2012 ,否则会使用 SqlServer2005 的
方式进行分页。
你也可以实现 AbstractHelperDialect ,然后配置该属性为实现类的全限定名称即可使用自定义的实现方
法。
2. offsetAsPageNum :默认值为 false ,该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置为 true 时,会将 RowBounds 中的 offset 参数当成 pageNum 使用,可以用页码和页面大小两个参数进行分 页。
3. rowBoundsWithCount :默认值为false ,该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置 为true 时,使用 RowBounds 分页会进行 count 查询。
4. pageSizeZero :默认值为 false ,当该参数设置为 true 时,如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果(相当于没有执行分页查询,但是返回结果仍然是 Page 类型)。
5. reasonable :分页合理化参数,默认值为false 。当该参数设置为 true 时, pageNum<=0 时会查询第一 页, pageNum>pages (超过总数时),会查询最后一页。默认false 时,直接根据参数进行查询。
6. params :为了支持startPage(Object params) 方法,增加了该参数来配置参数映射,用于从对象中根据属 性名取值, 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable ,不配置映射的用默认值,
默认 值为
pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero

7. supportMethodsArguments :支持通过 Mapper 接口参数来传递分页参数,默认值false ,分页插件会从查 询方法的参数值中,自动根据上面 params 配置的字段中取值,查找到合适的值时就会自动分页。 使用方法 可以参考测试代码中的
com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和
ArgumentsObjTest 。
8. autoRuntimeDialect :默认值为 false 。设置为 true 时,允许在运行时根据多数据源自动识别对应方言 的分页 (不支持自动选择sqlserver2012 ,只能使用sqlserver ),用法和注意事项参考下面的场景五。
9. closeConn :默认值为 true 。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类 型时,会自动获取一个数据库连接, 通过该属性来设置是否关闭获取的这个连接,默认true 关闭,设置为 false
后,不会关闭获取的连接,这个参数的设置要根据自己选择的数据源来决定。

以上就是一个PageHelper的简单的介绍。非常感谢提供者框架的开发人员,这个框架节省了我们很多代码的编写,而且非常好用。无限崇拜!!!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章