Mybatis分页插件-PageHelper简介

分页插件参数介绍

  1. dialect:默认情况下会使用 PageHelper 方式进行分页,如果想要实现自己的分页逻辑,可以实现
    Dialect(com.github.pagehelper.Dialect) 接口,然后配置该属性为实现类的全限定名称。
    下面几个参数都是针对默认 dialect 情况下的参数。使用自定义 dialect 实现时,下面的参数没有任何作用。
  2. helperDialect:分页插件会自动检测当前的数据库链接,自动选择合适的分页方式。
    你可以配置helperDialect属性来指定分页插件使用哪种方言。配置时,可以使用下面的缩写值:
    oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby
    特别注意:使用 SqlServer2012 数据库时,需要手动指定为 sqlserver2012,否则会使用 SqlServer2005
    的方式进行分页。 你也可以实现 AbstractHelperDialect,然后配置该属性为实现类的全限定名称即可使用自定义的实现方法。
  3. offsetAsPageNum:默认值为 false,该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置为 true
    时,会将 RowBounds 中的 offset 参数当成 pageNum 使用,可以用页码和页面大小两个参数进行分页。
  4. rowBoundsWithCount:默认值为false,该参数对使用 RowBounds 作为分页参数时有效。
    当该参数设置为true时,使用 RowBounds 分页会进行 count 查询。
  5. pageSizeZero:默认值为 false,当该参数设置为 true 时,如果 pageSize=0 或者
    RowBounds.limit = 0 就会查询出全部的结果(相当于没有执行分页查询,但是返回结果仍然是 Page 类型)。
  6. reasonable:分页合理化参数,默认值为false。当该参数设置为 true 时,pageNum<=0 时会查询第一页,
    pageNum>pages(超过总数时),会查询最后一页。默认false 时,直接根据参数进行查询。
  7. params:为了支持startPage(Object params)方法,增加了该参数来配置参数映射,用于从对象中根据属性名取值,
    可以配置 pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值,
    默认值为pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。
  8. supportMethodsArguments:支持通过 Mapper
    接口参数来传递分页参数,默认值false,分页插件会从查询方法的参数值中,自动根据上面 params
    配置的字段中取值,查找到合适的值时就会自动分页。 使用方法可以参考测试代码中的
    com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和
    ArgumentsObjTest。
  9. autoRuntimeDialect:默认值为 false。设置为 true 时,允许在运行时根据多数据源自动识别对应方言的分页
    (不支持自动选择sqlserver2012,只能使用sqlserver),用法和注意事项参考下面的场景五。
  10. closeConn:默认值为 true。当使用运行时动态数据源或没有设置 helperDialect
    属性自动获取数据库类型时,会自动获取一个数据库连接, 通过该属性来设置是否关闭获取的这个连接,默认true关闭,设置为 false
    后,不会关闭获取的连接,这个参数的设置要根据自己选择的数据源来决定。

重要提示:
当 offsetAsPageNum=false 的时候,由于 PageNum 问题,RowBounds查询的时候 reasonable 会强制为 false。使用 PageHelper.startPage 方法不受影响。

原文地址:https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md

猜你喜欢

转载自blog.csdn.net/wanzhix/article/details/78923519