MyBatis自动分页实现

近两天一直再研究MyBatis的分页问题，看了别人的处理方式，自己总结优化了一下，写了两个拦截类，给有需要的人使用和参考，源码请下载附件。

主要有3个类：Page，MybatisPageInterceptor，MybatisSpringPageInterceptor

 

Page：作为分页对象，有：pageNo、pageSize、totalRecord、totalPage、results属性

 

MybatisPageInterceptor和MybatisSpringPageInterceptor：

均为拦截类，仅需要选用其中的一个，前者在任何情况下都可用，后再仅在Spring环境下使用。

推荐使用后者，其优点是使用后无需对mapper的XML文件作任何修改，只需要修改Mapper类的方法，增加一个Page类型的参数即可。而前者使用时有可能会需要修改XML，特别是原Mapper方法只有一个参数时，需要增加@Param指定参数名，而后修改XML文件使用该参数名。

 

以下给出在Spring环境下的配置使用方法示例：

MybatisSpringPageInterceptor：

修改Spring配置文件

	<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
		<property name="dataSource" ref="dataSource" />
		<property name="configLocation" value="classpath:mybatis/mybatis.config.xml"/>
		<property name="typeAliasesPackage" value="com.xjd.springmybatis.model" />
		<property name="plugins">
			<bean class="com.xjd.springmybatis.mybatispage.MybatisSpringPageInterceptor">
			</bean>
		</property>
	</bean>

 修改Mapper方法：

public List<User> getByName(String username);

 为

public List<User> getByName(String username, Page page);

 

 Ok, 即可使用了。

 

MybatisPageInterceptor：

修改spring配置文件

	<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
		<property name="dataSource" ref="dataSource" />
		<property name="configLocation" value="classpath:mybatis/mybatis.config.xml"/>
		<property name="typeAliasesPackage" value="com.xjd.springmybatis.model" />
		<property name="plugins">
			<bean class="com.xjd.springmybatis.mybatispage.MybatisPageInterceptor">
			</bean>
		</property>
	</bean>

  修改Mapper方法：

 

public List<User> getByName(String username);

 为

 

 

public List<User> getByName(@Param("user") String username, Page page);

必要时修改mapper的xml文件：

 

	<select id="getByName" parameterType="map" resultMap="user_map" >
		select <include refid="user_columns"/>, <include refid="addr_columns"/>
		from user u left join address addr
		on u.id = addr.user_id
		where u.username = #{user}
	</select>

 

Ok, 即可使用了。

 

 使用方式：

 

Page<User> page = new Page<User>();
page.setPageNo(1);
page.setPageSize(20);
List<User> users = mapper.getByName("xjd", page);

System.out.println(page);
//users == page.getResults()

 

注意：目前只支持MySQL和Oracle，其它数据库请自行修改代码。

 

 

 

评论

14 楼 renlongnian 2016-09-11  

看了各位答案，我整理一下，供大家参考
1.<if test=""> 报错 ，请求参数用@Param("")
eg：代码：List<User> select(@Param("user") User record,Page page);
     xmL：<if test="user.userId != null">
    and user_id = #{user.userId,jdbcType=INTEGER}
    </if>

2.改完后参数不报错了。分页报错
  解决方法：
  MybatisSpringPageInterceptor.queryTotalRecord(Page<?> page, Object parameterObject, MappedStatement mappedStatement, Connection connection) throws SQLException方法中改个参数，
BoundSql boundSql = mappedStatement.getBoundSql(page);改成
BoundSql boundSql = mappedStatement.getBoundSql(parameterObject);

分页不报错了

感谢楼主分享的代码。

13 楼 l804935629 2016-08-15  

<property name="typeAliasesPackage" value="com.xjd.springmybatis.model" />
压缩包里没这个呀，

12 楼 showlives 2016-08-01  

非常感谢楼主分享, 




能不能附上你们的 sql.xml文件

11 楼 hai_dragon 2016-05-06  

可以用不错

10 楼 牛叉大丸子 2016-01-29  

艹艹  不严谨！！！！！sql语句form  还区分大小写 我也是醉了

9 楼 牛叉大丸子 2016-01-28  

后台输出是-1，貌似得不到sql语句，！！

8 楼 sq1073497452 2015-11-18  

首先谢谢发帖人无私奉献，然后我又一个问题

FontStyleMapper
文件调用的时候必须加@param不然就会报错！我使用的不对吗？

List<FontStyle> selectAllPage(@Param("fontStyle")FontStyle fontStyle,Page page);


FontStyleMapper.xml
<!-- 查询所有字体样式-->
  <select id="selectAllPage" resultMap="BaseResultMap" parameterType="com.ist.pojo.FontStyle" >
    select
    <include refid="Base_Column_List" />
    from font_style where 1=1
    <if test="fontStyle.fsId != null" >
       and fs_id = #{fontStyle.fsId,jdbcType=VARCHAR}
    </if>
  </select>

7 楼 b_l_east 2015-11-14  

Daniel_yexi 写道

b_l_east 写道

Daniel_yexi 写道

zjy7554 写道

mapper.xml里面如果有<if test=''>会报错，怎么解决

各位请看我在github上的一个项目，前面这个确实有bug: https://github.com/bleast/mybatis-page-plugin

基本类型是ok了，但是如果我传一个对象给mybatis的xml文件呢，还是不能引用出来

注意使用@Param

6 楼 Daniel_yexi 2015-11-10  

b_l_east 写道

Daniel_yexi 写道

zjy7554 写道

mapper.xml里面如果有<if test=''>会报错，怎么解决

各位请看我在github上的一个项目，前面这个确实有bug: https://github.com/bleast/mybatis-page-plugin

基本类型是ok了，但是如果我传一个对象给mybatis的xml文件呢，还是不能引用出来

5 楼 b_l_east 2015-09-13  

Daniel_yexi 写道

zjy7554 写道

mapper.xml里面如果有<if test=''>会报错，怎么解决

各位请看我在github上的一个项目，前面这个确实有bug: https://github.com/bleast/mybatis-page-plugin

4 楼 Daniel_yexi 2015-09-02  

zjy7554 写道

mapper.xml里面如果有<if test=''>会报错，怎么解决

3 楼 Daniel_yexi 2015-09-02  

我也是同样问题，<if test="">会报错，怎么解决

2 楼 zjy7554 2015-07-20  

mapper.xml里面如果有<if test=''>会报错，怎么解决

1 楼 mrzhanghao 2014-09-03  

敬告,Mybatis已经过时了.现在都是NOSQL了.