SSM -- Mybatis 插件Pagehelper使用

https://pagehelper.github.io/官方文档的介绍很详细，可以参考文档自己配置。

这里简单的做了个使用流程的介绍，详细资料参考官方文档。

注：PageHelper是针对于Mybatis的一个分页插件。

1、插件的引入

我这里只写了基于maven的，可以去官网查看其它的方式

在 pom.xml 中添加如下依赖：

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

2、拦截器的配置

在mybatis的配置文件中，配置一个拦截器，注意其他配置的顺序不能出错

 <!-- 访问持久层，这个插件会自动完成SQL语句的修改 -->
<plugins>
    <!-- com.github.pagehelper为PageHelper类所在包名 -->
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <!-- 使用下面的方式配置参数，后面会有所有的参数介绍，可写可不写，不写就是默认的 -->
        <!--pageSize为0 显示全部-->
        <property name="pageSizeZero" value="true"/>
        <!--分页的合理化-->
        <property name="reasonable" value="true"/>
	</plugin>
</plugins>

方式二（未测）

<!--pageHelper Spring.xml中实现-->
<!--SqlSession 自动生成mapper 接口代理对象-->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <!--<property name="mapperLocations" value="classpath:mapper/*.xml"/>-->
        <property name="configLocation" value="classpath:Mybatis-Config.xml"/>
        <property name="plugins">
            <array>
                <bean class="com.github.pagehelper.PageInterceptor">
                    <property name="properties">
                        <value>
                            pageSizeZero = true
                            reasonable = true
                        </value>
                    </property>
                </bean>
            </array>
        </property>
    </bean>

有许多自带的参数，可以去官方文档详细了解，这里我截取了官方部分文档用作参考

helperDialect：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。 你可以配置helperDialect属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值：oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby特别注意：使用 SqlServer2012 数据库时，需要手动指定为 sqlserver2012，否则会使用 SqlServer2005 的方式进行分页。你也可以实现 AbstractHelperDialect，然后配置该属性为实现类的全限定名称即可使用自定义的实现方法。

pageSizeZero：默认值为 false，当该参数设置为 true 时，如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果（相当于没有执行分页查询，但是返回结果仍然是 Page 类型）。

reasonable：分页合理化参数，默认值为false。当该参数设置为 true 时，pageNum<=0 时会查询第一页， pageNum>pages（超过总数时），会查询最后一页。默认false 时，直接根据参数进行查询。

实现也有很多的方法，我采用了Mapper接口方式的调用

//介绍一下常用的属性
pageNum  //当前页
pageSize //页面数量
startRow //第一个数据元素的行号 首页
endRow   //最后一个数据元素  尾页
pages	 //总页数
total    //数据条目，总记录数

3、业务层的实现

新增一个分页查询的业务 Service层

// 分页查询 page当前页页码 pageSize页面数据条目
List<Users> getUsersByPage(int page,int pageSize);

//Service接口的实现
 @Override
    public List<Users> getUsersByPage(int page, int pageSize) {
        //开启pagehelper插件支持
        PageHelper.startPage(page,pageSize);
        return userMapper.getUsersAll();
}

//Controller 层的实现 
public ResponseMessage usersList(){
        List<Users> usersList = userService.getUsersByPage(1,5);
        //获取分页信息
        PageInfo pageinfo = new PageInfo(usersList);
        return  responseMessage.success()
                .addObject("UsersList",usersList)
                .addObject("pages",pageinfo.getPages());
    };
//ResponseMessage 是我自定义的返回状态工具类
//pageinfo.getPages() 获取页数；类似方法很多可以和上面介绍的属性对应