解决PageHelper的上下文问题导致SQL查询结果不正确

前言

问题的场景是偶尔出现某个查询接口查询出来的结果集不对，现象都是清一色的缺少条数，而且是偶发。

经过代码跟踪和复现，发现是PageHelper没有正确使用导致的上下文问题。

一、原因是什么

这个问题的根源通常出现在 PageHelper 的分页上下文没有被正确清理，导致分页上下文在没有显式调用 startPage 的情况下，影响了后续的查询执行。

二、可能原因及解决方案

1. PageHelper的上下文被意外继承

在 PageHelper.startPage 调用之后，如果你有条件判断导致某些 SQL 查询没有执行，而其他查询方法仍然执行时，分页上下文可能会被错误地传递到这些查询中。

PageHelper 在后台会通过线程局部变量（ThreadLocal）来管理分页信息，如果分页上下文没有被清理，后续的查询可能会继承之前的分页设置。

解决方法：

使用 PageHelper.clearPage() 来手动清理分页上下文，确保分页信息不会影响到后续查询，尤其是条件判断没有执行 SQL 时，避免影响到后面的查询。

// 调用分页
PageHelper.startPage(pageNum, pageSize);

// 条件判断
if (someCondition) {
    // 不执行 SQL 查询
} else {
    // 执行 SQL 查询
    List<User> users = userMapper.selectUsers();
}

// 清理分页上下文，防止影响后续查询
PageHelper.clearPage();

这样，即使某些查询因条件判断未执行，PageHelper.clearPage() 会清理分页上下文，防止后续的查询（无论是否分页）受到影响。

2. 查询顺序或上下文未清理

如果在多个查询之间有分页设置，但是在其中一些查询没有执行时，PageHelper.startPage() 仍然可能对后续查询产生影响，导致它们不管是否显式设置分页，都采用了分页查询的上下文。

解决方法：

• 确保每个分页查询后都调用 PageHelper.clearPage() 来清理分页上下文。
• 确保每个查询前都显式调用 startPage。

// 分页查询1
PageHelper.startPage(pageNum, pageSize);
List<User> users = userMapper.selectUsers();
PageHelper.clearPage();  // 清理分页上下文

// 分页查询2
PageHelper.startPage(nextPageNum, nextPageSize);
List<Order> orders = orderMapper.selectOrders();
PageHelper.clearPage();  // 清理分页上下文

3. 在多个方法之间使用分页时，未正确分离上下文

如果你在多个方法中使用了分页，并且没有在分页查询之间清理上下文（clearPage），分页设置可能会相互干扰。

例如，如果方法 A 中没有查询数据，而方法 B 中进行了查询，分页信息可能会被继承到方法 B。

解决方法：

确保每次分页查询之前，都显式调用 startPage，且每次分页查询后都清理分页上下文。

// 方法A
PageHelper.startPage(pageNum, pageSize);
if (someCondition) {
    // 不执行查询
} else {
    // 执行查询
    List<User> users = userMapper.selectUsers();
}
PageHelper.clearPage(); // 清理分页上下文

// 方法B
PageHelper.startPage(nextPageNum, nextPageSize);
List<Order> orders = orderMapper.selectOrders();
PageHelper.clearPage(); // 清理分页上下文

4. 分页设置影响其他查询

由于 PageHelper 是基于线程局部变量（ThreadLocal）来管理分页上下文的，因此如果在方法之间传递分页设置，但没有清理，后续的查询可能会错误地继承分页设置，即使这些查询本身不需要分页。

解决方法：

• 确保在分页查询之后清理分页上下文。
• 在查询没有设置分页的情况下，确认没有隐式继承分页设置。

// 分页查询前显式调用startPage
PageHelper.startPage(pageNum, pageSize);
List<User> users = userMapper.selectUsers();

// 清理分页上下文
PageHelper.clearPage();

// 非分页查询
List<Order> orders = orderMapper.selectOrders(); // 这时应该不再受分页影响

总结

1. 清理分页上下文：每次分页查询结束后都调用 PageHelper.clearPage() 来清理分页上下文，避免影响后续的查询。
2. 确保分页设置生效：每次查询前都要确保分页设置已经正确调用 startPage。
3. 避免条件判断影响分页：如果条件判断导致没有执行 SQL 查询，确保分页上下文被清理，避免对后续查询产生影响。

通过这种方式，你可以确保分页逻辑不会意外地影响到后续的查询，即使某些查询由于条件判断而没有执行。

这些仅为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。