MyBatis-Plus 分頁插件使用示例

更新時(shí)間：2025年07月29日 09:59:46 作者：wh_xia_jun

本文主要介紹了MyBatis-Plus 分頁插件使用示例,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

一、項(xiàng)目包結(jié)構(gòu)
二、實(shí)體類 (User.java)
三、Mapper 接口 (UserMapper.java)
四、Service 接口 (UserService.java)
五、Service 實(shí)現(xiàn) (UserServiceImpl.java)
六、Controller (UserController.java)
七、配置類 (MybatisPlusConfig.java)
八、啟動(dòng)類 (HisWebApplication.java)
九、使用示例

1. 訪問分頁接口
2. 帶條件的分頁查詢

十、分頁插件工作原理

十一、配置說明

一、項(xiàng)目包結(jié)構(gòu)

src/main/java
└─ com.neuedu.hisweb
   ├── config
   │   └── MybatisPlusConfig.java     // 配置類（已提供）
   ├── controller
   │   └── UserController.java        // 控制器
   ├── entity
   │   └── User.java                  // 實(shí)體類
   ├── mapper
   │   └── UserMapper.java            // Mapper 接口
   ├── service
   │   ├── UserService.java           // Service 接口
   │   └── impl
   │       └── UserServiceImpl.java   // Service 實(shí)現(xiàn)
   └── HisWebApplication.java         // 啟動(dòng)類

二、實(shí)體類 (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")  // 對(duì)應(yīng)數(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 后，自動(dòng)擁有 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 實(shí)現(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 方法，自動(dòng)生成分頁 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,  // 頁碼，默認(rèn)第1頁
            @RequestParam(defaultValue = "10") Integer pageSize  // 每頁條數(shù)，默認(rèn)10條
    ) {
        // 創(chuàng)建分頁對(duì)象
        Page<User> page = new Page<>(pageNum, pageSize);
        
        // 調(diào)用 Service 方法進(jìn)行分頁查詢
        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;
    }
}

八、啟動(dòng)類 (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=張

十、分頁插件工作原理

攔截器生效：
當(dāng)調(diào)用 selectPage() 方法時(shí)，PaginationInnerInterceptor 會(huì)攔截 SQL 查詢。

自動(dòng)生成分頁 SQL：

對(duì)于 MySQL，會(huì)自動(dòng)添加 LIMIT ? OFFSET ?。
對(duì)于 Oracle，會(huì)添加 ROWNUM 相關(guān)的分頁語法。

返回分頁結(jié)果：
結(jié)果包含總記錄數(shù)、總頁數(shù)、當(dāng)前頁數(shù)據(jù)等信息：

{
    "records": [ /* 當(dāng)前頁數(shù)據(jù) */ ],
    "total": 100,      // 總記錄數(shù)
    "size": 10,        // 每頁條數(shù)
    "current": 1,      // 當(dāng)前頁碼
    "pages": 10        // 總頁數(shù)
}

十一、配置說明

分頁插件配置：

// 可自定義分頁插件參數(shù)
PaginationInnerInterceptor paginationInterceptor = new PaginationInnerInterceptor();
paginationInterceptor.setMaxLimit(1000L);  // 限制單頁最大條數(shù)
paginationInterceptor.setOverflow(false);  // 溢出總頁數(shù)后是否進(jìn)行處理
interceptor.addInnerInterceptor(paginationInterceptor);

多數(shù)據(jù)源配置：
若使用多數(shù)據(jù)源，需指定數(shù)據(jù)庫類型：

paginationInterceptor.setDbType(DbType.MYSQL);

我們可以輕松實(shí)現(xiàn)分頁查詢功能，無需手動(dòng)編寫復(fù)雜的分頁 SQL。

到此這篇關(guān)于MyBatis-Plus 分頁插件使用示例的文章就介紹到這了,更多相關(guān)MyBatis-Plus 分頁插件內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

MyBatis-Plus 分頁插件使用示例

目錄

一、項(xiàng)目包結(jié)構(gòu)

二、實(shí)體類 (User.java)

三、Mapper 接口 (UserMapper.java)

四、Service 接口 (UserService.java)

五、Service 實(shí)現(xiàn) (UserServiceImpl.java)

六、Controller (UserController.java)

七、配置類 (MybatisPlusConfig.java)

八、啟動(dòng)類 (HisWebApplication.java)

九、使用示例

1. 訪問分頁接口

2. 帶條件的分頁查詢

十、分頁插件工作原理

十一、配置說明

相關(guān)文章

最新評(píng)論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具

最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

MyBatis-Plus 分頁插件使用示例

目錄

一、項(xiàng)目包結(jié)構(gòu)

二、實(shí)體類 (User.java)

三、Mapper 接口 (UserMapper.java)

四、Service 接口 (UserService.java)

五、Service 實(shí)現(xiàn) (UserServiceImpl.java)

六、Controller (UserController.java)

七、配置類 (MybatisPlusConfig.java)

八、啟動(dòng)類 (HisWebApplication.java)

九、使用示例

1. 訪問分頁接口

2. 帶條件的分頁查詢

十、分頁插件工作原理

十一、配置說明

相關(guān)文章

最新評(píng)論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具

二、實(shí)體類 (User.java)

三、Mapper 接口 (UserMapper.java)

四、Service 接口 (UserService.java)

五、Service 實(shí)現(xiàn) (UserServiceImpl.java)

六、Controller (UserController.java)

七、配置類 (MybatisPlusConfig.java)

八、啟動(dòng)類 (HisWebApplication.java)

九、使用示例

十、分頁插件工作原理

十一、配置說明