Java 分页指南：MyBatis 和 MyBatis-Plus 分页功能详解

最新推荐文章于 2024-12-30 17:11:55 发布
最新推荐文章于 2024-12-30 17:11:55 发布
阅读量1.2k 收藏 12
点赞数 24
文章标签： java mybatis spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ChinaTj001/article/details/144465677
版权

1. 使用 MyBatis 进行分页

1.1 使用 MyBatis 的 RowBounds

RowBounds 是 MyBatis 提供的一个简单分页工具类，可以在 SQL 执行时传入分页参数。

1. 创建实体类

假如我们有一个 User 实体类

public class User {
    private Long id;
    private String name;
    private Integer age;

    // Getters and Setters
}

2. 创建 Mapper 接口

定义一个 Mapper 接口，其中包含查询方法。

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
import java.util.List;

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM users")
    List<User> selectAllUsers();
}

3. 配置 MyBatis

确保 MyBatis 配置文件中正确配置了 Mapper 接口。

<mappers>
    <mapper class="com.example.mapper.UserMapper"/>
</mappers>

4. 使用 RowBounds 进行分页

在服务层或控制器中使用 RowBounds 进行分页查询。

import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.session.SqlSession;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;

@Service
public class UserService {
    @Autowired
    private SqlSession sqlSession;

    public List<User> getUsersByPage(int currentPage, int pageSize) {
        // 计算偏移量
        int offset = (currentPage - 1) * pageSize;
        // 创建 RowBounds 对象
        RowBounds rowBounds = new RowBounds(offset, pageSize);
        // 获取 UserMapper 实例
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        // 执行查询
        List<User> userList = userMapper.selectAllUsers(rowBounds);
        return userList;
    }
}

注意：使用 RowBounds 进行分页时，Mapper 接口中的方法签名不需要显式地包含 RowBounds 参数。MyBatis 会在内部处理 RowBounds 参数。因此，Mapper 接口的方法签名保持不变，但在调用时需要传递 RowBounds 对象。

5. 控制器类

在控制器中调用服务层的方法，返回分页结果。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;

@RestController
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping("/users")
    public List<User> getUsers(@RequestParam(defaultValue = "1") int page,
                               @RequestParam(defaultValue = "10") int size) {
        return userService.getUsersByPage(page, size);
    }
}

1.2 使用 MyBatis 的插件（如 PageHelper）

PageHelper 是一个第三方分页插件，可以方便地实现物理分页。

使用步骤：

1. 添加依赖

在 pom.xml 中添加 PageHelper 依赖

   <dependency>
       <groupId>com.github.pagehelper</groupId>
       <artifactId>pagehelper</artifactId>
       <version>5.3.0</version>
   </dependency>

2. 配置插件

在 MyBatis 的配置文件中配置 PageHelper 插件：

   <plugins>
       <plugin interceptor="com.github.pagehelper.PageInterceptor">
           <!-- 配置参数 -->
           <property name="helperDialect" value="mysql"/>
           <property name="reasonable" value="true"/>
       </plugin>
   </plugins>

3. 使用插件

在需要分页的地方使用 PageHelper.startPage 方法：

   // 设置分页参数
   int pageNum = 1; // 当前页码
   int pageSize = 10; // 每页大小

   // 开始分页
   PageHelper.startPage(pageNum, pageSize);
   // 执行查询
   List<YourEntity> resultList = sqlSession.selectList("yourNamespace.yourSelectId");
   // 获取分页信息
   PageInfo<YourEntity> pageInfo = new PageInfo<>(resultList);

友情提示：由于 RowBounds 是在内存中进行分页，当数据量较大时，可能会导致性能问题。建议在数据量较大的情况下使用物理分页（如 PageHelper 或手动编写分页 SQL）。

2. 使用 MyBatis-Plus 进行分页

MyBatis-Plus 是一个 MyBatis 的增强工具，旨在简化开发、提高效率。它提供了内置的分页插件 PaginationInterceptor。
使用步骤：

2.1 添加依赖

在 pom.xml 中添加 MyBatis-Plus 依赖：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.3</version>
</dependency>

2.2 配置分页插件

在 Spring Boot 配置类中配置 PaginationInterceptor：

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;

@Configuration
public class MyBatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        return interceptor;
    }
}

2.3 使用分页插件

在需要分页的地方使用 Page 对象：

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class YourService {
    @Autowired
    private YourMapper yourMapper;

    public Page<YourEntity> getPaginatedData(int currentPage, int pageSize) {
        // 创建分页对象
        Page<YourEntity> page = new Page<>(currentPage, pageSize);
        // 创建查询条件
        QueryWrapper<YourEntity> queryWrapper = new QueryWrapper<>();
        // 执行分页查询
        Page<YourEntity> pageResult = yourMapper.selectPage(page, queryWrapper);
        return pageResult;
    }
}

特点：

  • 内置分页插件：无需额外引入第三方插件，使用简单。
  • 功能强大：支持多种分页方式，包括排序、过滤等。
  • 集成良好：与 MyBatis-Plus 其他功能无缝集成。

3. 不使用 MyBatis 和 MyBatis-Plus 的插件进行分页

如果不使用 MyBatis 和 MyBatis-Plus 的插件，可以通过手动编写分页逻辑来实现分页功能。

3.1 手动编写分页 SQL

手动在 SQL 语句中添加分页逻辑，适用于需要高度定制化分页逻辑的情况。
示例代码：

<select id="selectPagedData" resultType="YourEntity">
    SELECT *
    FROM your_table
    ORDER BY some_column
    LIMIT #{offset}, #{pageSize}
</select>

Java 代码：

// 定义每页大小和当前页码
int pageSize = 10;
int currentPage = 1;

// 计算偏移量
int offset = (currentPage - 1) * pageSize;

// 创建参数对象
Map<String, Object> params = new HashMap<>();
params.put("offset", offset);
params.put("pageSize", pageSize);

// 执行查询
List<YourEntity> resultList = sqlSession.selectList("yourNamespace.selectPagedData", params);

特点：

  • 灵活性高：可以根据具体需求编写复杂的分页逻辑。
  • 性能较好：在数据库层面进行分页，性能较好。
  • 复杂度较高：需要手动编写分页相关的 SQL 语句。

3.2 使用原生 JDBC 进行分页

使用原生 JDBC 进行分页操作，适用于不使用任何 ORM 框架的情况。
示例代码：

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.ArrayList;
import java.util.List;

public class JdbcPagingExample {

    public static void main(String[] args) {
        String url = "jdbc:mysql://localhost:3306/your_database";
        String user = "your_user";
        String password = "your_password";

        int pageSize = 10;
        int currentPage = 1;
        int offset = (currentPage - 1) * pageSize;

        try (Connection conn = DriverManager.getConnection(url, user, password)) {
            String sql = "SELECT * FROM your_table ORDER BY some_column LIMIT ? OFFSET ?";
            try (PreparedStatement pstmt = conn.prepareStatement(sql)) {
                pstmt.setInt(1, pageSize);
                pstmt.setInt(2, offset);

                try (ResultSet rs = pstmt.executeQuery()) {
                    List<YourEntity> resultList = new ArrayList<>();
                    while (rs.next()) {
                        YourEntity entity = new YourEntity();
                        // 设置实体属性
                        resultList.add(entity);
                    }
                    // 处理结果集
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

特点：

  • 完全控制：对 SQL 和数据库操作有完全的控制权。
  • 灵活性高：可以根据具体需求编写复杂的分页逻辑。
  • 复杂度较高：需要手动处理数据库连接、SQL 执行和结果集解析。
ChinaTj001
关注
Spring Boot进阶(04)：震惊！使用MyBatis-Plus，快速实现自定义SQL分页功能！
**My Coding Family**
04-29 3621
如何快速实现自定义sql分页？若不会，我便手把手教你！
Mybatis最简单分页处理工具
08-10
简单便捷对商品列表进行分页处理，手把手教你实现，内部有jar和工具类
MyBatis Plus 实现分页功能
weixin_46242847的博客
09-21 2094
一分钟教会你实现分页
mybats-plus分页高效封装
weixin_52136521的博客
12-04 447
一般来说，我们每次的查询结果都要进行这么一个转换，因为查询结果里面的属性太多了，不适合都给前端，下图是查询结果Page的源码，可以看见里面除了我们需要的records、total、pages（pages在IPage里面），还有很多其他属性，我们无需传给前端的，所以上述PageDto类封装了of方法进行转换，用过 BeanUtil.copyProperties()方法的就知道这是什么意思了，没用过也没关系，总而言之就是给数据瘦身，只返回部分查询结果给前端。// records是查询结果。
SpringBoot整合MyBatis四种常用的分页方式
目前专注区块链相关技术的学习与分享
04-05 3090
扩展：PageHelper.startPage(int PageNum,int PageSize):用来设置页面的位置和展示的数据条目数，我们设置每页展示5条数据。PageInfo用来封装页面信息，返回给前台界面。PageInfo中的一些我们需要用到的参数如下表：
java mybatis分页_MyBatis3-实现MyBatis分页
weixin_34207787的博客
02-24 75
packagecom.jsoft.testmybatis.util;importjava.lang.reflect.Field;importjava.sql.Connection;importjava.sql.PreparedStatement;importjava.sql.ResultSet;importjava.sql.SQLException;importjava.util.List;imp...
mybatis-plus 中的page分页已有的list
yinglincha4297的博客
05-18 2059
public class PageListUtils { /** * 分页函数 * @param currentPage 当前页数 * @param pageSize 每一页的数据条数 * @param list 要进行分页的数据列表 * @return 当前页要展示的数据 */ public Page getPages(Integer currentPage, Integer pageSize, List list) {...
如何使用Mybatis-plus进行分页
热门推荐
AALouisaa的博客
08-20 9万+
利用mybatis-plus进行分页！！！
mybatis-plus分页方式
aiwokache的博客
02-23 2万+
mybatis-plus分页方式
【Mybatis-Plus】分页简单使用
人类所有真实的快乐，一定是恒久的努力
09-09 8万+
【Mybatis-Plus】分页简单使用
【MyBatis Plus】使用 MyBatis Plus 完成分页功能，以及通用分页实体的实现
qq_61635026的博客
11-02 2万+
使用 MyBatis Plus 完成分页功能，以及通用分页实体的实现
sqlserver-demo：Spring Boot + Mybatis-Plus + SQLServer
03-04
3. **Mybatis-Plus**：基于Mybatis和Spring Boot的轻量级ORM框架，是对Mybatis的扩展，简化了常见的 CRUD 操作，提供了诸如分页、条件构造器等功能。Mybatis-Plus使得开发者可以专注于业务逻辑，而无需关心底层的SQL...
mybatis-plus优缺点
02-22
### Mybatis-Plus优缺点详解 #### 一、框架介绍 Mybatis-Plus是一个针对MyBatis框架的增强工具包，旨在简化常见的CRUD（创建、读取、更新、删除）操作，提升开发效率。它在不改变原有MyBatis核心功能的基础上，...
mybatis-plus-3.0.zip
12-19
- **MyBatis-Plus**: MyBatis-Plus是在MyBatis的基础上进行扩展，它提供了一些额外的功能，如自动填充公共字段、条件构造器、分页插件等，使得开发更加便捷。 2. **主要特性** - **自动填充**: MyBatis-Plus提供...
mybatis-plus-samples
05-15
《MyBatis-Plus-Samples 源码详解与应用实践》 MyBatis-Plus 是 MyBatis 的一个扩展，它为开发者提供了强大的 CRUD 操作以及更多实用功能，极大地简化了开发工作。本篇文章将深入探讨 `mybatis-plus-samples` 项目...
mybatis-plus-demo.zip
09-15
4. **MyBatis-Plus 功能详解** - CRUD 操作：通过注解或继承 `BaseMapper`，可以快速实现增删查改操作，例如 `insert`, `deleteById`, `selectById`, `updateById` 等。 - 查询构造器：使用 `QueryWrapper` 或 `...
你真的懂Mybatis分页原理吗？
qq_38196449的博客
08-13 1454
MyBatis可以通过两种方式来实现分页：基于和基于。所谓物理分页，指的是最终执行的SQL中进行分页，即SQL语句中带limit，这样SQL语句执行之后返回的内容就是分页后的结果。所谓逻辑分页，就是在SQL语句中不进行分页，照常全部查询，在查询到的结果集中，再进行分页。
MyBatis如何实现分页
刘皇叔说Java的博客
04-09 7035
如果你使用的数据库不支持特定的分页语法，或者想要更多灵活性，你可以通过自定义 SQL 实现分页逻辑。通常，你需要通过 RowBounds 或 PageHelper 来实现分页。
MyBatis-Plus 中的分页插件配置
最新发布
李长渊的博客
12-30 1623
MyBatis-Plus 中的分页插件配置
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值