若依框架中如何从Body获取分页参数？

Question

在使用若依（RuoYi）框架进行开发时，前端通过 POST 请求将分页参数（如 pageNum、pageSize）封装在请求体（Body）中传递，但后端 Controller 无法正常接收到分页参数。常见表现为参数为 null 或使用默认值，导致分页查询失效。问题通常出现在未正确使用 `@RequestBody` 注解或未将参数封装为对象。那么，如何在若依框架中通过 Body 正确接收分页参数并实现分页查询？

Answer 1

1. 问题背景与现象分析

在使用若依（RuoYi）框架进行前后端分离开发时，前端通常通过 POST 请求将分页参数（如 pageNum、pageSize）封装在请求体（Body）中发送。然而，部分开发者在后端 Controller 中直接使用基本类型或未加注解的参数接收时，发现这些参数始终为 null 或使用默认值，导致分页功能失效。

典型错误代码如下：

@PostMapping("/list")
public TableDataInfo list(int pageNum, int pageSize) {
    startPage(); // 分页插件方法
    List<User> list = userService.selectUserList();
    return getDataTable(list);
}
    

该写法无法正确从 Body 中提取 JSON 数据，因为 Spring MVC 默认从 URL 查询参数（Query Params）中绑定简单类型，而不会解析请求体中的 JSON 内容。

2. 核心原因剖析

当请求以 application/json 类型提交时，数据位于请求体中，必须通过 @RequestBody 注解才能触发 HTTP 消息转换器（如 Jackson）进行反序列化。若未使用该注解，Spring 将尝试从表单或查询字符串中绑定参数，从而导致 Body 数据被忽略。

此外，若依框架内置了基于 MyBatis-Plus 或 PageHelper 的分页机制，其依赖于线程本地变量（ThreadLocal）存储分页信息，因此需确保分页参数能正确传入并调用 startPage() 方法。

3. 解决方案设计路径

1. 定义统一的分页请求对象（PageQuery），用于封装所有分页相关字段
2. 在 Controller 层使用 @RequestBody 接收 JSON 请求体
3. 调用若依提供的 startPage() 工具方法启动分页拦截
4. 执行业务查询并返回 TableDataInfo 结构化响应
5. 前端配合发送 JSON 格式 Body，而非 form-data 或 query 参数

4. 实现步骤详解

步骤	操作内容	关键代码/说明
1	创建分页请求 DTO	public class PageQuery { private Integer pageNum; private Integer pageSize; }
2	Controller 添加 @RequestBody	@RequestBody PageQuery query
3	调用 startPage 方法	startPage(query.getPageNum(), query.getPageSize());
4	执行服务层查询	userService.selectUserList()
5	返回 TableDataInfo	return getDataTable(resultList);

5. 完整代码示例

// DTO 类：PageQuery.java
public class PageQuery {
    private Integer pageNum = 1;
    private Integer pageSize = 10;

    // getter/setter 省略
}

// Controller 示例
@RestController
@RequestMapping("/user")
public class UserController extends BaseController {

    @Autowired
    private IUserService userService;

    @PostMapping("/list")
    public TableDataInfo list(@RequestBody PageQuery query) {
        startPage(query.getPageNum(), query.getPageSize());
        List<User> list = userService.selectUserList(new User());
        return getDataTable(list);
    }
}
    

6. 前端请求格式要求

前端必须设置 Content-Type 为 application/json，并以 JSON 对象形式传递参数：

fetch('/user/list', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ pageNum: 1, pageSize: 10 })
})
    

若仍使用 application/x-www-form-urlencoded 或未序列化为 JSON，则会导致后端无法解析。

7. 流程图：分页请求处理流程

graph TD
            A[前端发起POST请求] --> B{Content-Type是否为application/json?}
            B -- 是 --> C[Spring MVC调用消息转换器]
            B -- 否 --> D[参数绑定失败或为空]
            C --> E[@RequestBody反序列化为PageQuery对象]
            E --> F[调用startPage(pageNum, pageSize)]
            F --> G[执行SQL查询并自动分页]
            G --> H[封装为TableDataInfo返回]
            H --> I[前端接收分页数据]

8. 扩展思考：通用分页封装优化

为进一步提升可维护性，可在基类中抽象出通用分页处理逻辑：

public abstract class BaseBusinessController<T> {
    
    protected TableDataInfo getDataTable(List<T> list, PageQuery query) {
        startPage(query.getPageNum(), query.getPageSize());
        return getDataTable(list);
    }
}
    

结合泛型与模板模式，减少重复代码，增强类型安全性。

9. 调试建议与常见陷阱

• 检查浏览器 DevTools 中 Network 面板的 Request Payload 是否为合法 JSON
• 确认 Controller 参数前是否有 @RequestBody
• 避免混合使用 @RequestParam 与 Body 参数
• 日志输出 query 对象内容，验证是否成功反序列化
• 注意 Integer 包装类与 int 基本类型的差异，防止空指针异常
• 若启用了全局异常处理，捕获 MethodArgumentNotValidException 等参数绑定异常

10. 若依框架特性适配说明

若依框架通过 BaseController 提供了 startPage() 和 getDataTable() 方法，底层依赖 PageHelper 插件实现物理分页。该机制基于 ThreadLocal 存储当前线程的分页参数，因此必须保证在同一线程内完成“设置分页 → 执行查询”的过程。

若在异步或新线程中执行查询，需手动传递分页上下文，否则分页将失效。