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，其它数据库请自行修改代码。
mybatispage.zip