PageHelper 分页功能使用说明

2025-06-17后端2 分钟128 次阅读
AI 摘要鱼粮不足,AI 今天先歇着 · 正文在下面

前言

在使用 Mybatis 框架时,我们系统可以集成 PageHelper 插件,它提供多种分页方式,支持 offsetPage(offset, limit) 方法进行分页参数处理。

1. 配置说明

Maven 依赖

项目已配置 PageHelper 依赖:

xml 复制代码
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>4.1.3</version>
</dependency>

MyBatis 配置

在 mybatis-config.xml 中已配置 PageHelper 插件,支持:

  • MySQL 数据库方言
  • offset 作为页码使用
  • RowBounds 分页统计
  • 分页参数合理化

2. 分页方式

方式一:传统 pageNum + pageSize

java 复制代码
// Controller 层
@RequestMapping("/findByPage")
public JsonResult findStudentByPage(StudentQueryParam param) {
    PageResult<Student> pageResult = studentService.findStudentByPage(param);
    return JsonResult.success(pageResult);
}

// 前端调用
// GET /student/findByPage?pageNum=1&pageSize=10&name=张三

方式二:offset + limit 参数

java 复制代码
// Controller 层  
@RequestMapping("/findByOffset")
public JsonResult findStudentByOffset(StudentQueryParam param, 
                                     @RequestParam Integer offset,
                                     @RequestParam Integer limit) {
    // 转换为 pageNum 和 pageSize
    param.setPageNum((offset / limit) + 1);
    param.setPageSize(limit);
    
    PageResult<Student> pageResult = studentService.findStudentByPage(param);
    return JsonResult.success(pageResult);
}

// 前端调用
// GET /student/findByOffset?offset=0&limit=10&name=张三

方式三:Service 层直接使用 offsetPage

java 复制代码
// Service 层实现
@Override
public PageResult<Student> findStudentByPage(StudentQueryParam param) {
    // 计算 offset
    int offset = (param.getPageNum() - 1) * param.getPageSize();
    
    // 使用 PageHelper.offsetPage 方法
    PageHelper.offsetPage(offset, param.getPageSize());
    
    // 执行查询(不包含 LIMIT 的 SQL)
    List<Student> students = studentDAO.findStudentList(param);
    
    // 获取分页信息
    PageInfo<Student> pageInfo = new PageInfo<>(students);
    
    // 返回结果
    return new PageResult<>(pageInfo.getTotal(), students, 
                           param.getPageNum(), param.getPageSize());
}

方式四:使用工具类(推荐)

java 复制代码
// 使用 PageHelperUtil 工具类
@Override
public PageResult<Student> findStudentByPage(StudentQueryParam param) {
    return PageHelperUtil.pageNumToOffset(param.getPageNum(), param.getPageSize(), 
            () -> studentDAO.findStudentList(param));
}

// 直接使用 offset 和 limit
public PageResult<Student> findStudentByOffset(StudentQueryParam param, 
                                              int offset, int limit) {
    return PageHelperUtil.offsetPage(offset, limit, 
            () -> studentDAO.findStudentList(param));
}

3. API 接口说明

学生信息分页接口

3.1 传统分页查询

  • 接口: GET /student/findByPage
  • 参数:
    • pageNum: 页码(从1开始)
    • pageSize: 每页大小
    • name: 学生姓名(可选)
    • studentId: 学号(可选)
    • major: 专业(可选)
    • grade: 年级(可选)

3.2 Offset 分页查询

  • 接口: GET /student/findByOffset
  • 参数:
    • offset: 偏移量(从0开始)
    • limit: 限制数量
    • 其他查询条件同上

教师信息分页接口

3.3 传统分页查询

  • 接口: GET /teacher/findByPage
  • 参数:
    • pageNum: 页码(从1开始)
    • pageSize: 每页大小
    • name: 教师姓名(可选)
    • teacherId: 工号(可选)
    • department: 部门(可选)

3.4 Offset 分页查询

  • 接口: GET /teacher/findByOffset
  • 参数:
    • offset: 偏移量(从0开始)
    • limit: 限制数量
    • 其他查询条件同上

4. 响应格式

json 复制代码
{
    "code": 200,
    "message": "success",
    "data": {
        "total": 100,
        "list": [...],
        "pageNum": 1,
        "pageSize": 10,
        "totalPages": 10,
        "offset": 0,
        "hasNext": true,
        "hasPrev": false
    }
}

5. 使用示例

前端 JavaScript 调用示例

javascript 复制代码
// 传统分页
function loadStudents(pageNum = 1, pageSize = 10) {
    $.get('/student/findByPage', {
        pageNum: pageNum,
        pageSize: pageSize,
        name: $('#searchName').val()
    }, function(result) {
        if (result.code === 200) {
            renderTable(result.data.list);
            renderPagination(result.data);
        }
    });
}

// Offset 分页
function loadStudentsByOffset(offset = 0, limit = 10) {
    $.get('/student/findByOffset', {
        offset: offset,
        limit: limit,
        name: $('#searchName').val()
    }, function(result) {
        if (result.code === 200) {
            renderTable(result.data.list);
            renderPagination(result.data);
        }
    });
}

6. 注意事项

  1. offset 计算: offset = (pageNum - 1) * pageSize
  2. SQL 优化: 使用 findStudentList 等不包含 LIMIT 的查询方法
  3. 参数验证: 确保 offset ≥ 0 且 limit > 0
  4. 性能考虑: 大数据量时建议限制最大页数或使用游标分页
  5. 兼容性: 支持传统分页和 offset 分页两种方式,便于前端灵活选择

7. 扩展功能

  • 排序支持: 可在查询参数中添加 orderBy 字段
  • 多条件查询: 支持复合查询条件
  • 统计信息: 提供总页数、是否有上/下页等信息
  • 缓存优化: 可考虑对热点数据进行缓存
觉得有用就点个赞,不用登录也能读

评论

0 条
登录 之后才能评论
—
还没有评论,来说第一句