MyBatisPlus--（插件功能---分页）

news2024/12/27 13:22:21

4.插件功能

MybatisPlus提供了很多的插件功能，进一步拓展其功能。目前已有的插件有：

PaginationInnerInterceptor：自动分页
TenantLineInnerInterceptor：多租户
DynamicTableNameInnerInterceptor：动态表名
OptimisticLockerInnerInterceptor：乐观锁
IllegalSQLInnerInterceptor：sql 性能规范
BlockAttackInnerInterceptor：防止全表更新与删除

注意： 使用多个分页插件的时候需要注意插件定义顺序，建议使用顺序如下：

多租户,动态表名

分页,乐观锁

sql 性能规范,防止全表更新与删除

这里我们以分页插件为主来学习插件的用法。

4.1.分页插件

在未引入分页插件的情况下，MybatisPlus是不支持分页功能的，IService和BaseMapper中的分页方法都无法正常起效。所以，我们必须配置分页插件。

4.1.1.配置分页插件

在项目中新建一个配置类：

其代码如下：

package com.itheima.mp.config;

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

@Configuration
public class MybatisConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        // 初始化核心插件
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 添加分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

4.1.2.分页API

编写一个分页查询的测试：

    @Test
    void testPageQuery() {
//        // 1.分页查询，new Page()的两个参数分别是：页码、每页大小
//        Page<User> p = userService.page(new Page<>(2, 2));
//        // 2.总条数
//        System.out.println("total = " + p.getTotal());
//        // 3.总页数
//        System.out.println("pages = " + p.getPages());
//        // 4.数据
//        List<User> records = p.getRecords();
//        records.forEach(System.out::println);
        int pageNo = 1 , pageSize = 2;
        //1.准备分页条件
        //1.1 分页条件
        Page<User> page = Page.of(pageNo, pageSize);
        //1.2 排序条件
        page.addOrder(new OrderItem("balance",true));
        page.addOrder(new OrderItem("id",true));

        //分页查询
        Page<User> p = userService.page(page);
        //3,解析
        long total = p.getTotal();
        System.out.println("total = " + total);
        long pages = p.getPages();
        System.out.println("pages = " + pages);
        List<User> users = p.getRecords();
        users.forEach(System.out::println);
    }

运行的SQL如下：

这里用到了分页参数，Page，即可以支持分页参数，也可以支持排序参数。常见的API如下：

int pageNo = 1, pageSize = 5;
// 分页参数
Page<User> page = Page.of(pageNo, pageSize);
// 排序参数, 通过OrderItem来指定
page.addOrder(new OrderItem("balance", false));

userService.page(page);