mybatis分页工具PageHelper

.资源

源码地址
https://github.com/pagehelper/Mybatis-PageHelper
说明文档：
https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md

.使用

1.pom引入

<properties>
...
    <!-- mybites 分页工具 -->
    <mybites.pagehelper>4.1.2</mybites.pagehelper>
...
</properties>

<dependencies>
...
<dependency>
   <groupId>com.github.pagehelper</groupId>
   <artifactId>pagehelper</artifactId>
   <version>${mybites.pagehelper}</version>
</dependency>
...
</dependencies>

2.配置文件 （一般放在mybatis的配置文件里就可以了）

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<plugins>
    <!-- com.github.pagehelper为PageHelper类所在包名 -->
    <plugin interceptor="com.github.pagehelper.PageHelper">
        <!-- 4.0.0以后版本可以不设置该参数 -->
        <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="false"/>
        <!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->
        <!-- 增加了一个`params`参数来配置参数映射，用于从Map或ServletRequest中取值 -->
        <!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值 -->
        <!-- 不理解该含义的前提下，不要随便复制该配置 -->
        <property name="params" value="pageNum=start;pageSize=limit;"/>
    </plugin>
</plugins>
</configuration>

这个配置文件需要注册在bean里：

    <!-- 与mybatis集成  -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="multipleDataSource"></property>
        <property name="configLocation" value="classpath:mybatis-config.xml"></property>
        <!-- mybatis配置文件自动扫描路径  -->
        <property name="mapperLocations" value="classpath:com/wx/app/sgp/dao/**/*.xml"></property>
    </bean>

上面的配置说明很清晰了
3.代码使用
下面代码里直接使用就行了，比如PageHelper.startPage(1,10);
这些在作者托管代码的md文件里都有，注意下分页安全。

总结：
相比较于通用Mapper，个人认为pagehelper这个工具还是不错的，侵入性比较低，代码量、配置量都不多，可以方便使用。通用mapper小一点的项目我觉得还是没必要用了。

补充：
以springboot为基础，可参考springboot整合mybatis