mybatis-plus分页方式
作者:mmseoamin日期:2023-12-18

拦截器(分页插件)

一 方式1:XxxMapper.selectPage

1 selectPage(page, null)

  1. 概述
    1. MyBatisPlus中提供的(自带的)分页插件,非常简单,只需要简单的配置就可以实现分页功能。
  2. 详细步骤:
    1. 第一步::config.MybatisPlusConfig.java:配置类,配置mybatisplus的插件功能。
      package com.guigu.config;
      import com.baomidou.mybatisplus.annotation.DbType;
      import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
      import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
      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.guigu.mapper") //可以将启动类中的注解移到此处
      public class MybatisPlusConfig {
          /**
           *
           * 1 怎么来配置mybatis-plus中的插件?
           *   这里所需要的类型是MybatisPlusInterceptor,这是mybatis-plus的一个拦截器,用于配置mybatis-plus中的插件。
           * 2 为什么要使用拦截器MybatisPlusInterceptor呢?
           *    这里边的原理和mybatis分页插件的功能是一样的,工作流程如下 :
           *   (1)第一步:执行查询功能。
           *   (2)第二步:拦截器对查询功能进行拦截。
           *   (3)第三步:拦截器对查询功能的基础上做了额外的处理,达到分页的效果(功能)。
           * 3 对比配置mybatis中的插件?
           *   用的也是拦截器的方式。
           *
           * @return MybatisPlusInterceptor
           */
          @Bean
          public MybatisPlusInterceptor mybatisPlusInterceptor() {
              MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
              //添加:分页插件
              //参数:new PaginationInnerInterceptor(DbType.MYSQL),是专门为mysql定制实现的内部的分页插件
              interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
              //添加:乐观锁插件
              interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
              return interceptor;
          }
      }
      
    2. 第二步:验证(测试):
      package com.guigu;
      import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
      import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
      import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
      import com.guigu.mapper.UserMapper;
      import com.guigu.pojo.User;
      import org.junit.jupiter.api.Test;
      import org.springframework.beans.factory.annotation.Autowired;
      import org.springframework.boot.test.context.SpringBootTest;
      import java.util.List;
      import java.util.Map;
      @SpringBootTest
      class MybatisplusDemo01ApplicationTests {
          @Autowired
          private UserMapper userMapper;
          @Test
          public void testPage(){
              //设置分页参数:页码、显示的条数
              Page page = new Page<>(2, 3);
              //第2个参数是条件构造器,如果设置为null,即查询所有
              //返回值就是一个Page对象,即返回上面所new出来的page对象,所有数据都在其中
              //对应的sql语句:SELECT id,name,age,email FROM user LIMIT ?
              userMapper.selectPage(page, null);
              //获取分页数据
              List list = page.getRecords();
              list.forEach(System.out::println);
              System.out.println("当前页:"+page.getCurrent());
              System.out.println("每页显示的条数:"+page.getSize());
              System.out.println("总记录数:"+page.getTotal());
              System.out.println("总页数:"+page.getPages());
              System.out.println("是否有上一页:"+page.hasPrevious());
              System.out.println("是否有下一页:"+page.hasNext());
          }
      }

2 selectPage(page,lambda查询包装器)

//  这种方式比较简单,可以不用修改Mapper,适合简单的增删改查。
@PostMapping("/queryPage")
public ResponseData queryPage(@RequestBody QueryPageParam queryPageParam) {
    try {
        int pageIndex = queryPageParam.getPageIndex() == 0 ? 1 : queryPageParam.getPageIndex();
        int pageSize = queryPageParam.getPageSize() == 0 ? 20 : queryPageParam.getPageSize();
        Page page = new Page<>(pageIndex, pageSize);
        LambdaQueryWrapper wrapper = Wrappers.lambdaQuery(User.class);
        if (CharSequenceUtil.isNotBlank(queryPageParam.getAge())) {
            wrapper.eq(User::getAge, queryPageParam.getAge());
        }
        Page queryPageUser = userMapper.selectPage(page, wrapper);
        return new ResponseData<>(StatusCodeEnum.SUCCESS_CODE.getStatusCode(), queryPageUser.getRecords(),"操作成功");
    } catch (Exception e) {
        log.error("异常信息: " + e.getMessage(), e);
        return new ResponseData<>(StatusCodeEnum.ERROR_CODE.getStatusCode(), "操作失败:" + e.getMessage());
    }
}
 

二 方式2:Service CRUD 接口

官网介绍:

// 无条件分页查询
IPage page(IPage page);
// 条件分页查询
IPage page(IPage page, Wrapper queryWrapper);
// 无条件分页查询
IPage> pageMaps(IPage page);
// 条件分页查询
IPage> pageMaps(IPage page, Wrapper queryWrapper);

IXxxService.java:

package com.example.demo.user.service;
import com.baomidou.mybatisplus.extension.service.IService;
import com.example.demo.user.entity.User;
 
public interface UserService extends IService {
}

XxxServiceImpl.java:

package com.example.demo.user.service.impl;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.user.entity.User;
import com.example.demo.user.mapper.UserMapper;
import com.example.demo.user.service.UserService;
import org.springframework.stereotype.Service;
 
@Service
public class UserServiceImpl extends ServiceImpl implements UserService {
}

XxxController.java

package com.example.demo.user.controller;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.metadata.OrderItem;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.user.entity.User;
import com.example.demo.user.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
 
@Api(tags = "排序")
@RestController
@RequestMapping("sort")
public class SortController {
 
    @Autowired
    private UserService userService;
 
    @ApiOperation("默认顺序")
    @GetMapping("defaultOrder")
    public IPage defaultOrder(Page page) {
        return userService.page(page);
    }
 
    @ApiOperation("通过orderItems")
    @GetMapping("orderItems")
    public IPage orderItems(Page page) {
        page.addOrder(OrderItem.desc("create_time"));
        // 可以指定多列。比如下边这个:按create_time排序,若create_time相同,则按id排序
        // page.addOrder(OrderItem.desc("create_time"), OrderItem.asc("id"));
        return userService.page(page);
    }
 
    @ApiOperation("通过wrapper")
    @GetMapping("wrapper")
    public IPage wrapper(Page page) {
        LambdaQueryWrapper queryWrapper = Wrappers.lambdaQuery();
        // 按create_time排序,若create_time相同,则按id排序
        queryWrapper.orderByDesc(User::getCreateTime);
        queryWrapper.orderByAsc(User::getId);
        return userService.page(page, queryWrapper);
    }
 
    @ApiOperation("前端指定顺序")
    @GetMapping("byFrontEnd")
    public IPage byFrontEnd(Page page) {
        return userService.page(page);
    }
}

三 方式3:自定义方法 + 自定义(动态)sql语句的分页

  1. 业务(场景):查询语句是自定义的
  2. 需求:自定义查询语句如何配合分页插件来实现分页功能
  3. 案例:根据年龄查询用户信息,并且分页
    1. 第一步:UserMapper.java:接口方法
      @Repository
      public interface UserMapper extends BaseMapper {
          /**
           * 需求:根据年龄查询用户列表,分页显示
           *
           * 第一步:xml自定义分页,Mapper接口方法
           *       第1步:如果想要mybatis-plus的分布插件来作用于我们自定义的sql语句的话,第一个参数必须得是一个分页对象:@Param("page") Page page。
           * 第二步:因为Mapper接口方法有2个参数的话
           *       方案1:使用mybatis提供的访问方式
           *       方案2:也可以使用@param来设置命名参数,来规定参数的访问规则
           *
           * @param page 必须放在第一位:分页对象,xml中可以从里面进行取值,传递参数 Page 即自动分页
           * @param age 年龄
           * @return Page
           */
          Page selectPageVo(@Param("page") Page page, @Param("age") Integer age);
      }
    2. 第二步:UserMapper.xml:自定义sql语句
      
      
      
          id,name,age,email
          
          
          
          
      
    3. 第三步:application.yml:设置类型别名
      ​
      spring:
        # 配置数据源信息
        datasource:
          dynamic:
            # 设置默认的数据源或者说主数据源,默认值即为master
            primary: master
            # 严格匹配数据源,默认false.true未匹配到指定数据源时抛异常,false未匹配到指定数据源时使用默认数据源
            strict: false
            datasource:
                master:
                  url: jdbc:mysql://localhost:3306/fLearn?characterEncoding=utf-8&useSSL=false
                  driver-class-name: com.mysql.cj.jdbc.Driver
                  username: root
                  password: MySQL#567890
                #从数据源
                slave_1:
                  url: jdbc:mysql://localhost:3306/fLearn2?characterEncoding=utf-8&useSSL=false
                  driver-class-name: com.mysql.cj.jdbc.Driver
                  username: root
                  password: MySQL#567890
      mybatis-plus:
        configuration:
          log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
        #配置mybatis类型别名所对应的包
        #此配置后,默认把类名当做此类型的别名,且不区分大小写(resultType="User"和resultType="user"都是指向User.java类型)
        type-aliases-package: com.guigu.pojo
        # 配置扫描通用枚举所在的包
        type-enums-package: com.guigu.enums
      ​
    4. 第四步:XmlPage.java:测试

      package com.guigu;
      import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
      import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
      import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
      import com.guigu.mapper.UserMapper;
      import com.guigu.pojo.User;
      import org.junit.jupiter.api.Test;
      import org.springframework.beans.factory.annotation.Autowired;
      import org.springframework.boot.test.context.SpringBootTest;
      import java.util.List;
      import java.util.Map;
      @SpringBootTest
      class xmlPage {
          @Autowired
          private UserMapper userMapper;
          @Test
          public void testSelectPageVo(){
              //设置分页参数
              Page page = new Page<>(1, 5);
              userMapper.selectPageVo(page, 20);
              //获取分页数据
              List list = page.getRecords();
              list.forEach(System.out::println);
              System.out.println("当前页:"+page.getCurrent());
              System.out.println("每页显示的条数:"+page.getSize());
              System.out.println("总记录数:"+page.getTotal());
              System.out.println("总页数:"+page.getPages());
              System.out.println("是否有上一页:"+page.hasPrevious());
              System.out.println("是否有下一页:"+page.hasNext());
          }
      }

四 方式4:PageHelper插件分页查询

  1. 第一步:pom.xml:依赖
            
                com.github.pagehelper
                pagehelper-spring-boot-starter
                1.4.5
            
    
  2. 第二步:XxxServiceImpl.java:Service CRUD 接口的实现

        @Override
        public PageInfo getPageStudentFour(Integer current, Integer size) {
            //获取第1页,10条内容,默认查询总数count
            PageHelper.startPage(current, size);
            List list = this.list();
            //用PageInfo对结果进行包装
            PageInfo page = new PageInfo(list);
            return page;
        }
    
  3. 第三步:测试mybatis-plus分页方式,第1张

    1. 这是控制台打印的查询语句,大家发现最后的LIMIT 函数没,正常来说mybatis-plus里是没有写的,是pagehelper加上去。我顿时觉得,对于一个初级程序员的我来说,还有好多要学的。

    2. PageHelper.startPage(pageNum, pageSize)这个地方设置的两个值,pagehelper会在你执行查询语句的时候帮你加上去,也就是LIMIT 的两个参数,第一个参数是LIMIT 的起始下标,pagehelper会根据pageNum和pageSize自动给你算出;第二个参数是LIMIT的 数据量,也就是pageSize。而且我发现,pagehelper会执行两遍你写的查询语句,第一遍会进行count(0),查出总条数,第二遍就会利用你设置的参数帮你分页查询出pageSize条数据。

    3. 我之前想先进行树排序后再进行分页的想法,在使用pagehelper时是行不通的,因为会影响pagehelper的自动分页。因此我得出在进行pagehelper分页的时候不可以给查询出的数据进行其他排序操作(查询语句中写order by是可以的),这可能就是pagehelper的局限之处,不过我相信应该有解决办法,等我找到了再分享出来。

五 参考

(1)sgg - yangbochao -mybatisplus  

(2)mybatis-plus分页查询三种方法_mybatisplus分页查询 —— pageHelps

(3)Mybatis-plus分页两种方式 —— selectPage(page,lambda查询包装器) 

(4)MyBatisPlus分页时排序的实现 —— XxxService.page()方法