PageHelper引发的“幽灵数据”，怎么回事？

叁歲伎倆 2024-03-23 15:08 40阅读 0赞

### 前言 ###

最近测试反馈一个问题，某个查询全量信息的接口，有时候返回全量数据，符合预期，但是偶尔又只返回1条数据，简直就是“见鬼”了，究竟是为什么出现这样的“幽灵数据”呢？

### 大胆猜测 ###

首先我们看了下这对代码的业务逻辑，非常的简单，总共没有几行代码，也没有分页逻辑，代码如下：

public  List<SdSubscription> findAll() {
        return sdSubscriptionMapper.selectAll();
    }
    复制代码

那么究竟是咋回事呢？讲道理不可能出现这种情况的啊，不要慌，我们加点日志，将日志级别调整为`DEBUG`，让日志飞一段时间。

public  List<SdSubscription> findAll() {
        log.info("find the sub start .....");
        List<SdSubscription> subs = sdSubscriptionMapper.selectAll();
         log.info("find the sub end .....");
        return subs;
    }
    复制代码

果不其然，日志中出现了奇奇怪怪的分页参数，如下图所示:

![format_png][]

果然是`PageHelper`这个开源框架搞的鬼，我想大家都用过吧，分页非常方便，那么究竟为什么别人都没问题，单单就我会出现问题呢?

### PageHelper工作原理 ###

为了回答上面的疑问，我们先看看`PageHelper`框架的工作原理吧。

`PageHelper` 是一个开源的 `MyBatis` 分页插件，它可以帮助开发者在查询数据时，快速的实现分页功能。

`PageHelper` 的工作原理可以简单概括为以下几个步骤：

1.  在需要进行分页的查询方法前，调用 `PageHelper` 的静态方法 `startPage()`，设置当前页码和每页显示的记录数。它会将分页信息放到线程的`ThreadLocal`中，那么在线程的任何地方都可以访问了。
2.  当查询方法执行时，`PageHelper` 会自动拦截查询语句，如果发现线程的`ThreadLocal`中有分页信息，那么就会在其前后添加分页语句，例如 `MySQL` 中的 `LIMIT` 语句。
3.  查询结果将被包装在 `Page` 对象中返回，该对象包含分页信息和查询结果列表。
4.  在查询方法执行完毕后，会在`finally`中清除线程`ThreadLocal`中的分页信息，避免分页设置对其他查询方法的影响。

`PageHelper` 的实现原理主要依赖于拦截器技术和反射机制，通过拦截查询语句并动态生成分页语句，实现了简单、高效、通用的分页功能。具体源码在下图的类中，非常容易看懂。

![format_png 1][]

明白了`PageHelper`的工作原理后，反复检查代码，都没有调用过`startPage`，`debug`查看`ThreadLocal`中也没有分页信息啊，懵逼中。那我看看别人写的添加分页参数的代码吧，不看不知道，一看吓一跳。

![format_png 2][]

原来有位“可爱”的同事竟然在查询后，加了一个分页，就是把分页信息放到线程的`ThreadLocal`中。

那大家是不是有疑问，丁是丁，矛是矛，你的线程关我何事？这就要说到我们的tomcat了。

### Tomcat请求流程 ###

其实这就涉及到我们的`tomcat`相关知识了，我们一个浏览器发一个接口请求，经过我们的`tomcat`的，究竟是一个什么样的流程呢？

1.  客户端发送`HTTP`请求到`Tomcat`服务器。
2.  `Tomcat`的`HTTP`连接器（`Connector`）接收到请求，将连接请求交给线程池`Executor`处理，解析它，然后将请求转发给对应的Web应用程序。
3.  `Tomcat`的Web应用程序容器（`Container`）接收到请求，根据请求的URL找到对应的`Servlet`。

关于tomcat中使用线程池提交浏览器的连接请求的源码如下：

![format_png 3][]

从而得知，你的连接请求是从线程池从拿的，而拿到的这个线程恰好是一个“脏线程”，在`ThreadLocal`中放了分页信息，导致你这边出现问题。

### 总结 ###

后来追问了同事具体原因，才发现是粗心导致的。有些bug总是出现的莫名其妙，就像生活一样。所以关键的是我们在使用一些开源框架的时候一定要掌握底层实现的原理、核心的机制，这样才能够在解决一些问题的时候有据可循。

[format_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/997b3a1ececd4290b0bc76e831d8a1b0.png
[format_png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/9a6e57a77e4d4d8dbb896593d173af9f.png
[format_png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/7a8a1239f7e349bca2064277539faa16.png
[format_png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/507e9f3f7c864ee48f06cb0638ca7394.png