开源信息:欢迎使用支持12种数据库的自动分页插件

MyBatis-Pageable是一款自动化分页的插件,基于MyBatis内部的插件Interceptor拦截器编写完成,拦截Executor.query的两个重载方法计算出分页的信息以及根据配置的数据库Dialect自动执行不同的查询语句完成总数量的统计。

支持的数据库

MyBatis-Pageable目前支持的主流数据库:

  • DB2
  • Derby
  • DM、
  • H2、
  • HSQL、
  • InforMix、
  • Mariadb、
  • MySQL、
  • Oracle、
  • Postgres、
  • SqlLite、
  • SqlServer2000以上版本

快速开始

MyBatis-Pageable可以在传统的Spring项目内使用,也可以在最新SpringBoot项目内使用。

SpringBoot集成

MyBatis-Pageable目前已经上传到Maven中央仓库,你可以随时配置依赖使用,如果你是Maven管理的项目,复制如下代码到你的pom.xml配置文件内:

<dependency>
     <groupId>com.gitee.hengboy</groupId>
     <artifactId>spring-boot-starter-mybatis-pageable</artifactId>
     <version>{lastVersion}</version>
 </dependency>

如果你使用的Gradle管理的项目,那么你需要复制如下的代码到你们的build.gradle文件内:

compile 'com.gitee.hengboy:mybatis-pageable:{lastVersion}'

注意:上面内容需要把{lastVersion}改成目前最新版本的MyBatis-Pageable版本号

配置插件

添加完成 starter依赖后,你可以在配置文件application.yml或者application.properties内完成配置,下面是yml格式配置:

hengboy:
  pageable:
      dialect: mysql

在使用pageable时你仅仅需要配置一个数据库方言,如果你使用MySQL或者MariaDB数据库你可以不配置数据库方言。

传统Spring集成

使用mybatis-config.xml 配置插件

如果你项目中配置使用了mybatis-config.xml,那么你需要添加如下代码到你的配置文件:

<plugins>
    <plugin interceptor="com.gitee.hengboy.mybatis.pageable.interceptor.MyBatisExecutePageableInterceptor">
        <!-- 配置数据库方言 -->
        <property name="dialect" value="mysql"/>
    </plugin>
</plugins>
使用application.xml 配置插件

当然你如果不使用mybatis-config.xml配置文件配置插件,也可以通过SqlSessionFactoryBean的插件列表来完成集成MyBatis-Pageable,如下配置:

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <!-- 配置插件列表 -->
  <property name="plugins">
    <array>
      <bean class="com.gitee.hengboy.mybatis.pageable.interceptor.MyBatisExecutePageableInterceptor">
        <property name="properties">
          <!-- 配置数据库方言 -->
          <value>
            dialect=mysql
          </value>
        </property>
      </bean>
    </array>
  </property>
</bean>

怎么使用?

目前MyBatis-Pageable使用比较简单,有一个分页请求类PageableRequest来完成自动分页操作,我们来看个简单的示例:

Page<UserEntity> page = PageableRequest.of(1, 5).request(() -> userMapper.selectAll());
  • of 配置分页的当前页码以及每页的限制条数
  • request 该方法需要传递一个夜晚逻辑方法,也就是你需要执行分页的方法

Page对象详解

在上面简单的一行代码就可以完成自动分页以及读取出分页相关的信息,分页执行后我们通过Page对象都可以获取到什么内容呢?

  • data 分页后的数据列表,具体的返回值可以使用Page<T>泛型接收
  • totalPages 总页数
  • totalElements 总条数
  • pageIndex 当前页码
  • pageSize 每页限制条数
  • offset 分页开始位置
  • endRow 分页结束位置
  • hasNext 是否存在下一页,true:存在,false:不存在
  • hasPrevious 是否存在上一页,true:存在,false:不存在
  • isFirst 是否为首页,true:首页,false:非首页
  • isLast 是否为末页,true:末页,false:非末页

翻页查询

实际开发过程中存在这种情况,虽然传递的分页页码为1,但是种种判断过后我需要查询上一页或者下一页首页的数据,这时候你就可以PageableRequest对象的next()previous()first()方法来处理这种事情的发生,如下示例:

Pageable pageable = PageableRequest.of(2, 10);
        if (xx = xx) {
            pageable.next();
        }
        Page<UserEntity> page = pageable.request(()->userMapper.selectAll());

上面是翻页到下一页的查询示例,当然这个功能是为了尽可能的方便分页的使用,同样的previous()first()方法都可以这么使用。

学习目录推荐

码云地址:https://gitee.com/hengboy/mybatis-pageable

其他开源信息

这段时间一直在编写开源的相关框架,致力于公司使用的框架升级以及开源计划,将公司使用到的工具以及插件进行升级重构并且开源。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270