MyBatis-Plus 分页插件使用示例

 更新时间:2025年07月29日 09:59:46   作者:wh_xia_jun  
本文主要介绍了MyBatis-Plus 分页插件使用示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

一、项目包结构

src/main/java
└─ com.neuedu.hisweb
   ├── config
   │   └── MybatisPlusConfig.java     // 配置类(已提供)
   ├── controller
   │   └── UserController.java        // 控制器
   ├── entity
   │   └── User.java                  // 实体类
   ├── mapper
   │   └── UserMapper.java            // Mapper 接口
   ├── service
   │   ├── UserService.java           // Service 接口
   │   └── impl
   │       └── UserServiceImpl.java   // Service 实现
   └── HisWebApplication.java         // 启动类

二、实体类 (User.java)

package com.neuedu.hisweb.entity;
 
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
 
@Data
@TableName("user")  // 对应数据库表名
public class User {
    @TableId  // 主键注解
    private Long id;
    private String username;
    private String password;
    private Integer age;
    private String email;
}

三、Mapper 接口 (UserMapper.java)

package com.neuedu.hisweb.mapper;
 
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.neuedu.hisweb.entity.User;
import org.apache.ibatis.annotations.Mapper;
 
@Mapper
public interface UserMapper extends BaseMapper<User> {
    // 继承 BaseMapper 后,自动拥有 CRUD 方法
    // 无需编写 selectById, insert, update, delete 等方法
}

四、Service 接口 (UserService.java)

package com.neuedu.hisweb.service;
 
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.neuedu.hisweb.entity.User;
 
public interface UserService {
    // 分页查询用户列表
    IPage<User> getUserPage(Page<User> page);
    
    // 条件分页查询
    IPage<User> getUserPageByCondition(Page<User> page, String username);
}

五、Service 实现 (UserServiceImpl.java)

package com.neuedu.hisweb.service.impl;
 
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.neuedu.hisweb.entity.User;
import com.neuedu.hisweb.mapper.UserMapper;
import com.neuedu.hisweb.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
 
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
    
    @Autowired
    private UserMapper userMapper;
    
    // 分页查询所有用户
    @Override
    public IPage<User> getUserPage(Page<User> page) {
        // Page 参数包含页码和每页条数
        // 调用 BaseMapper 的 selectPage 方法,自动生成分页 SQL
        return userMapper.selectPage(page, null);  // null 表示无查询条件
    }
    
    // 条件分页查询
    @Override
    public IPage<User> getUserPageByCondition(Page<User> page, String username) {
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.like("username", username);  // 模糊查询用户名
        
        // 带条件的分页查询
        return userMapper.selectPage(page, queryWrapper);
    }
}

六、Controller (UserController.java)

package com.neuedu.hisweb.controller;
 
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.neuedu.hisweb.entity.User;
import com.neuedu.hisweb.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
 
@RestController
@RequestMapping("/api/users")
public class UserController {
    
    @Autowired
    private UserService userService;
    
    // 分页查询用户列表
    @GetMapping("/page")
    public IPage<User> getUserPage(
            @RequestParam(defaultValue = "1") Integer pageNum,  // 页码,默认第1页
            @RequestParam(defaultValue = "10") Integer pageSize  // 每页条数,默认10条
    ) {
        // 创建分页对象
        Page<User> page = new Page<>(pageNum, pageSize);
        
        // 调用 Service 方法进行分页查询
        return userService.getUserPage(page);
    }
    
    // 条件分页查询
    @GetMapping("/page/condition")
    public IPage<User> getUserPageByCondition(
            @RequestParam(defaultValue = "1") Integer pageNum,
            @RequestParam(defaultValue = "10") Integer pageSize,
            @RequestParam(required = false) String username  // 可选参数:用户名
    ) {
        Page<User> page = new Page<>(pageNum, pageSize);
        
        // 带条件的分页查询
        return userService.getUserPageByCondition(page, username);
    }
}

七、配置类 (MybatisPlusConfig.java)

package com.neuedu.hisweb.config;
 
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;
 
/**
 * MyBatis-Plus 配置类
 */
@Configuration
public class MybatisPlusConfig {
 
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        // 创建 MyBatis-Plus 拦截器管理器
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        
        // 添加分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        
        // 可以添加其他插件(如乐观锁、逻辑删除等)
        // interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        
        return interceptor;
    }
}

八、启动类 (HisWebApplication.java)

package com.neuedu.hisweb;
 
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
@MapperScan("com.neuedu.hisweb.mapper")  // 扫描 Mapper 接口
public class HisWebApplication {
    public static void main(String[] args) {
        SpringApplication.run(HisWebApplication.class, args);
    }
}

九、使用示例

1. 访问分页接口

通过浏览器或 Postman 访问:

GET http://localhost:8080/api/users/page?pageNum=1&pageSize=5 

2. 带条件的分页查询

GET http://localhost:8080/api/users/page/condition?pageNum=1&pageSize=5&username=张 

十、分页插件工作原理

拦截器生效
当调用 selectPage() 方法时,PaginationInnerInterceptor 会拦截 SQL 查询。

自动生成分页 SQL

  • 对于 MySQL,会自动添加 LIMIT ? OFFSET ?
  • 对于 Oracle,会添加 ROWNUM 相关的分页语法。

返回分页结果
结果包含总记录数、总页数、当前页数据等信息:

{
    "records": [ /* 当前页数据 */ ],
    "total": 100,      // 总记录数
    "size": 10,        // 每页条数
    "current": 1,      // 当前页码
    "pages": 10        // 总页数
}

十一、配置说明

分页插件配置

// 可自定义分页插件参数
PaginationInnerInterceptor paginationInterceptor = new PaginationInnerInterceptor();
paginationInterceptor.setMaxLimit(1000L);  // 限制单页最大条数
paginationInterceptor.setOverflow(false);  // 溢出总页数后是否进行处理
interceptor.addInnerInterceptor(paginationInterceptor);

多数据源配置
若使用多数据源,需指定数据库类型:

paginationInterceptor.setDbType(DbType.MYSQL);

我们可以轻松实现分页查询功能,无需手动编写复杂的分页 SQL。

到此这篇关于MyBatis-Plus 分页插件使用示例的文章就介绍到这了,更多相关MyBatis-Plus 分页插件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 轻松掌握Java备忘录模式

    轻松掌握Java备忘录模式

    这篇文章主要帮助大家轻松掌握Java备忘录模式,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-09-09
  • Java中List.sort()自定义排序规则几种方式

    Java中List.sort()自定义排序规则几种方式

    Java中可通过Comparator匿名类、Lambda表达式、静态方法、自定义对象及实现Comparable接口实现List排序,这篇文章主要介绍了Java中List.sort()自定义排序规则几种方式,需要的朋友可以参考下
    2025-06-06
  • 从基础到实战全解析Java加载Properties文件的六种方式

    从基础到实战全解析Java加载Properties文件的六种方式

    本文详细介绍了Java中Properties文件的六种加载方式,每种方式都有其适用场景、实现步骤、优缺点及最佳实践,本文结合实例代码给大家介绍的非常详细,感兴趣的朋友一起看看吧
    2025-12-12
  • 详解SpringCloud新一代网关Gateway

    详解SpringCloud新一代网关Gateway

    SpringCloud Gateway是Spring Cloud的一个全新项目,Spring 5.0+ Spring Boot 2.0和Project Reactor等技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的API路由管理方式
    2021-06-06
  • RabbitMQ 避免消息重复消费的方法

    RabbitMQ 避免消息重复消费的方法

    消费者端实现幂等性,意味着消息永远不会消费多次,即使收到了多条一样的消息,这篇文章给大家分享RabbitMQ 避免消息重复消费的方法,感兴趣的朋友一起看看吧
    2024-03-03
  • intellij idea设置统一JavaDoc模板的方法详解

    intellij idea设置统一JavaDoc模板的方法详解

    这篇文章主要介绍了intellij idea设置统一JavaDoc模板的方法详解,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-04-04
  • Java Bluetooth 蓝牙通讯 BlueCove 扫描附近的蓝牙设备(测试代码)

    Java Bluetooth 蓝牙通讯 BlueCove 扫描附近的蓝牙设备(测试代码)

    BlueCove是一个开源的蓝牙协议栈实现,旨在为Java开发者提供一个全面的、易于使用的API,从而在应用程序中实现蓝牙功能,该项目支持多种操作系统,这篇文章主要介绍了Java Bluetooth 蓝牙通讯 BlueCove 扫描附近的蓝牙设备,需要的朋友可以参考下
    2025-01-01
  • springboot启动报错Failed to load class [javax.servlet.Filter]的解决

    springboot启动报错Failed to load class [java

    这篇文章主要介绍了springboot启动报错Failed to load class [javax.servlet.Filter]的解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2026-03-03
  • java.io.UnsupportedEncodingException异常的正确解决方法(亲测有效!)

    java.io.UnsupportedEncodingException异常的正确解决方法(亲测有效!)

    这篇文章主要给大家介绍了关于java.io.UnsupportedEncodingException异常的正确解决方法,文中介绍的办法亲测有效,java.io.UnsupportedEncodingException是Java编程语言中的一个异常类,表示指定的字符集不被支持,需要的朋友可以参考下
    2024-02-02
  • MybatisPlus BaseMapper 中的方法全部 Invalid bound statement (not found Error处理)

    MybatisPlus BaseMapper 中的方法全部 Invalid bound statement (not f

    这篇文章主要介绍了MybatisPlus BaseMapper 中的方法全部 Invalid bound statement (not found)的Error处理方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-09-09

最新评论