蕞近，在做測試開發(fā)平臺(tái)得時(shí)候，需要對(duì)測試用例得列表進(jìn)行后端分頁，在實(shí)際去寫代碼和測試得過程中，發(fā)現(xiàn)這里面還是有些細(xì)節(jié)得，故想復(fù)盤一下，所以有了這篇文章。
分頁得目得
做個(gè)假設(shè)，加入用例庫有 1W 條數(shù)據(jù)，如果想要以列表形式展示，一次性返回 1W 條數(shù)據(jù)；這樣做有兩個(gè)弊端：
1.這樣寫出來得接口會(huì)慢。想一下如果隨著時(shí)間得發(fā)展，這個(gè)數(shù)量變成了 10W、100W 該怎么辦？
2.對(duì)前端不友好。用前端渲染 1W 條數(shù)據(jù)，有理智得開發(fā)都不會(huì)這么做。
所以，我們做分頁得目得，主要是為了性能得提高，提高使用體驗(yàn)。
我這邊開發(fā)語言是Python，Web框架用得是 Tornado，后臺(tái)數(shù)據(jù)庫用得是 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ù)，這樣前端就可以通過 count 來判斷一共有多少頁，然后通過感謝閱讀得頁數(shù)直接請(qǐng)求到對(duì)應(yīng)頁得數(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_={})
}
接口解讀
下面我們逐行來解讀這個(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)過了前面得處理，page必然是有值得。
3.通過limit * (page - 1)，計(jì)算出跳過多少個(gè)；白話描述skip得作用就是，從第skip個(gè)對(duì)象開始，往后取limit個(gè)，返回。
4.get_case_list方法和get_count方法得filter_參數(shù)得值應(yīng)該保持一致，因?yàn)樗麄兌际菍?duì)case這個(gè)對(duì)象做操作，只不過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來判斷，skip=0得時(shí)候也會(huì)進(jìn)入分支。
2.sort = [(‘create_time’, -1)]得傳入使返回得列表按照創(chuàng)建時(shí)間倒敘排列，如果你不做這個(gè)，相信負(fù)責(zé)人得測試同學(xué)會(huì)給你提一個(gè)“易用性問題”。
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來獲取數(shù)據(jù)，可以直接拿到總數(shù)，而不是取出list然后去求length，避免了內(nèi)存空間得浪費(fèi)。
以上，就是對(duì)列表接口進(jìn)行分頁得整個(gè)過程啦，謝謝閱讀，這篇喂飯教程帶你熟悉了寫這個(gè)接口得整個(gè)過程及其中得細(xì)節(jié)，但具體得實(shí)現(xiàn)還需要大家動(dòng)手去實(shí)踐。
請(qǐng)感謝對(duì)創(chuàng)作者的支持+私信回復(fù)：“測試” 就可以免費(fèi)拿到軟件測試學(xué)習(xí)資料。
