如何优雅的对列表接口进行分页？

比眉伴天荒 2023-10-08 13:59 16阅读 0赞

![在这里插入图片描述][5fb87c883155482198a70b4dca710d26.gif_pic_center]

最近，在做测试开发平台的时候，需要对测试用例的列表进行后端分页，在实际去写代码和测试的过程中，发现这里面还是有些细节的，故想复盘一下，所以有了这篇文章。

### 分页的目的 ###

做个假设，加入用例库有 1W 条数据，如果想要以列表形式展示，一次性返回 1W 条数据；这样做有两个弊端：

1.这样写出来的接口会慢。想一下如果随着时间的发展，这个数量变成了 10W、100W 该怎么办？

2.对前端不友好。用前端渲染 1W 条数据，有理智的开发都不会这么做。

所以，我们做分页的目的，主要是为了性能的提高，提高使用体验。

我这边开发语言是Python，Web框架用的是 Tornado，后台数据库用的是 Mongodb。

### 接口设计 ###

首先，我们做一下接口的设计，如下：

HTTP URL: /api/admin/v1/case/list
    HTTP Method: GET
    Request Params
    Reponse Data
    {
        "code": 0,
        "message": null,
        "data": {
            "cases": [
                {
                    "method": str,
                    "url": str,
                    "request_data"?: str,
                    "request_params"?: str,
                    "header": dict,
                    "reponse_data"?: str
                },
                ...
            ],
            "count": int
        }
    }

返回数据结构解析：

*  cases 的值是包含多个 case 对象的列表；
 *  count 指的是 case 的总数，这样前端就可以通过 count 来判断一共有多少页，然后通过点击的页数直接请求到对应页的数据做展示，这样做可以有效的控制返回的数据量以及返回时间，提高用户体验感。

根据上述的接口约定，接口实现如下（仅展示关键代码）：

class CaseList(APIHandler):
        async def get_handler(self):
            page = self.input.page or 1
            limit = self.input.limit or 12
            page, limit = int(page), int(limit)
            skip = limit * (page - 1)
            return {
                'customers': await CaseService.get_case_list(filter_={}, skip=skip, limit=limit),
                'count': await CaseService.get_count(filter_={})
            }

### 接口解读 ###

下面我们逐行来解读这个接口。

1.根据 API 约定，page和limit是不必传且有默认值，所以获取时可以直接写为self.input.page or 1，其中当page不传时self.input.page为None。

2.后端获取到的GET请求的请求参数是String，所以需要int()转为整型，这里直接int(page)即可，因为经过了前面的处理，page必然是有值的。

3.通过limit \* (page - 1)，计算出跳过多少个；白话描述skip的作用就是，从第skip个对象开始，往后取limit个，返回。

4.get\_case\_list方法和get\_count方法的filter\_参数的值应该保持一致，因为他们都是对case这个对象做操作，只不过count是取总数而已。

### CaseService.get\_case\_list方法 ###

async def get_case_list(filter_: dict, skip: int = None, limit: int = None) -> Optional[List[dict]]:
        """ 获取 case 列表 """
            sort = [('create_time', -1)]
        if skip is not None and limit is not None:
            ret = await cls.find('case', filter=filter_, sort=sort, limit=limit, skip=skip)
        else:
            ret = await cls.find('case', filter=filter_, sort=sort)
        return ret

1.对skip和limit的空值判断要用is not None，因为skip可能为，如果使用if skip来判断，skip=0的时候也会进入分支。

2.sort = \[(‘create\_time’, -1)\]的传入使返回的列表按照创建时间倒叙排列，如果你不做这个，相信负责人的测试同学会给你提一个“易用性问题”。

3.sort + skip + limit是有执行优先级的，他们优先级依次是sort→skip→limit，skip+limit的优先级为skip→limit。

这里大家不要去考虑pymogo执行的时候会不会对sort、skip、limit自动给按照优先级执行，传参的时候按照优先级去传参就好了，养成良好的习惯，不必纠结其他的。

### CaseService.get\_count方法 ###

async def get_count(cls, filter_: dict) -> int:
        """ 获取 case 总数 """
        return await ModelHandler.count('case', filter=filter_)

这里用count来获取数据，可以直接拿到总数，而不是取出list然后去求length，避免了内存空间的浪费。

以上，就是对列表接口进行分页的整个过程啦，谢谢阅读，这不是一篇喂饭教程，是带你熟悉了写这个接口的整个过程及其中的细节，具体的实现还需要大家动手去实践。

![在这里插入图片描述][a136c83898ea44b1a47a2c2004f3b63d.png_pic_center]

**最后：** 可以在公众号：伤心的辣条 ！ 免费领取一份216页软件测试工程师面试宝典文档资料。以及相对应的视频学习教程免费分享！，其中包括了有基础知识、Linux必备、Shell、互联网程序原理、Mysql数据库、抓包工具专题、接口测试工具、测试进阶-Python编程、Web自动化测试、APP自动化测试、接口自动化测试、测试高级持续集成、测试架构开发测试框架、性能测试、安全测试等。

**如果我的博客对你有帮助、如果你喜欢我的博客内容，请 “点赞” “评论” “收藏” 一键三连哦！喜欢软件测试的小伙伴们，可以加入我们的测试技术交流扣扣群：914172719（里面有各种软件测试资源和技术讨论）**

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

### 好文推荐 ###

[转行面试，跳槽面试，软件测试人员都必须知道的这几种面试技巧！][Link 1]

[面试经：一线城市搬砖！又面软件测试岗，5000就知足了…][5000]

[面试官：工作三年，还来面初级测试？恐怕你的软件测试工程师的头衔要加双引号…][Link 2]

[什么样的人适合从事软件测试工作？][Link 3]

[那个准点下班的人，比我先升职了…][Link 4]

[测试岗反复跳槽，跳着跳着就跳没了…][Link 5]

[5fb87c883155482198a70b4dca710d26.gif_pic_center]: https://img-blog.csdnimg.cn/5fb87c883155482198a70b4dca710d26.gif#pic_center
[a136c83898ea44b1a47a2c2004f3b63d.png_pic_center]: https://img-blog.csdnimg.cn/a136c83898ea44b1a47a2c2004f3b63d.png#pic_center
[Link 1]: https://blog.csdn.net/m0_56736369/article/details/117909132
[5000]: https://blog.csdn.net/m0_56736369/article/details/117915399
[Link 2]: https://blog.csdn.net/weixin_50829653/article/details/117422433
[Link 3]: https://blog.csdn.net/weixin_50271247/article/details/108421434
[Link 4]: https://blog.csdn.net/weixin_50829653/article/details/117856900
[Link 5]: https://blog.csdn.net/m0_56736369/article/details/117923266