mybatis 分頁插件PageHelper的使用

• 分頁處理
• Mybatis分頁插件 - PageHelper說明
• 使用方法
• • 第一步：把PageHelper依賴的jar包添加到工程中。
  • 第二步：在Mybatis配置xml（SqlMapConfig.xml）中配置攔截器插件:
  • 第三步：在代碼中使用
  • • 1、設定分頁資訊：
    • 2、取分頁資訊
    • • 第一種方式
      • 第二種方式
      • 完整測試代碼
      • 如果出現如下異常，換一個版本再試，版本相容問題

分頁處理

逆向工程生成的代碼是不支援分頁處理的，如果想進行分頁需要自己編寫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