Mybatis插件-PageHelper的使用

一.PageHelper介绍

PageHelper是国内非常优秀的一款开源的mybatis分页插件，它支持基本主流与常用的数据库，例如mysql、
oracle、mariaDB、DB2、SQLite、Hsqldb等。
1.本项目在 github 的项目地址：https://github.com/pagehelper/Mybatis-PageHelper
2.本项目在 gitosc 的项目地址：http://git.oschina.net/fre/Mybatis_PageHelper

二.PageHelper的使用

2.1.集成
引入分页插件有下面2种方式，推荐使用 Maven 方式
2.1.1. 第一种引入 Jar 包
你可以从下面的地址中下载最新版本的 jar 包

• https://oss.sonatype.org/content/repositories/releases/com/github/pagehelper/pagehelper/
• http://repo1.maven.org/maven2/com/github/pagehelper/pagehelper/
  由于使用了sql 解析工具，你还需要下载 jsqlparser.jar：
• http://repo1.maven.org/maven2/com/github/jsqlparser/jsqlparser/0.9.5/

2.1.2. 第二种使用 Maven配置的方式
在 pom.xml 中添加如下依赖：

<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>最新版本</version>
</dependency>

2. 2.配置
特别注意，新版拦截器是 com.github.pagehelper.PageInterceptor 。 com.github.pagehelper.PageHelper 现
在是一个特殊的 dialect 实现类，是分页插件的默认实现类，提供了和以前相同的用法。
2.2.1. 第一种在 MyBatis 配置 xml 中配置拦截器插件

<!--
	plugins在配置文件中的位置必须符合要求，否则会报错，顺序如下:
	properties?, settings?,
	typeAliases?, typeHandlers?,
	objectFactory?,objectWrapperFactory?,
	plugins?,
	environments?, databaseIdProvider?, mappers?
-->
<plugins>
	<!-- com.github.pagehelper为PageHelper类所在包名 -->
	<plugin interceptor="com.github.pagehelper.PageInterceptor">
		<!-- 使用下面的方式配置参数，后面会有所有的参数介绍 -->
		<property name="param1" value="value1"/>
	</plugin>
</plugins>

2.2.2. 第二种在 Spring 配置文件中配置拦截器插件

使用 spring 的属性配置方式，可以使用 plugins 属性像下面这样配置：
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
	<!-- 注意其他配置 -->
	<property name="plugins">
		<array>
			<bean class="com.github.pagehelper.PageInterceptor">
				<property name="properties">
					<!--使用下面的方式配置参数，一行配置一个 -->
					<value>
						params=value1
					</value>
				</property>
			</bean>
		</array>
	</property>
</bean>

pageHelper配置示例：
<!-- 把交给IOC管理 SqlSessionFactory -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>

        <!-- 传入PageHelper的插件 -->
        <property name="plugins">
            <array>
                <!-- 传入插件的对象 -->
                <bean class="com.github.pagehelper.PageInterceptor">
                    <property name="properties">
                        <props>
                            <prop key="helperDialect">mysql</prop>
                            <prop key="reasonable">true</prop>
                        </props>
                    </property>
                </bean>
            </array>
        </property>
    </bean>
    
    helperDialect参数用于指定使用的数据库的类型
    reasonable ：分页合理化参数，默认值为 false 。当该参数设置为 true 时，    pageNum<=0 时会查询第一页，pageNum>pages（超过总数时），会查询最后一页。默认 false 时，直接根据参数进行查询。

2.3 分页插件参数介绍

这里省略介绍了，在PDF文件中有详细介绍。

2.4在项目中的使用示例：

1 Service

在执行dao的方法前一句执行pageHelper的方法：
@Override
public List<Orders> findAllByPage(int page, int pageSize) throws Exception {
	PageHelper.startPage(page, pageSize);
	return ordersDao.findAllByPage();
}

2 Controller

1.RequestParam注解是用来浏览器接收传来的参数的
2.PageInfo.class是插件里的类，非常方便的调用，分页再次提高性能，用来和pageHelper搭配使用

@RequestMapping("/findAll.do")
public ModelAndView findAll(@RequestParam(name = "page", required = true, defaultValue = "1")
Integer page, @RequestParam(name = "pageSize", required = true, defaultValue = "10") Integer
pageSize) throws Exception {
	List<Orders> ordersList = ordersService.findAllByPage(page, pageSize);
	PageInfo pageInfo = new PageInfo(ordersList);
	ModelAndView mv = new ModelAndView();
	mv.setViewName("order-list");
	mv.addObject("pageInfo", pageInfo);
	return mv;
}

3.在jsp页面中，点击传参数给pageHelper插件指定page和pageSize的大小：