mybatis 分页插件PageHelper的使用

分页处理

逆向工程生成的代码是不支持分页处理的，如果想进行分页需要自己编写mapper，这样就失去逆向工程的意义了。为了提高开发效率可以使用mybatis的分页插件PageHelper。

Mybatis分页插件 - PageHelper说明

如果你也在用Mybatis，建议尝试该分页插件，这个一定是最方便使用的分页插件。
该插件目前支持Oracle,Mysql,MariaDB,SQLite,Hsqldb,PostgreSQL六种数据库分页。

使用方法

第一步：把PageHelper依赖的jar包添加到工程中。

		<!-- pagehelper -->
		<dependency>
			<groupId>com.github.pagehelper</groupId>
			<artifactId>pagehelper</artifactId>
			<version>4.1.6</version>
		</dependency>

第二步：在Mybatis配置xml（SqlMapConfig.xml）中配置拦截器插件:

<plugins>
    <!-- com.github.pagehelper为PageHelper类所在包名 -->
    <plugin interceptor="com.github.pagehelper.PageHelper">
        <!-- 设置数据库类型 Oracle,Mysql,MariaDB,SQLite,Hsqldb,PostgreSQL六种数据库-->        
        <property name="dialect" value="mysql"/>
    </plugin>
</plugins>

第三步：在代码中使用

1、设置分页信息：

		//获取第1页，3条内容，默认查询总数count
		PageHelper.startPage(1, 3);
		UserExample example=new UserExample();
		//紧跟着的第一个select方法会被分页
		List<User> list = userMapper.selectByExample(example);

2、取分页信息

第一种方式

		//分页后，实际返回的结果list类型是Page<E>，如果想取出分页信息，需要强制转换为Page<E>
		Page<User> page = (Page<User>) list;
		System.out.println(page.getTotal());
		System.out.println(page.getPages());
		System.out.println(page.getPageNum());
		System.out.println(page.getPageSize());
		List<User> list2 = page.getResult();
		for (User user : page) {
			System.out.println(user.getUsername());
		}

第二种方式

		//用PageInfo对结果进行包装
		//PageInfo包含了非常全面的分页属性
		PageInfo<User> pageInfo = new PageInfo<>(list);
		System.out.println(pageInfo.getTotal());
		System.out.println(pageInfo.getPages());
		System.out.println(pageInfo.getPageNum());
		System.out.println(pageInfo.getPageSize());
		List<User> list2 = pageInfo.getList();
		for (User user : list2) {
			System.out.println(user.getUsername());
		}

完整测试代码

	@Test
	public void testPagHelper() throws Exception {
		UserMapper userMapper = ac.getBean(UserMapper.class);
		//获取第1页，3条内容，默认查询总数count
		PageHelper.startPage(1, 3);
		UserExample example=new UserExample();
		//紧跟着的第一个select方法会被分页
		List<User> list = userMapper.selectByExample(example);
		/*//取分页的第一种方式
		Page<User> page = (Page<User>) list;
		System.out.println(page.getTotal());
		System.out.println(page.getPages());
		System.out.println(page.getPageNum());
		System.out.println(page.getPageSize());
		List<User> list2 = page.getResult();
		for (User user : page) {
			System.out.println(user.getUsername());
		}*/
		//取分页的第二种方式
		PageInfo<User> pageInfo = new PageInfo<>(list);
		System.out.println(pageInfo.getTotal());
		System.out.println(pageInfo.getPages());
		System.out.println(pageInfo.getPageNum());
		System.out.println(pageInfo.getPageSize());
		List<User> list2 = pageInfo.getList();
		for (User user : list2) {
			System.out.println(user.getUsername());
		}
	}

如果出现如下异常，换一个版本再试，版本兼容问题

org.springframework.beans.factory.BeanCreationException: Error creating bean with name ‘sqlSessionFactory’ defined in class path resource [applicationContext.xml]: Invocation of init method failed; nested exception is org.springframework.core.NestedIOException: Failed to parse config resource: class path resource [SqlMapConfig.xml]; nested exception is org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: java.lang.ClassCastException: com.github.pagehelper.PageHelper cannot be cast to org.apache.ibatis.plugin.Interceptor