MyBatisPlus（十五）分页查询

news2025/1/10 23:54:30

说明

MyBatisPlus 提供了分页查询的功能。

MyBatisPlus 的分页功能，是通过分页插件实现的。要使用分页功能，需要配置分页插件的拦截器。

MyBatisPlus 的分页功能，可以通过内置的API接口实现；也可以通过自定义的 mapper#method 使用分页。

分页插件拦截器

此处的代码可以参考官网的示例。

package com.example.core.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@MapperScan("com.example.web")
public class MybatisPlusConfig {

    /**
     * 添加分页插件
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));// 如果配置多个插件,切记分页最后添加
        // interceptor.addInnerInterceptor(new PaginationInnerInterceptor()); 如果有多数据源可以不配具体类型 否则都建议配上具体的DbType
        return interceptor;
    }
}

官网示例：
在这里插入图片描述

分页查询（MyBatisPlus接口）

代码

    /**
     * 分页查询用户列表。
     * <br>
     * 查询条件：查询第2页的数据，每页3条数据。
     */
    @Test
    void selectPage() {
        LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
        IPage<User> pageQuery = new Page<>(2, 3);
        IPage<User> page = mapper.selectPage(pageQuery, wrapper);

        log.info("当前页码：{}", page.getCurrent());
        log.info("每 1 页的数据量：{}", page.getSize());
        log.info("总数据量：{}", page.getTotal());
        log.info("总页数：{}", page.getPages());
        log.info("数据列表：{}", page.getRecords());
    }

查询效果

在这里插入图片描述

自定义的 mapper#method 使用分页

官网说明

在这里插入图片描述

代码示例

查询方法：Mapper.java

package com.example.web.mapper;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.example.web.entity.User;

import java.util.List;

public interface MybatisMapper {

    /**
     * 分页查询用户列表。
     *
     * @param page     分页参数
     * @param beginAge 开始年龄（大于等于）
     * @return 用户列表分页数据
     */
    IPage<User> selectPageByBeginAge(IPage<User> page, Integer beginAge);

}

方法实现：Mapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.web.mapper.MybatisMapper">

    <select id="selectPageByBeginAge" resultType="com.example.web.entity.User">
        select * from tb_user where age >= #{beginAge}
    </select>

</mapper>

方法调用

    /**
     * 分页查询用户列表。
     * <br>
     * 查询条件：开始年龄（大于等于），查询第2页的数据，每页3条数据。
     */
    @Test
    void selectPage() {
        IPage<User> pageQuery = new Page<>(2, 3);
        IPage<User> page = mapper.selectPageByBeginAge(pageQuery, 20);

        log.info("当前页码：{}", page.getCurrent());
        log.info("每 1 页的数据量：{}", page.getSize());
        log.info("总数据量：{}", page.getTotal());
        log.info("总页数：{}", page.getPages());
        log.info("数据列表：{}", page.getRecords());
    }