MyBatis-Plus 分頁插件使用示例
更新時間：2025年07月29日 09:59:46 作者：wh_xia_jun
本文主要介紹了MyBatis-Plus 分頁插件使用示例,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧
一、項目包結(jié)構(gòu)
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 實現(xiàn) └── 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") // 對應數(shù)據(jù)庫表名
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 實現(xiàn) (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 參數(shù)包含頁碼和每頁條數(shù)
// 調(diào)用 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 // 每頁條數(shù)，默認10條
) {
// 創(chuàng)建分頁對象
Page<User> page = new Page<>(pageNum, pageSize);
// 調(diào)用 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 // 可選參數(shù)：用戶名
) {
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() {
// 創(chuàng)建 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=張
十、分頁插件工作原理
攔截器生效：
當調(diào)用 selectPage() 方法時，PaginationInnerInterceptor 會攔截 SQL 查詢。
自動生成分頁 SQL：
- 對于 MySQL，會自動添加
LIMIT ? OFFSET ?。 - 對于 Oracle，會添加
ROWNUM相關(guān)的分頁語法。
返回分頁結(jié)果：
結(jié)果包含總記錄數(shù)、總頁數(shù)、當前頁數(shù)據(jù)等信息：
{
"records": [ /* 當前頁數(shù)據(jù) */ ],
"total": 100, // 總記錄數(shù)
"size": 10, // 每頁條數(shù)
"current": 1, // 當前頁碼
"pages": 10 // 總頁數(shù)
}十一、配置說明
分頁插件配置：
// 可自定義分頁插件參數(shù) PaginationInnerInterceptor paginationInterceptor = new PaginationInnerInterceptor(); paginationInterceptor.setMaxLimit(1000L); // 限制單頁最大條數(shù) paginationInterceptor.setOverflow(false); // 溢出總頁數(shù)后是否進行處理 interceptor.addInnerInterceptor(paginationInterceptor);
多數(shù)據(jù)源配置：
若使用多數(shù)據(jù)源，需指定數(shù)據(jù)庫類型：
paginationInterceptor.setDbType(DbType.MYSQL);
我們可以輕松實現(xiàn)分頁查詢功能，無需手動編寫復雜的分頁 SQL。
到此這篇關(guān)于MyBatis-Plus 分頁插件使用示例的文章就介紹到這了,更多相關(guān)MyBatis-Plus 分頁插件內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要給大家介紹了關(guān)于快速測試API接口的一個新技能，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2018-06-06
這篇文章主要為大家詳細介紹了java遞歸實現(xiàn)科赫雪花，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-06-06
Spring定時任務@Scheduled注解(cron表達式fixedRate?fixedDelay)
這篇文章主要為大家介紹了Spring定時任務@Scheduled注解(cron表達式fixedRate?fixedDelay)使用詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-11-11
上篇文章已經(jīng)給大家介紹了Springboot項目如何快速實現(xiàn)Aop功能，這篇文章給大家介紹Springboot項目如何快速實現(xiàn)過濾器功能，感興趣的小伙伴可以參考閱讀2023-03-03
Java邏輯運算符之&&、||?與&、?|的區(qū)別及應用
這篇文章主要介紹了Java邏輯運算符之&&、||?與&、?|的區(qū)別及應用的相關(guān)資料,分別是&&、||?與&、?|,并探討了它們在不同應用場景中的表現(xiàn)和優(yōu)化效果,需要的朋友可以參考下2025-03-03
Java實戰(zhàn)玩具商城的前臺與后臺實現(xiàn)流程
讀萬卷書不如行萬里路，只學書上的理論是遠遠不夠的，只有在實戰(zhàn)中才能獲得能力的提升，本篇文章手把手帶你用java+JSP+SSM+Springboot+Jsp+maven+Mysql實現(xiàn)一個玩具商城系統(tǒng),大家可以在過程中查缺補漏，提升水平2022-01-01
SpringCloud OpenFeign Post請求400錯誤解決方案
這篇文章主要介紹了SpringCloud OpenFeign Post請求400錯誤解決方案,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-09-09
SpringBoot項目中獲取resources下靜態(tài)文件時遇到的坑及解決
文章總結(jié)：在項目中使用靜態(tài)圖片時,遇到jar包部署到linux服務器報錯的問題,解決方法包括將圖片上傳到服務器指定文件夾或使用ClassPathResource讀取,前者需要維護,后者更方便2024-11-11
Springboot?Vue實現(xiàn)單點登陸功能示例詳解
這篇文章主要為大家介紹了Springboot?Vue實現(xiàn)單點登陸功能示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-01-01
SpringBoot2零基礎到精通之JUnit 5與指標監(jiān)控
SpringBoot是一種整合Spring技術(shù)棧的方式(或者說是框架)，同時也是簡化Spring的一種快速開發(fā)的腳手架，本篇讓我們一起學習JUnit 5與指標監(jiān)控2022-03-03