分頁(yè)的目的

做個(gè)假設(shè)，加入用例庫(kù)有 1W 條數(shù)據(jù)，如果想要以列表形式展示，一次性返回 1W 條數(shù)據(jù)；

這樣做有兩個(gè)弊端：

1.這樣寫出來(lái)的接口會(huì)慢。想一下如果隨著時(shí)間的發(fā)展，這個(gè)數(shù)量變成了 10W、100W 該怎么辦？

2.對(duì)前端不友好。用前端渲染 1W 條數(shù)據(jù)，有理智的開(kāi)發(fā)都不會(huì)這么做。

所以，我們做分頁(yè)的目的，主要是為了性能的提高，提高使用體驗(yàn)。

我這邊開(kāi)發(fā)語(yǔ)言是Python，Web框架用的是 Tornado，后臺(tái)數(shù)據(jù)庫(kù)用的是 Mongodb。

接口設(shè)計(jì)

首先，我們做一下接口的設(shè)計(jì)，如下：

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
    }
}

返回?cái)?shù)據(jù)結(jié)構(gòu)解析：

• cases 的值是包含多個(gè) case 對(duì)象的列表；
• count 指的是 case 的總數(shù)，這樣前端就可以通過(guò) count 來(lái)判斷一共有多少頁(yè)，然后通過(guò)點(diǎn)擊的頁(yè)數(shù)直接請(qǐng)求到對(duì)應(yīng)頁(yè)的數(shù)據(jù)做展示，這樣做可以有效的控制返回的數(shù)據(jù)量以及返回時(shí)間，提高用戶體驗(yàn)感。

根據(jù)上述的接口約定，接口實(shí)現(xiàn)如下（僅展示關(guān)鍵代碼）：

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_={})
        }

接口解讀

下面我們逐行來(lái)解讀這個(gè)接口。

1.根據(jù) API 約定，page和limit是不必傳且有默認(rèn)值，所以獲取時(shí)可以直接寫為self.input.page or 1，其中當(dāng)page不傳時(shí)self.input.page為None。

2.后端獲取到的GET請(qǐng)求的請(qǐng)求參數(shù)是String，所以需要int()轉(zhuǎn)為整型，這里直接int(page)即可，因?yàn)榻?jīng)過(guò)了前面的處理，page必然是有值的。

3.通過(guò)limit * (page - 1)，計(jì)算出跳過(guò)多少個(gè)；白話描述skip的作用就是，從第skip個(gè)對(duì)象開(kāi)始，往后取limit個(gè)，返回。

4.get_case_list方法和get_count方法的filter_參數(shù)的值應(yīng)該保持一致，因?yàn)樗麄兌际菍?duì)case這個(gè)對(duì)象做操作，只不過(guò)count是取總數(shù)而已。

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.對(duì)skip和limit的空值判斷要用is not None，因?yàn)閟kip可能為，如果使用if skip來(lái)判斷，skip=0的時(shí)候也會(huì)進(jìn)入分支。

2.sort = [(‘create_time', -1)]的傳入使返回的列表按照創(chuàng)建時(shí)間倒敘排列，如果你不做這個(gè)，相信負(fù)責(zé)人的測(cè)試同學(xué)會(huì)給你提一個(gè)“易用性問(wèn)題”。

3.sort + skip + limit是有執(zhí)行優(yōu)先級(jí)的，他們優(yōu)先級(jí)依次是sort→skip→limit，skip+limit的優(yōu)先級(jí)為skip→limit。

這里大家不要去考慮pymogo執(zhí)行的時(shí)候會(huì)不會(huì)對(duì)sort、skip、limit自動(dòng)給按照優(yōu)先級(jí)執(zhí)行，傳參的時(shí)候按照優(yōu)先級(jí)去傳參就好了，養(yǎng)成良好的習(xí)慣，不必糾結(jié)其他的。

CaseService.get_count方法

async def get_count(cls, filter_: dict) -> int:
    """ 獲取 case 總數(shù) """
    return await ModelHandler.count('case', filter=filter_)

這里用count來(lái)獲取數(shù)據(jù)，可以直接拿到總數(shù)，而不是取出list然后去求length，避免了內(nèi)存空間的浪費(fèi)。

以上，就是對(duì)列表接口進(jìn)行分頁(yè)的整個(gè)過(guò)程啦，謝謝閱讀，這不是一篇喂飯教程，是帶你熟悉了寫這個(gè)接口的整個(gè)過(guò)程及其中的細(xì)節(jié)，具體的實(shí)現(xiàn)還需要大家動(dòng)手去實(shí)踐。

以上就是Python優(yōu)化列表接口進(jìn)行分頁(yè)示例實(shí)現(xiàn)的詳細(xì)內(nèi)容，更多關(guān)于Python優(yōu)化的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論