一、背景介绍
同事工作中遇到一个问题,需要修改一个旧接口,在代码层做筛选然后分页。之前代码用的是PageHelper分页插件,不过这个插件只能支持一条sql查询,返回数据格式如下图所示:
{
"data":{
"endRow":6,
"hasNextPage":false,
"hasPreviousPage":false,
"isFirstPage":true,
"isLastPage":true,
"navigateFirstPage":1,
"navigateLastPage":1,
"navigatePages":8,
"navigatepageNums":[1],
"nextPage":0,
"pageNum":1,
"pageSize":10,
"pages":1,
"prePage":0,
"size":6,
"startRow":1,
"total":6,
"list":[
{
"activityId":"0171ee9c492100163e03163300870001",
"createTime":"2020.05.09 17:20",
"openId":"o6f9y1s2q3XLDWSQjwQXaA_lUDuo",
"originStudentNo":"",
"originStudentSchool":"未知",
"source":"红蕾测试百度",
"unionId":"oSo2U0boYNgQeLLK7uW04FdbAqAk",
"weChatName":"Pluto💫"
},
{
"activityId":"",
"createTime":"2020.10.30 17:28",
"openId":"o6f9y1hDLGjqzFqmUZrsAvgMVhH0",
"originStudentNo":"205010515858",
"originStudentSchool":"北京",
"source":"Scratch分享-社区",
"unionId":"oSo2U0T2w_RbNqNjC29wUS8E6MV4",
"weChatName":"鮋"
}
]
},
"message":"OK",
"status":200,
"timestamp":1604817387991
}
最开始想法是想自己拼装一个实体类,返回一个total表示总页数,一个list表示数据实体。不过此处前端用的分页插件需要的参数更多,仅这两个参数无法正常进行分页。
因此我们需要自己拼装一个PageInfo返回给前端,同时要保证里面的参数都是正确的。
二、设计思路
首先简单看了PageInfo的源码,发现它的构造函数如下所示:
public PageInfo(List<T> list, int navigatePages) {
super(list);
this.isFirstPage = false;
this.isLastPage = false;
this.hasPreviousPage = false;
this.hasNextPage = false;
if (list instanceof Page) {
Page page = (Page)list;
this.pageNum = page.getPageNum();
this.pageSize = page.getPageSize();
this.pages = page.getPages();
this.size = page.size();
if (this.size == 0) {
this.startRow = 0;
this.endRow = 0;
} else {
this.startRow = page.getStartRow() + 1;
this.endRow = this.startRow - 1 + this.size;
}
} else if (list instanceof Collection) {
this.pageNum = 1;
this.pageSize = list.size();
this.pages = this.pageSize > 0 ? 1 : 0;
this.size = list.size();
this.startRow = 0;
this.endRow = list.size() > 0 ? list.size() - 1 : 0;
}
if (list instanceof Collection) {
this.navigatePages = navigatePages;
this.calcNavigatepageNums();
this.calcPage();
this.judgePageBoudary();
}
}
list是当前页的数据,navigatePages是前端分页时展示多少个页码。可以看到如果传入的参数是Page类型,它会对参数做一些计算处理;而如果是Collection,则只会使用默认值。
因此我们首先需要先构造一个Page对象。
Page类继承了List接口,我们构造Page对象时传入了pageNo(当前页码)和pageSize(每页显示条数),此时Page对象还没有存入具体的数据集合。调用List接口中定义的addAll函数即可。
三、具体实现
public PageInfo<WeixinCalendarListDto> findList(int pageNo,int pageSize){
List<WeixinCalendarListDto> list = weixinCalendarMapper.findList();//得到数据集合(实际上应该是我们通过筛选后得到的数据list,否则直接使用分页插件即可实现)
list = list.stream().skip((pageNo-1) * pageSize).limit(pageSize).collect(Collectors.toList());//核心分页代码,跳过之前的页码,显示当前页
Page<WeixinCalendarListDto> page = new Page<WeixinCalendarListDto>(pageNo,pageSize);//构造page对象
page.addAll(list);//存入集合数据
log.debug(":[{}]",page);
page.setTotal(list.size());//总的数据条数
PageInfo<WeixinCalendarListDto> pageInfo = page.toPageInfo();//构造PageInfo对象
return pageInfo;
}
四、总结
实际上部分前端插件只需要total和list两个返回值即可运行,尽量不要自己造轮子,使用成熟的api,稳定性会更强。