2024年用了这么多年分页PageHelper，才发现自己一直用错了~，看上面试官

最后

开源分享：【大厂前端面试题解析+核心总结学习笔记+真实项目实战+最新讲解视频】

以下是合理且规范的基本使用:

public PageInfo page(RequestParamDto param) {
return PageHelper.startPage(param.getPageNum(), param.getPageSize())
.doSelectPageInfo(() -> list(param))
}
public List list(RequestParamDto param) {
return mapper.selectManySelective(param);
}

FAQ

1. 为什么要重新声明一个list函数?

答: 往往在很多实际业务应用场景中, 分页查询是基于大数据量的表格展示需求来进行的.
然而很多时候,譬如: 内部服务的互相调用,OpenAPI的提供.
甚至在某些前后端分离联调的业务场景中,是同样需要一个非分页集合查询接口来提供服务的.
另外,暂时以上因素抛开不谈,我们可以根据上述写法来定义和规范某些东西
譬如: 分页和集合查询的分离和解耦(解耦详情请看进阶使用),
分页请求的请求和响应与实际业务参数的分离(详情请看进阶使用)等等…

2. doSelectPageInfo是什么?

答: doSelectPageInfo是PageHelper.startPage()函数返回的默认Page实例内置的函数,该函数可以用以Lambda的形式通过额外的Function来进行查询而不需要再进行多余的PageInfo与List转换,而doSelectPageInfo的参数则是PageHelper内置的Function(ISelect)接口用以达到转换PageInfo的目的

3. 这种写法的代码量看起来不少反多?

答: 正如同①中所描述的,就代码量而言,确实没有更进一步的简化,但是再某些业务场景中,在已具有list函数接口的情况下,是一种更直观的优化(优化详情请看进阶使用)

2. 进阶使用

先看代码,再谈解析:

import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;

import java.util.List;

/**

• @param 泛型request
• @param 泛型response
  */
  public interface BaseService<Param, Result> {

/**

• 分页查询
• @param param 请求参数DTO
• @return 分页集合
  */
  default PageInfo page(PageParam param) {
  return PageHelper.startPage(param).doSelectPageInfo(() -> list(param.getParam()));
  }

/**

• 集合查询
• @param param 查询参数
• @return 查询响应
  */
  List list(Param param);
  }

可以看到BaseService可以作为全局Service通用接口的封装和声明
而作为通用分页接口page函数却在此处利用interface特有关键字default 直接声明了page函数的方法体body

import com.github.pagehelper.IPage;
import lombok.Data;
import lombok.experimental.Accessors;

@Data // 为省略冗余代码使用lombok 实际应有常规Getter/Setter Construction toString等
@Accessors(chain = true) // 此lombok注解是为了实现 Entity伪Build 譬如: entity.setX(x).setY(y)
public class PageParam implements IPage {

// description = “页码”, defaultValue = 1
private Integer pageNum = 1;

// description = “页数”, defaultValue = 20
private Integer pageSize = 20;

// description = “排序”, example = “id desc”
private String orderBy;

// description = “参数”
private T param;

public PageParam setOrderBy(String orderBy) {
this.orderBy = orderBy; // 此处可优化 优化详情且看解析
return this;
}
}

在BaseService中我们看到了一个新的PageParam,参考了PageInfo用以包装/声明/分离分页参数和业务参数,且参数类型为泛型,即支持任何数据类型的业务参数
同时也可以看到PageParam实现了IPage接口,并且多了一个orderBy属性字段

import common.base.BaseService;
import dto.req.TemplateReqDto;
import dto.resp.TemplateRespDto;

public interface TemplateService extends BaseService<TemplateReqDto, TemplateeRespDto> {
// 同为interface接口, 业务Service只需要继承BaseService
// 并根据实际使用场景声明请求参数和响应结果的Entity实体即可
}

在实际应用中,只需要声明我们通用的业务查询请求参数和响应结果即可

import dto.req.TemplateReqDto;
import dto.resp.TemplateRespDto;
import service.TemplateService;
import persistence.mapper.TemplateMapper;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

import java.util.List;

@Slf4j // 基于lombok自动生成logger日志记录实例
@Service // SpringBoot中注册Service Bean的注解
@RequiredArgsConstructor // 基于lombok根据类所有final属性生成构造函数 即可完成Spring构造注入
public class TemplateServiceImpl implements TemplateService {

private final TemplateMapper mapper;

@Override
public List list(TemplateReqDto param) {
return mapper.selectManySelective(param) // 可根据实际情况将实体做转换
}
}

实现类中也只需要重写list方法体,将实际业务场景中需要处理的业务逻辑处理和查询方法写入其中,并不需要关心分页功能

@Slf4j // 同上
@RestController // SpringBoot中注册Controller Bean的注解
@RequiredArgsConstructor // 同上
public class TemplateController {

public final TemplateService service;

/**

• 分页查询
• @param pageParam 分页查询参数
• @return 分页查询响应
  */
  @PostMapping(path = “page”)
  public PageInfo page(@RequestBody PageParam pageParam) {
  return service.page(pageParam);
  }

/**

• 集合查询
• @param listParam 集合查询参数
• @return 集合查询响应
  */
  @PostMapping(path = “list”)
  public List list(@RequestBody Param listParam) {
  return service.list(listParam);
  }
  }

最后编码Controller接口时,也只需要直接调用service.page即可,而请求参数直接用PageParam包装,将分页参数和业务参数分离,在前后端接口联调中,保持这种分离规范,可以很大程度上的降低沟通和开发成本

FAQ

1. BaseService作为interface,page为什么可以声明方法体?

答: Java8中新特性之一就是为interface接口类增加了static/default方法,即声明方法后,其子类或实现都将默认具有这些方法,可以直接调用
而在此处为Page方法声明default是因为page函数只关注分页参数和分页响应,脱离了业务场景,方法体大相径庭,所以索性抽象定义出来,免去了其实现的复杂冗余过程

2. PageParam的声明有什么意义?实现IPage是为了什么?

答: PageParam是参考PageInfo编写的类(不确定往后PageHelper是否会封装此类,兴许我可以提个Issue上去,也参与开源框架的开发)
编写此类的目的就是为了分离分页和业务数据,让开发者专注于业务的实现和开发,同时也是对分页查询API的一种规范,无论是请求还是响应都将分页相关的数据抽离出来,单独使用
而实现IPage则是因为IPage作为PageHelper内置的interface,在不了解它更多意义上的作用前,可以作为我们分页参数声明的一种规范,而IPage中也只声明了三个方法,分别是pageNum/pageSize/orderBy的Getter方法,另外在源码分析中,我将会提到实现此接口更深层的意义

3. PageParam中除了常规的pageNum/pageSize,为什么还需要一个orderBy?

答: 常规的分页查询中只需要pageNum/pageSize即可完成分页的目的,但是往往伴随着分页查询的还有筛选排序,而orderBy则是专注基于SQL的动态传参排序

4. orderBy如何使用?会有什么问题吗?

答: orderBy和pageNum/pageSize一样,都是Pagehelper通过MyBatis拦截器,在query查询中注入进去的,所以在前端传参时,orderBy参数应为数据库column desc/asc这种形式,多字段排序则可以用逗号(,)拼接,譬如: columnA desc,columnB,
但是另外一方面又存在两个问题, 第一就是大多数数据库表字段设计中,都会使用蛇形case命名,而非常规开发中的驼峰case命名,所以存在一层转换,而这种转换可以分配给前端传参时,也可以分配给后端接参时.
第二就是这样赤裸裸的将排序字段暴露在接口中,会存在order by SQL注入的风险,所以在实际使用过程中,我们需要通过某些手段去校验和排查orderBy的传参是否合法,譬如用正则表达式匹配参数值只能含有order by语法中必要的值,例如字段名,desc or asc,不允许包含特殊字符/数据库关键字等

5. pageNum/pageSize一定需要给默认值吗?

答: 通过阅读PageHelper源码,我们得知在Page查询参数为null时,它并不会赋予它们默认值,并不进行额外的处理,以至于导致分页失败,而给默认值,也是为了谨防前后端调试接口过程中可能会出现的各种意外

3. 源码分析

首先我们看PageHelper.startPage(param)过程中发生了什么 :

public static Page startPage(Object params) {
Page page = PageObjectUtil.getPageFromObject(params, true);
Page oldPage = getLocalPage();
if (oldPage != null && oldPage.isOrderByOnly()) {
page.setOrderBy(oldPage.getOrderBy());
}
setLocalPage(page);
return page;
}

这是PageHelper继承(extend)的抽象类PageMethod中的一个静态方法

再看代码第一行 Page<E> page = PageObjectUtil.getPageFromObject(params, true)发生了什么:

public static Page getPageFromObject(Object params, boolean required) {
if (params == null) {
throw new PageException(“无法获取分页查询参数!”);
} else if (params instanceof IPage) {
IPage pageParams = (IPage)params;
Page page = null;
if (pageParams.getPageNum() != null && pageParams.getPageSize() != null) {
page = new Page(pageParams.getPageNum(), pageParams.getPageSize());
}
if (StringUtil.isNotEmpty(pageParams.getOrderBy())) {
if (page != null) {
page.setOrderBy(pageParams.getOrderBy());
} else {
page = new Page();
page.setOrderBy(pageParams.getOrderBy());
page.setOrderByOnly(true);
}
}
return page;
} else {
… // 此处我只截取了部分代码片段, 以上是较为重要的一块
}
}

可以看到在此方法中,会先判断params是否为null,再而通过instanceof判断是否为IPage的子类或实现类
如果以上两个if/else 皆不满足,则PageHelper则会在我省略贴出的代码中通过大量的反射代码来获取pageNum/pageSize以及orderBy.
总所皆知,反射在Java中虽然广泛应用,并且作为语言独有特性之一,深受广大开发者的喜爱,但是反射在某种程度上,是需要性能成本的,甚至于现阶段很多主流的框架和技术,都在尽量减少反射的运用,以防止框架性能过差,被市场淘汰.
那么到此为止,我们也终于解释并知道了为什么PageParam要实现IPage接口了,在此处的代码中可以直接通过接口获取到分页参数,而不需要通过有损性能的反射获取PageHelper需要的参数

继续看startPage中的后续代码:

最后

开源分享：【大厂前端面试题解析+核心总结学习笔记+真实项目实战+最新讲解视频】

PageParam要实现IPage接口了,在此处的代码中可以直接通过接口获取到分页参数,而不需要通过有损性能的反射获取PageHelper需要的参数

继续看startPage中的后续代码:

最后

开源分享：【大厂前端面试题解析+核心总结学习笔记+真实项目实战+最新讲解视频】

[外链图片转存中…(img-7NUnxeXi-1715763946945)]