转载

Mybatis中使用PageHelper插件进行分页

分页的场景比较常见，下面主要介绍一下使用PageHelper插件进行分页操作：

一、概述：

PageHelper支持对mybatis进行分页操作，项目在github地址：

https://github.com/pagehelper/Mybatis-PageHelper ；

项目中文官网：

https://pagehelper.github.io/

二、使用（与springboot集成）：

springboot相比于spring，相关配置都可以在代码中完成，和之前通过xml配置的方式不同。

1. mybatis数据源配置中，对sqlSessionFactory bean对象配置的时候，声明定义PageHelper对象，对sessionFactory对象设置此分页对象插件：

SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
bean.setDataSource(dataSource);

// 分页插件
PageHelper pageHelper = new PageHelper();
Properties properties = new Properties();
properties.setProperty("reasonable", "true");
properties.setProperty("supportMethodsArguments", "true");
properties.setProperty("returnPageInfo", "check");
properties.setProperty("params", "count=countSql");
pageHelper.setProperties(properties);

 // 添加插件
bean.setPlugins(new Interceptor[] { pageHelper });

如上代码，设置了分页插件的相关参数，相关参数的配置与效果可以进入插件官网查看。

2. 在需要分页的地方：

PageHelper.startPage(1, 10);
List<Country> list = countryMapper.queryList(1);

如上，调用了PageHelper的startPage方法，传入第几页以及每页的记录数，这样就可以查询出对应的记录；

如果需要获取查询记录的总页数以及总记录数：

Page<?> page = PageHelper.startPage(1, 10);
List<Country> list = countryMapper.queryList(1);
int pages = page.getPages();
int total = (int)page.getTotal();

三、原理：

上面介绍了PageHelper插件分页功能的使用，总体来说还是比较方便的，不需要自己再去做额外的处理；

name为什么使用了如下语句之后，就可以生效呢？

PageHelper.startPage(1, 10);

简单的看下这个方法的源码，一直追踪下去，可以发现最终调用的是这个方法：

 1     public static <E> Page<E> startPage(int pageNum, int pageSize, boolean count, Boolean reasonable, Boolean pageSizeZero) {
 2         Page<E> page = new Page<E>(pageNum, pageSize, count);
 3         page.setReasonable(reasonable);
 4         page.setPageSizeZero(pageSizeZero);
 5       
 6         Page<E> oldPage = SqlUtil.getLocalPage();
 7         if (oldPage != null && oldPage.isOrderByOnly()) {
 8             page.setOrderBy(oldPage.getOrderBy());
 9         }
10         SqlUtil.setLocalPage(page);
11         return page;
12     }

可以看到，传入的pageNumber与pageSize最后是调用 SqlUtil.setLocalPage(page) 方法存了起来，我们看下这个方法：

    public static void setLocalPage(Page page) {
        LOCAL_PAGE.set(page);
    }

那么这个LOCAL_PAGE对象是什么呢？

private static final ThreadLocal<Page> LOCAL_PAGE = new ThreadLocal<Page>();

其实就是一个threadlocal对象，用来存当前线程下pagenumber与pagesize；

那么可以推测，mybaits在执行查询的时候，由于设置了分页插件拦截器，会对查询sql进行处理，拼接对应页的查询语句，那么具体是哪一页以及每页有多少条记录，这些信息

就可以从这个threadlocal对象中取得。

原文 http://www.cnblogs.com/toiletgg/p/11382444.html

正文到此结束

所属分类：编程技术 Java

本文标签： tar CTO 参数 sqlsession 代码分页 mapper https GitHub mybatis SqlSessionFactory pagehelper git 数据插件 bean session 源码配置 list Property springboot spring map XML http id sql HTML dataSource IO 线程 App final plugin
版权声明： 本文为互联网转载文章，出处已在文章中说明(部分除外)。如果侵权，请联系本站长删除，谢谢。
本文海报： 生成海报一生成海报二

其他链接

关于本站

本站定位：个人技术类博客

本站作用：写博客、记日志、闲聊扯淡鼓捣技术。

问题交流

Mybatis中使用PageHelper插件进行分页

热门推荐

相关文章

说给你听

本文目录

随机标签

书籍教程

近期评论

网站信息

其他链接

关于本站

问题交流