PageHelper分页在Mybatis中的应用

最新推荐文章于 2024-09-27 15:11:01 发布

hao_hl1314

最新推荐文章于 2024-09-27 15:11:01 发布

阅读量1.1k

点赞数

分类专栏： Mybatis 文章标签： mybatis 框架插件开源应用

Mybatis 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

好多天没写博客了，因为最近在实习，大部分时间在熟悉实习相关的东西，也没有怎么学习新的东西，这周末学习了MyBatis的一个分页插件PageHelper，虽然没有那么的强大（我在最后会说明它的缺点），但还是挺不错的。这篇博文主要来总结下如何使用PageHelper。
　　我们知道，在MySQL中，分页的sql是使用limit来做，如果我们自己写sql，那分页肯定是没有任何问题的。但是一旦model多了起来，复杂了起来，我们很自然的想到使用mybatis的逆向工程来生成相应的po和mapper，但是同时也会带来弊端，比如这里的分页问题就不好解决了。
　　可能有人会说，我可以修改生成的文件，没错，这是可行的，但是一般我们通过逆向工程生成的文件，都不会去动它，所以这个时候，就需要使用分页插件来解决了。在介绍如何使用这个分页插件之前，先介绍一下mybatis中的插件是如何工作的，主要作用在哪个环节。我之前有写过一篇mybatis的一篇入门文章：宏观上把我mybatis框架。里面有张mybatis的工作原理图，为了方便叙述，我把图也放在这：
这里写图片描述

　　从图中可以看出，mybatis中首先要在配置文件中配置一些东西，然后根据这些配置去创建一个会话工厂，再根据会话工厂创建会话，会话发出操作数据库的sql语句，然后通过执行器操作数据，再使用mappedStatement对数据进行封装，这就是整个mybatis框架的执行情况。那么mybatis的插件作用在哪一环节呢？它主要作用在Executor执行器与mappedeStatement之间，也就是说mybatis可以在插件中获得要执行的sql语句，在sql语句中添加limit语句，然后再去对sql进行封装，从而可以实现分页处理。
　　搞清楚了分页插件的执行情况，下面来总结下mybatis中PageHelper的使用。

1. 需要引入PageHelper的jar包

　　如果没有使用maven，那直接把jar包导入到lib文件夹下即可，这个PageHelper插件在github上有开源，地址为：https://github.com/pagehelper/Mybatis-PageHelper/tree/master/src/main/java/com/github/pagehelper。
如果使用了maven，那么只要在pom.xml中引入该插件即可，引入如下：

<code class="language-xml hljs  has-numbering"><span class="hljs-tag"><<span class="hljs-title">dependency</span>></span>
    <span class="hljs-tag"><<span class="hljs-title">groupId</span>></span>com.github.pagehelper<span class="hljs-tag"></<span class="hljs-title">groupId</span>></span>
    <span class="hljs-tag"><<span class="hljs-title">artifactId</span>></span>pagehelper<span class="hljs-tag"></<span class="hljs-title">artifactId</span>></span>
    <span class="hljs-tag"><<span class="hljs-title">version</span>></span>4.1.4<span class="hljs-tag"></<span class="hljs-title">version</span>></span>
<span class="hljs-tag"></<span class="hljs-title">dependency</span>></span></code>

2. 在mybatis的全局配置文件SqlMapConfig.xml中配置该插件

<code class="language-xml hljs  has-numbering"><span class="hljs-pi"><?xml version="1.0" encoding="UTF-8" ?></span>
<span class="hljs-doctype"><!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd"></span>
<span class="hljs-tag"><<span class="hljs-title">configuration</span>></span>
    <span class="hljs-comment"><!-- 配置分页插件 --></span>
    <span class="hljs-tag"><<span class="hljs-title">plugins</span>></span>
        <span class="hljs-tag"><<span class="hljs-title">plugin</span> <span class="hljs-attribute">interceptor</span>=<span class="hljs-value">"com.github.pagehelper.PageHelper"</span>></span>
            <span class="hljs-comment"><!-- 设置数据库类型 Oracle,Mysql,MariaDB,SQLite,Hsqldb,PostgreSQL六种数据库--></span>        
            <span class="hljs-tag"><<span class="hljs-title">property</span> <span class="hljs-attribute">name</span>=<span class="hljs-value">"dialect"</span> <span class="hljs-attribute">value</span>=<span class="hljs-value">"mysql"</span>/></span>
        <span class="hljs-tag"></<span class="hljs-title">plugin</span>></span>
    <span class="hljs-tag"></<span class="hljs-title">plugins</span>></span>

<span class="hljs-tag"></<span class="hljs-title">configuration</span>></span></code>

3. 在执行sql前添加插件，完成分页功能

　　在查询的sql语句执行之前，添加一行代码PageHelper.startPage(1, 10);第一个参数表示第几页，第二个参数表示每页显示的记录数。这样在执行sql后就会将记录按照语句中设置的那样进行分页。如果需要获取总记录数的话，需要PageInfo类的对象，这个对象可以获取总记录数，下面看下测试的代码。

<code class="language-java hljs  has-numbering"><span class="hljs-keyword"></span></code><pre class="prettyprint" name="code"><code class="language-java hljs  has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">TestPageHelper</span> {</span>

    <span class="hljs-annotation">@Test</span>
    <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">testPageHelper</span>() {
        <span class="hljs-comment">// 创建一个spring容器</span>
        ApplicationContext context = <span class="hljs-keyword">new</span> ClassPathXmlApplicationContext(<span class="hljs-string">"classpath:spring/applicationContext-*"</span>);
        <span class="hljs-comment">// 从spring容器中获取mapper代理对象</span>
        TbItemMapper mapper = context.getBean(TbItemMapper.class);
        <span class="hljs-comment">// 执行查询并分页,TbItemExample是逆向工程自动生成的，用来进行条件查询，这里不设置则表示无条件</span>
        TbItemExample example = <span class="hljs-keyword">new</span> TbItemExample();
        <span class="hljs-comment">//分页处理，显示第一页的10条数据</span>
        PageHelper.startPage(<span class="hljs-number">1</span>, <span class="hljs-number">10</span>);
        List<TbItem> list = mapper.selectByExample(example);<span class="hljs-comment">//查询</span>
        <span class="hljs-comment">// 取商品列表</span>
        <span class="hljs-keyword">for</span>(TbItem item : list) {
            System.out.println(item.getTitle());
        }
        <span class="hljs-comment">// 取分页信息</span>
        PageInfo<TbItem> pageInfo = <span class="hljs-keyword">new</span> PageInfo<TbItem>(list);
        <span class="hljs-keyword">long</span> total = pageInfo.getTotal(); <span class="hljs-comment">//获取总记录数</span>
        System.out.println(<span class="hljs-string">"共有商品信息："</span> + total);
    }
}</code>

看下执行的结果：

夏普（SHARP）LCD-46DS40A 46英寸日本原装液晶面板智能全高清液晶电视
飞利浦老人手机 (X2560) 深情蓝移动联通2G手机双卡双待
中兴 U288 珠光白移动3G手机
三星 SCH-W899 亮金色电信3G手机双卡双待双通
飞利浦老人手机 (X2560) 喜庆红移动联通2G手机双卡双待
飞利浦老人手机 (X2560) 硬朗黑移动联通2G手机双卡双待
三星 Galaxy S4 (I9500)16G版皓月白联通3G手机
三星 Galaxy S4 (I9500) 16G版星空黑联通3G手机
三星 I8552 白色联通3G手机双卡双待
长虹（CHANGHONG） 3D51C1080i 51英寸快门式3D智能Android 电视（黑色）
共有商品信息：3096

　　可以看到，只显示出了10条数据，但是我总共有3096条数据，如果将参数改成(2,10)，那么就会显示第二页不同的10条数据，在这就不测试了。这说明PageHelper插件可以帮助我们实现分页功能，例如EasyUI中就会传到后台分页参数信息，后台就可以根据参数获取分页数据等等。
　　正如前面所说，这个PageHelper其实也有缺点，因为它对逆向工程生成的代码支持不好，不能对有查询条件的查询分页，会抛异常，上面是无条件查询的。当然，我们自己可以修改这个PageHelper插件，使其支持条件查询，当然，我是修改不了的……网上有修改过后的PageHelper插件，可以支持条件查询，相对来说就比较强大了，可以在自己的工程中依赖修改过后的分页插件进行开发。