mybatis mysql 分页插件_mybatis-pagination

MyBatis 分页插件

mybatis-pagination 是一个简易的MyBatis物理分页插件，使用org.apache.ibatis.session.RowBounds及其子类作为分页参数，禁用MyBatis自带的内存分页。

分页原理

简单来说就是通过拦截StatementHandler重写sql语句，实现数据库的物理分页

如何使用分页插件

单独使用 MyBatis

若是单独使用 MyBatis ，则需要在 mybatis 配置文件中配置插件 mybatis-configuration.xml

与 Spring 集成

在与 Spring 框架集成使用 MyBatis 时，插件配置在 SqlSessionFactoryBean 的属性中 spring-mybatis.xml

如何分页

使用org.apache.ibatis.session.RowBounds及其子类作为分页参数将触发分页插件，插件提供一个简易的分页模型 net.oschina.archx.mybaits.Pagination，可以使用其作为分页参数。

分页模型

Pagination(offset, limit) 偏移量, 界限

Paginaiton(current, size, total) 当前页,每页显示记录,总记录数 自动计算偏移量和界限

演示代码

public class Message {

private long mid;

private String message;

...

}

public interface MessageMapper {

/**

* 消息列表

*

* @return

*/

List list();

/**

* 消息列表 分页显示

*

* @param pagination

* @return

*/

List list(RowBounds pagination);

}

mapper.xml 配置，namespace 必须和接口完整名称一致 Message-mapper.xml

select * from tb_message

调用方式

@Test

public void test() {

SqlSession session = sqlSessionFactory.openSession();

MessageMapper mapper = session.getMapper(MessageMapper.class);

// 查询从第 1 开始一共 4 条数据, MySql limit 从 0 开始

// 返回 2 - 5 的记录

Pagination pagination = new Pagination(1, 4);

List list = mapper.list(pagination);

// 返回查询总记录条数

System.out.println("total : " + pagination.getTotal());

print(list, "Pagination(1, 4)");

Assert.assertTrue(list != null && list.size() == 4);

}

@Test

public void test2() {

SqlSession session = sqlSessionFactory.openSession();

MessageMapper mapper = session.getMapper(MessageMapper.class);

// 测试数据 188 条，每页显示15条，查询第2页数据

// 返回 16 - 30 的记录

Pagination pagination = new Pagination(2,15,188);

List list = mapper.list(pagination);

print(list, "Pagination(2,15,188)");

Assert.assertTrue(list != null && list.size() == 15);

}

测试结果

-------------------------------------------------------

T E S T S

-------------------------------------------------------

Running net.oschina.archx.mybatis.test.MyBatisJUnitTest

total : 188

Pagination(1, 4) > { "mid":2,"message":"message > 2" }

Pagination(1, 4) > { "mid":3,"message":"message > 3" }

Pagination(1, 4) > { "mid":4,"message":"message > 4" }

Pagination(1, 4) > { "mid":5,"message":"message > 5" }

=============================================================

Pagination(2,15,188) > { "mid":16,"message":"message > 16" }

Pagination(2,15,188) > { "mid":17,"message":"message > 17" }

Pagination(2,15,188) > { "mid":18,"message":"message > 18" }

Pagination(2,15,188) > { "mid":19,"message":"message > 19" }

Pagination(2,15,188) > { "mid":20,"message":"message > 20" }

Pagination(2,15,188) > { "mid":21,"message":"message > 21" }

Pagination(2,15,188) > { "mid":22,"message":"message > 22" }

Pagination(2,15,188) > { "mid":23,"message":"message > 23" }

Pagination(2,15,188) > { "mid":24,"message":"message > 24" }

Pagination(2,15,188) > { "mid":25,"message":"message > 25" }

Pagination(2,15,188) > { "mid":26,"message":"message > 26" }

Pagination(2,15,188) > { "mid":27,"message":"message > 27" }

Pagination(2,15,188) > { "mid":28,"message":"message > 28" }

Pagination(2,15,188) > { "mid":29,"message":"message > 29" }

Pagination(2,15,188) > { "mid":30,"message":"message > 30" }

=============================================================

源码包含测试用例，更多细节请查看源码