恒宇少年 / mybatis-pageableJavaApache-2.0

0 Watch 20 Star 41 Fork 8
加入码云
与超过 300 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
支持12种数据库的通用Mybatis分页插件工具,支持目前主流数据库使用,使用最少的代码完成分页数据读取。 展开 收起

Loading...
README.md 4.99 KB

欢迎使用自动化分页插件

Maven central

欢迎关注公众号

微信公众号 关注微信公众号,回复加群,获取交流群群号。

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()方法都可以这么使用。

项目点评 ( 2 )

你可以在登录后,发表评论

搜索帮助

12_float_left_people 12_float_left_close