mybatis-plus实现分页（好用）

Posted 2023-04-08 一枝风

        前文：mybatis-plus大家在个人使用或在实际生产当中都使用过，今天来说一下plus的分页功能。
功能比较简单，大家会的就当再熟悉一遍流程，不会的可以来学习一下。
        目前官方支持的数据库种类还是蛮多的，包括：
        mysql，oracle，db2，h2，hsql，sqlite，postgresql，sqlserver，Phoenix，
Gauss ，clickhouse，Sybase，OceanBase，Firebird，cubrid，goldilocks，csiidb
        达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库

1、插件配置

配置是以mybatis-plus自带的PaginationInnerInterceptor配置的。

配置里面的注解是万万不要忘记的！

@EnableTransactionManagement
@MapperScan("com.example.demo.mapper")
@Configuration
public class MyBatisPlusConfig 

    /**
     * 分页插件配置
     *
     * @return
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor()
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        PaginationInnerInterceptor innerInterceptor=new PaginationInnerInterceptor();
        innerInterceptor.setDbType(DbType.MYSQL);
        innerInterceptor.setOverflow(true);
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        interceptor.addInnerInterceptor(innerInterceptor);
        return interceptor;
    

    @Bean
    public ConfigurationCustomizer configurationCustomizer()
        return mybatisConfiguration -> mybatisConfiguration.setUseGeneratedShortKey(false);
    

2、mapper代码

IPage<SysUser> getUserPage (IPage<SysUser> page,@Param("name") String name);

3、SQL-XML

<select id="getUserPage" resultType="com.example.demo.entity.SysUser">
        select * from sys_user where name like '%$name%'
    </select>

4、service

    JsonData getUserPage(Integer pageNum, Integer pageSize, String name);

5、service实现类

@Resource
    private SysUserMapper sysUserMapper;

    @Override
    public JsonData getUserPage(Integer pageNum, Integer pageSize, String name) 
        Page<SysUser> page = new Page<>(pageNum, pageSize);
        IPage<SysUser> getUser = sysUserMapper.getUserPage(page,name);
        return JsonData.buildSuccess(getUser);
    

其中，IPage 是分页的关键，将我们需要分页的条件用Page处理，即可达到分页效果。

更多的分页方法如下（来源于mybatis-plus官方插件讲解）：

6、调用

@GetMapping("getUserPage")
    public JsonData getUserPage(Integer pageNum,Integer pageSize,String name) 
        return userService.getUserPage(pageNum,pageSize,name);
    

7、结果

 可以看到调用结果也是按照分页的结果出来的。

总结：本次是一个完整性的调用过程，数据结构是简单的，简单便捷。

MyBatis-Plus 实现分页的几种写法

简介

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

快速开始

添加依赖

全新的 MyBatis-Plus 3.0 版本基于 JDK8，提供了 lambda 形式的调用，所以安装集成 MP3.0 要求如下：

• JDK 8+

• Maven or Gradle

Spring Boot项目

maven:

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>最新版本</version>
</dependency>

Spring 项目

maven:

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>最新版本</version>
</dependency>

配置

在 application.yml 配置文件中添加 H2 数据库的相关配置：

# DataSource Config
spring:
  datasource:
    driver-class-name: org.h2.Driver
    schema: classpath:db/schema-h2.sql
    username: root
    password: test
  sql:
    init:
      schema-locations: classpath:db/schema-h2.sql
      data-locations: classpath:db/data-h2.sql

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

@SpringBootApplication
@MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")
public class Application 

    public static void main(String[] args) 
        SpringApplication.run(Application.class, args);
    

Page分页

方式一：

使用mybatis-plus 的 Service page 接口

---

    @GetMapping("/pageList")
    @ApiOperation(value = "分页列表", notes = "query和user")
    public R<IPage<User>> pageList(@ApiIgnore User user, Query query) 
        //无条件分页
        IPage<User> pages = userService.page(Condition.getPage(query));
        //有条件分页
        IPage<User> pages = userService.page(Condition.getPage(query), Wrappers.lambdaQuery(user));
        return R.data(pages);
    

方式二：

自定义sql分页

---

controller层代码：

    @GetMapping("/pageList")
   @ApiOperation(value = "分页列表", notes = "query和user")
    public R<IPage<User>> pageList(@ApiIgnore User user, Query query) 
        IPage<User> pages = userService.selectUserPage(Condition.getPage(query), user);
        return R.data(pages);
    

service 里调用自定义分页sql mapper方法

  @Override
    public IPage<User> selectUserPage(IPage<User> page, User user) 
        return page.setRecords(baseMapper.selectUserPage(page, user));
    

定义mapper分页接口：

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.gis.spacedata.bladex.domain.entity.system.User;
import org.apache.ibatis.annotations.Param;

import java.util.List;

import java.util.List;

public interface UserMapper extends BaseMapper<User> 

    List<User> selectUserPage(IPage<User> page, @Param("user") User user);

mybatis xml:

    <select id="selectUserPage" resultMap="userResultMap">
        select * from blade_user where is_deleted = 0
        <if test="user.tenantId!=null and user.tenantId != ''">
            and tenant_id = #user.tenantId
        </if>
        <if test="user.account!=null and user.account != ''">
            and account like CONCAT('%',#user.account,'%')
        </if>
        <if test="user.realName!=null and user.realName != ''">
            and real_name like CONCAT('%',#user.realName,'%')
        </if>
        <if test="user.roleId!=null and user.roleId != ''">
            and CAST(#user.roleId AS VARCHAR)= ANY(STRING_TO_ARRAY(role_id, ','))
        </if>
        ORDER BY id
    </select>

Condition 工具类：

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.springblade.core.launch.constant.TokenConstant;
import org.springblade.core.tool.support.Kv;
import org.springblade.core.tool.utils.BeanUtil;
import org.springblade.core.tool.utils.Func;

import java.util.Map;

/**
 * 分页工具
 *
 * @author Chill
 */
public class Condition 

    /**
     * 转化成mybatis plus中的Page
     *
     * @param query 查询条件
     * @return IPage
     */
    public static <T> IPage<T> getPage(Query query) 
        Page<T> page = new Page<>(Func.toInt(query.getCurrent(), 1), Func.toInt(query.getSize(), 10));
        page.setAsc(Func.toStrArray(SqlKeyword.filter(query.getAscs())));
        page.setDesc(Func.toStrArray(SqlKeyword.filter(query.getDescs())));
        return page;
    

    /**
     * 获取mybatis plus中的QueryWrapper
     *
     * @param entity 实体
     * @param <T>    类型
     * @return QueryWrapper
     */
    public static <T> QueryWrapper<T> getQueryWrapper(T entity) 
        return new QueryWrapper<>(entity);
    

    /**
     * 获取mybatis plus中的QueryWrapper
     *
     * @param query 查询条件
     * @param clazz 实体类
     * @param <T>   类型
     * @return QueryWrapper
     */
    public static <T> QueryWrapper<T> getQueryWrapper(Map<String, Object> query, Class<T> clazz) 
        Kv exclude = Kv.create().set(TokenConstant.HEADER, TokenConstant.HEADER)
            .set("current", "current").set("size", "size").set("ascs", "ascs").set("descs", "descs");
        return getQueryWrapper(query, exclude, clazz);
    

    /**
     * 获取mybatis plus中的QueryWrapper
     *
     * @param query   查询条件
     * @param exclude 排除的查询条件
     * @param clazz   实体类
     * @param <T>     类型
     * @return QueryWrapper
     */
    public static <T> QueryWrapper<T> getQueryWrapper(Map<String, Object> query, Map<String, Object> exclude, Class<T> clazz) 
        exclude.forEach((k, v) -> query.remove(k));
        QueryWrapper<T> qw = new QueryWrapper<>();
        qw.setEntity(BeanUtil.newInstance(clazz));
        SqlKeyword.buildCondition(query, qw);
        return qw;
    

方式三：

使用mybatis-plus的Db类

说明:

• 使用静态调用的方式，执行CRUD方法，避免Spring环境下Service循环注入、简洁代码，提升效率

• 需要项目中已注入对应实体的BaseMapper

• 完整使用方式见: 测试用例(opens new window)

• 对于参数为Wrapper的，需要在Wrapper中传入Entity或者EntityClass供寻找对应的Mapper

• 不建议在循环中调用，如果是批量保存，建议将数据构造好后使用 Db.saveBatch(数据) 保存

---

    @Test
    void testPage() 
        IPage<Entity> page = Db.page(new Page<>(1, 1), Entity.class);
        Assertions.assertEquals(2, page.getTotal());
        page = Db.page(new Page<>(1, 1), Wrappers.lambdaQuery(Entity.class));
        Assertions.assertEquals(1, page.getRecords().size());