关注微信公众号,回复加群
,获取交流群群号。
MyBatis-Pageable
是一款自动化分页的插件,基于MyBatis
内部的插件Interceptor
拦截器编写完成,拦截Executor.query
的两个重载方法计算出分页的信息以及根据配置的数据库Dialect
自动执行不同的查询语句完成总数量的统计。
MyBatis-Pageable
目前支持的主流数据库:
MyBatis-Pageable
可以在传统的Spring
项目内使用,也可以在最新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
数据库你可以不配置数据库方言。
如果你项目中配置使用了mybatis-config.xml
,那么你需要添加如下代码到你的配置文件:
<plugins>
<plugin interceptor="com.gitee.hengboy.mybatis.pageable.interceptor.MyBatisExecutePageableInterceptor">
<!-- 配置数据库方言 -->
<property name="dialect" value="mysql"/>
</plugin>
</plugins>
当然你如果不使用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
对象都可以获取到什么内容呢?
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()
方法都可以这么使用。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。