【260期】PageHelper 使用 ThreadLocal 的线程复用问题，你用对了吗？

Java精选 2022-08-09

收录于合集

#面试题系列专栏 349 个

#面试官问 405 个

#Java线程 23 个

点击上方“Java精选”，选择“设为星标”

别问别人为什么，多问自己凭什么！

下方有惊喜，留言必回，有问必答！

每一天进步一点点，是成功的开始...

前言

PageHelper是较为常用的分页插件，通过实现Mybatis的Interceptor接口完成对query sql的动态分页，其中分页参数由ThreadLocal进行保存。

简单的分页执行过程：

设置page参数
执行query方法
Interceptor接口中校验ThreadLocal中是否存在有设置的page参数
存在page参数，重新生成 count sql 和 page sql，并执行查询。不存在 page参数，直接返回查询结果
执行 LOCAL_PAGE.remove()清除page参数

问题场景

观察上述的执行过程，可以发现，如果在第 1 步和第 2 步之间发生异常，那么 LOCAL_PAGE 中当前线程对应的page参数并不会 remove。

在不使用线程池的情况下，当前线程在执行完毕后会被销毁，这时当前线程中的threadLocals参数将会被情况，也就清空了 LOCAL_PAGE 中当前线程的 page参数。

但是如果使用了线程池，当前线程执行完毕，并不会被销毁，而是会将当前线程再次存放到池中，标记为空闲状态，以便后续使用。在后续使用这个线程的时候，由于线程的threadLocals依旧存在有值，尽管我们在第1步时未设置 page参数，第3步的也能获取到page参数，从而生成 count sql 和 page sql，从而影响我们的正常查询。

推荐下自己做的 Spring boot 的实战项目：
https://gitee.com/yoodb/jing-xuan‍

SpringBoot 项目中会使用内置的 Tomcat 作为服务器，而Tomcat会默认使用线程来处理请求，从而便引发了上述问题。

解决方案

因为Tomcat的线程是用来处理request请求，那么在请求完成时，清空当前线程的threadLocals 属性值，也就是执行 LOCAL_PAGE.remove() 即可。实现方式：

使用aop，对所有controller进行处理
实现 HandlerInterceptor 或者 WebRequestInterceptor 对request请求的拦截器接口，通过afterCompletion方法执行 LOCAL_PAGE.remove()。— 推荐，实现方式简单

这里使用第二种方式，实现 HandlerInterceptor 接口：

public class PageLocalWebInterceptor implements HandlerInterceptor {
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // PageHelper.clearPage() 内部调用 LOCAL_PAGE.remove()
        PageHelper.clearPage();

    }
}

定义配置类，配置类需实现 WebMvcConfigurer 接口完成对于WebMvc的相关配置，注册 PageLocalWebInterceptor ：

@Configuration
public class FrameworkAutoConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new PageLocalWebInterceptor());
    }
}