MyBatis-Plus實(shí)現(xiàn)分頁的方法使用詳解

更新時(shí)間：2022年03月22日 16:25:32 作者：IT利刃出鞘

這篇文章主要為大家介紹了MyBatis-Plus的分頁的方法使用，包括：不傳參數(shù)時(shí)的默認(rèn)結(jié)果、查詢不存在的數(shù)據(jù)、手動(dòng)包裝page和自定義SQL，需要的可以參考一下

簡(jiǎn)介

本文介紹MyBatis-Plus的分頁的方法。

包括：

不傳參數(shù)時(shí)的默認(rèn)結(jié)果
查詢不存在的數(shù)據(jù)
手動(dòng)包裝page
自定義SQL

建庫建表

DROP DATABASE IF EXISTS mp;
CREATE DATABASE mp DEFAULT CHARACTER SET utf8;
USE mp;
 
DROP TABLE IF EXISTS `t_user`;
SET NAMES utf8mb4;
 
CREATE TABLE `t_user`
(
    `id`           BIGINT(0) NOT NULL AUTO_INCREMENT,
    `user_name`    VARCHAR(64) NOT NULL COMMENT '用戶名（不能重復(fù)）',
    `nick_name`    VARCHAR(64) NULL COMMENT '昵稱（可以重復(fù)）',
    `email`        VARCHAR(64) COMMENT '郵箱',
    `create_time`  DATETIME(0) NULL DEFAULT CURRENT_TIMESTAMP COMMENT '創(chuàng)建時(shí)間',
    `update_time`  DATETIME(0) NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改時(shí)間',
    `deleted_flag` BIGINT(0) NOT NULL DEFAULT 0 COMMENT '0：未刪除 其他：已刪除',
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `index_user_name_deleted_flag` (`user_name`, `deleted_flag`),
    KEY `index_create_time`(`create_time`)
) ENGINE = InnoDB COMMENT = '用戶';
 
INSERT INTO `t_user` VALUES (1, 'knife', '刀刃', 'abc@qq.com', '2021-01-23 09:33:36', '2021-01-23 09:33:36', 0);
INSERT INTO `t_user` VALUES (2, 'sky', '天藍(lán)', '123@qq.com', '2021-01-24 18:12:21', '2021-01-24 18:12:21', 0);

依賴

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.12.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>MyBatis-Plus_Simple</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>MyBatis-Plus_Simple</name>
    <description>Demo project for Spring Boot</description>
 
    <properties>
        <java.version>1.8</java.version>
    </properties>
 
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
 
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
 
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
 
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
 
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
 
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>
 
    </dependencies>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
 
</project>

配置

application.yml

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/mp?characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    username: root
    password: 222333
 
#mybatis-plus配置控制臺(tái)打印完整帶參數(shù)SQL語句
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

分頁插件配置（必須）

package com.example.demo.config;
 
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
 
@Configuration
public class MyBatisPlusConfig {
 
    /**
     * 分頁插件
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

代碼

Entity

package com.example.demo.user.entity;
 
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableLogic;
import com.baomidou.mybatisplus.annotation.TableName;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import lombok.Data;
 
import java.time.LocalDateTime;
 
@Data
@TableName(value = "t_user")
public class User {
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;
 
    /**
     * 用戶名（不能重復(fù)）
     */
    private String userName;
 
    /**
     * 昵稱（可以重復(fù)）
     */
    private String nickName;
 
    /**
     * 郵箱
     */
    private String email;
 
    /**
     * 創(chuàng)建時(shí)間
     */
    private LocalDateTime createTime;
 
    /**
     * 修改時(shí)間
     */
    private LocalDateTime updateTime;
 
    /**
     * 0：未刪除 其他：已刪除
     */
    @TableLogic(delval = "id")
    private Long deletedFlag;
}

Mapper

package com.example.demo.user.mapper;
 
import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.toolkit.Constants;
import com.example.demo.user.entity.User;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;
import org.springframework.stereotype.Repository;
 
@Repository
public interface UserMapper extends BaseMapper<User> {
    @Select("SELECT * FROM t_user ${ew.customSqlSegment}")
    IPage<User> findUser(IPage<User> page, @Param(Constants.WRAPPER) Wrapper wrapper);
}

Service

接口

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<User> {
}

實(shí)現(xiàn)

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<UserMapper, User> implements UserService {
}

Controller

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.toolkit.Wrappers;
import com.baomidou.mybatisplus.extension.conditions.query.LambdaQueryChainWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.user.entity.User;
import com.example.demo.user.mapper.UserMapper;
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("page")
public class PageController {
 
    @Autowired
    private UserService userService;
 
    // 我為了簡(jiǎn)單直接注入mapper，項(xiàng)目中controller要通過service調(diào)mapper
    @Autowired
    private UserMapper userMapper;
 
    @ApiOperation("不傳參數(shù)")
    @GetMapping("noParam")
    public IPage<User> noParam(Page<User> page) {
        return userService.page(page);
    }
 
    @ApiOperation("查不存在的數(shù)據(jù)")
    @GetMapping("notExist")
    public IPage<User> notExist(Page<User> page) {
        // 如果查出來為空，會(huì)返回入?yún)age里邊的數(shù)據(jù)，比如：current，size等。不需要自己判空。
        return userService.lambdaQuery()
                .eq(User::getUserName, "abcd")
                .page(page);
    }
 
    @ApiOperation("手動(dòng)包裝")
    @GetMapping("manualPack")
    public IPage<User> manualPack(Page<User> page) {
        List<User> skyList = userService.lambdaQuery()
                .eq(User::getUserName, "sky")
                .list();
 
        // 因?yàn)镻age是IPage的實(shí)現(xiàn)類，所以可以直接返回page
        // 也可以自己new 一個(gè)Page，然后設(shè)置值，不過這樣就麻煩了
        return page.setRecords(skyList);
    }
 
    @ApiOperation("自定義SQL")
    @GetMapping("customSQL")
    public IPage<User> customSQLPage(Page<User> page) {
        LambdaQueryWrapper<User> wrapper = Wrappers.lambdaQuery();
        wrapper.eq(User::getUserName, "sky");
 
        // 這樣寫會(huì)報(bào)錯(cuò)：MybatisPlusException: can not use this method for "getCustomSqlSegment"
        // LambdaQueryChainWrapper<User> wrapper = userService.lambdaQuery()
        //         .eq(User::getUserName, "sky");
 
        return userMapper.findUser(page, wrapper);
    }
}