首页 > 技术文章 > 分页插件-PageHelper

baierhu 2020-05-27 21:13 原文

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

分页指的前台页面需要多少条数据,就返回多少条数据,根据前台页面的要求返回具体的数据。

一般后台用到的sqL如下:转载于:https://blog.csdn.net/qq_38983577/article/details/82052525

sqlserver分页 
 第一种分页方法
 需用到的参数: 
 pageSize 每页显示多少条数据 
 pageNumber 页数 从客户端传来 
 totalRecouds 表中的总记录数 select count (*) from 表名 
 totalPages 总页数 
 totalPages=totalRecouds%pageSize==0?totalRecouds/pageSize:totalRecouds/pageSize+1 
 pages 计算前pages 条数据 
 pages= pageSize*(pageNumber-1) 
 SQL语句: 
 select top pageSize * from 表名 where id  not in (select top pages id from 表名 order by id) order by id 
 第二种分页方法
 pageSize 每页显示多少条数据 
 pageNumber 页数 从客户端传来
 pages=pageSize*(pageNumber-1)+1
 select top pageSize * from 表名 where id>=(select max(id) from (select top pages id from 表名 order by id asc ) t )
mysql分页 
 需用到的参数: 
 pageSize 每页显示多少条数据 
 pageNumber 页数 从客户端传来 
 totalRecouds 表中的总记录数 select count (*) from 表名 
 totalPages 总页数 
 totalPages=totalRecouds%pageSize==0?totalRecouds/pageSize:totalRecouds/pageSize+1 
 pages 起始位置 
 pages= pageSize*(pageNumber-1) 
 SQL语句: 
 select * from 表名 limit pages, pageSize; 
 mysql 分页依赖于关键字 limit 它需两个参数:起始位置和pageSize 
 起始位置=页大小*(页数-1) 
 起始位置=pageSize*(pageNumber -1) 
 
oracle分页
 pageSize 每页显示多少条数据 
 pageNumber 页数 从客户端传来 
 totalRecouds 表中的总记录数 select count (*) from 表名 
 totalPages 总页数 
 totalPages=totalRecouds%pageSize==0?totalRecouds/pageSize:totalRecouds/pageSize+1 
 startPage 起始位置 
 startPage= pageSize*(pageNumber-1)+1
 endPage=startPage+pageSize
 SQL语句
 select a.* from 
 (
   select rownum num ,t.* from  表名 t where 某列=某值 order by id asc 
 )a
 where a.num>=startPage and a.num<endPage
 
db2分页
 int startPage=1  //起始页
 int endPage;     //终止页
 int pageSize=5;  //页大小
 int pageNumber=1 //请求页
 
 startPage=(pageNumber-1)*pageSize+1 
 endPage=(startPage+pageSize);
 
 
 SQL语句
 select * from (select 字段1,字段2,字段3,字段4,字段5,rownumber() over(order by 排序字段 asc ) as rowid  from 表名 )as a where a.rowid >= startPage AND a.rowid <endPage
 
access分页
 pageSize 每页显示多少条数据 
 pageNumber 页数 从客户端传来
 pages=pageSize*(pageNumber-1)+1
 SQL语句
 select top pageSize * from 表名 where id>=(select max(id) from (select top pages id from 表名 order by id asc ) t )

使用pagehelper的方式如下:首先在导入pagehelperjar包,然后添加配置

一:导入jar包,

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

二:使用配置

  1:如果是mybatis项目,则在mybaits的xml中配置如下

         <plugins>  
              <!-- com.github.pagehelper为PageHelper类所在包名 -->
              <plugin interceptor="com.github.pagehelper.PageInterceptor"> 
              <!-- 使用下面的方式配置参数,后面会有所有的参数介绍 -->     
              <property name="param1" value="value1"/>  
              </plugin> 
        </plugins>

   

 2:如果是在spring项目中,配置如下:

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"></property>
        <property name="plugins">
            <array>
                <bean class="com.github.pagehelper.PageInterceptor">
                    <property name="properties">
                        <!--使用下面的方式配置参数,一行配置一个 -->
                        <props>
                            <!--配置方言和合理分页-->
                            <prop key="helperDialect">oracle</prop>
<!--指定要连接的数据库是oracle--> <prop key="reasonable">true</prop>
<!--指定合理分页,即当第一页的时候点击上一页还是第一页数据--> </props> </property> </bean> </array> </property> </bean>

三:使用方式

在service的实现类的具体查询方法上加上,比如:在service中调用dao层方法的时候在方法的上方加入PageHelper.startPage(page,pageSize),参数为第几页,每页多少条数据

 @Override
    public Orders findById(String id) throws Exception {
        //获取第1页,10条内容,默认查询总数count 
        // 紧跟着的第一个select方法会被分页
        PageHelper.startPage(1, 10);
        Orders orders= productDao.findOrderById(id);
        return orders;
    }

一般这两个参数是前台传递过来的,这时方法如下:

 private IProductDao productDao;
    @Override
    public List<Orders> findAll(int page,int size) {
        PageHelper.startPage(page,size);
        List<Orders> list= productDao.findAll();
        return list;
    }

controller举例:默认值为第一页的值!

  @Autowired
    private IOrderService iOrderService;
    @RequestMapping("/findAll.do")
    public ModelAndView findAll(@RequestParam(name = "page", required = true, defaultValue = "1") int page, @RequestParam(name = "size", required = true, defaultValue = "4") int size){
        List<Orders> orders= iOrderService.findAll(page,size);
        System.out.println(page+"=="+size);

        PageInfo pageInfo=new PageInfo(orders);
        ModelAndView modelAndView=new ModelAndView();
        modelAndView.setViewName("orders-list");
        System.out.println(orders+"======");
        modelAndView.addObject("ordersList",pageInfo);
        return modelAndView;
    }

到此分页查询功能ok。

有可能用到的参数如下:

1. 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 后,不会关闭获取的连接,这个参数的设置要根据自己选择的数据源来决定

 

推荐阅读