PageHelper.startPage和new PageInfo(list)的一些探索和思考

左手的ㄟ右手 2021-10-15 10:21 563阅读 0赞

平常我们使用分页插件的时候，都是很机械的套用

PageHelper.startPage(1, 10);
            Example example = new Example(Employee.class);
            example.createCriteria().andEqualTo("employeeSex", "男");
            List<Employee> list = employeeTKMapper.selectByExample(example);
            PageInfo<Employee> pageinfo=new PageInfo<>(list);

先`PageHelper.startPage(1, 10)`开始分页，再`selectlist`查询数据库的时候会自动加上`limit 1，10`，最后封装成`PageInfo`的时候会自动带上页码、页大小、总数等。

问题引入情景：

@Autowired
        private EmployeeService employeeService;
        
    	public ApiResult<PageInfo> getAllEmloyee() { 
            PageHelper.startPage(1, 3);
            // 调用EmployeeService中的方法
            List<Employee> list = employeeService.getAll();
            PageInfo<Employee> pageInfo = new PageInfo<>(list);
            return ApiResult.success(pageInfo);
        }

public List<Employee> getAll() { 
            Example example = new Example(Employee.class);
            example.createCriteria().andEqualTo("employeeSex", "男");
            List<Employee> list = employeeTKMapper.selectByExample(example);
            return list;
        }

简答说就是：在一个方法中使用`PageHelper.startPage(1, 3)`，再调用另一个方法查询数据库  
这样的结果：查询数据库也是会带上分页信息（已验证，你们可以自己去验证看一下）

这样我就在想，为什么`PageHelper.startPage(1, 3)`会有这么大能力呢？

看一下源码  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoaWppdWppdTMz_size_16_color_FFFFFF_t_70]

protected static final ThreadLocal<Page> LOCAL_PAGE = new ThreadLocal<Page>();
    	/** * 设置 Page 参数 * * @param page */
        protected static void setLocalPage(Page page) { 
            LOCAL_PAGE.set(page);
        }

这是`setLocalPage()`方法，`LOCAL_PAGE`是当前线程，通常存储数据为了在同一个线程中都可以访问到

这里的意思就是 将分页信息保存在当前线程中

看到这里就豁然开朗了，解释了上面为什么在另一个方法中执行`selectlist`的时候也会自动加上分页信息  
因为当前请求就对应一个线程，虽然是方法之间存在调用，但是他们还是处于同一个线程中，共享`ThreadLocal`中的数据

至于为什么`PageHelper.startPage(1, 3)`就可以达到分页效果，这里不做详细的源代码解读（我也没看过…）  
但是我觉得大致流程就是：

分页插件的使用，首先是在Mybatis里面配置了分页拦截器（PageInterceptor），即在执行相关Sql之前会拦截做一点事情；  
所以应该就是在执行`selectlist`的时候，会自动为sql加上`limit 1，3`

--------------------

还有一点就是使用了`PageHelper.startPage`，`selectlist`查询之后赋值给的`List<Employee> list`  
这个list可以Debug看一下是`Page<Employee>` 类型  
再看一下，Page类是ArrayList子类  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoaWppdWppdTMz_size_16_color_FFFFFF_t_70 1]

所以在`new PageInfo<>(list)`的时候可以把页码、页大小、总页数等信息给pageinfo

可以看一下，`new PageInfo<>(list)`源码  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoaWppdWppdTMz_size_16_color_FFFFFF_t_70 2]  
这又让我想到了，如果把`PageHelper.startPage(1, 3)`去掉，将查询出来的list，再`new PageInfo<>(list)`

Debug看了一下

没有`PageHelper.startPage(1, 3)`，查询的list是ArrayList类型：所以肯定就是走下面的  
`else if (list instanceof Collection)...`

--------------------

以上就是我对`PageHelper.startPage`和`new PageInfo<>(list)`的一些探索和思考

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoaWppdWppdTMz_size_16_color_FFFFFF_t_70]: /images/20211015/56c76d51807942b78c629f8059216995.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoaWppdWppdTMz_size_16_color_FFFFFF_t_70 1]: /images/20211015/523a7860a0c64b91b5e705e3bd6d741a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoaWppdWppdTMz_size_16_color_FFFFFF_t_70 2]: /images/20211015/d0166b8a85c1446a9f73e6443aceb4fe.png