Python優(yōu)化列表接口進行分頁示例實現(xiàn)
分頁的目的
做個假設(shè),加入用例庫有 1W 條數(shù)據(jù),如果想要以列表形式展示,一次性返回 1W 條數(shù)據(jù);
這樣做有兩個弊端:
1.這樣寫出來的接口會慢。想一下如果隨著時間的發(fā)展,這個數(shù)量變成了 10W、100W 該怎么辦?
2.對前端不友好。用前端渲染 1W 條數(shù)據(jù),有理智的開發(fā)都不會這么做。
所以,我們做分頁的目的,主要是為了性能的提高,提高使用體驗。
我這邊開發(fā)語言是Python,Web框架用的是 Tornado,后臺數(shù)據(jù)庫用的是 Mongodb。
接口設(shè)計
首先,我們做一下接口的設(shè)計,如下:
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 } }
返回數(shù)據(jù)結(jié)構(gòu)解析:
- cases 的值是包含多個 case 對象的列表;
- count 指的是 case 的總數(shù),這樣前端就可以通過 count 來判斷一共有多少頁,然后通過點擊的頁數(shù)直接請求到對應(yīng)頁的數(shù)據(jù)做展示,這樣做可以有效的控制返回的數(shù)據(jù)量以及返回時間,提高用戶體驗感。
根據(jù)上述的接口約定,接口實現(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_={}) }
接口解讀
下面我們逐行來解讀這個接口。
1.根據(jù) API 約定,page和limit是不必傳且有默認值,所以獲取時可以直接寫為self.input.page or 1,其中當page不傳時self.input.page為None。
2.后端獲取到的GET請求的請求參數(shù)是String,所以需要int()轉(zhuǎn)為整型,這里直接int(page)即可,因為經(jīng)過了前面的處理,page必然是有值的。
3.通過limit * (page - 1),計算出跳過多少個;白話描述skip的作用就是,從第skip個對象開始,往后取limit個,返回。
4.get_case_list方法和get_count方法的filter_參數(shù)的值應(yīng)該保持一致,因為他們都是對case這個對象做操作,只不過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.對skip和limit的空值判斷要用is not None,因為skip可能為,如果使用if skip來判斷,skip=0的時候也會進入分支。
2.sort = [(‘create_time', -1)]的傳入使返回的列表按照創(chuàng)建時間倒敘排列,如果你不做這個,相信負責人的測試同學(xué)會給你提一個“易用性問題”。
3.sort + skip + limit是有執(zhí)行優(yōu)先級的,他們優(yōu)先級依次是sort→skip→limit,skip+limit的優(yōu)先級為skip→limit。
這里大家不要去考慮pymogo執(zhí)行的時候會不會對sort、skip、limit自動給按照優(yōu)先級執(zhí)行,傳參的時候按照優(yōu)先級去傳參就好了,養(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)存空間的浪費。
以上,就是對列表接口進行分頁的整個過程啦,謝謝閱讀,這不是一篇喂飯教程,是帶你熟悉了寫這個接口的整個過程及其中的細節(jié),具體的實現(xiàn)還需要大家動手去實踐。
以上就是Python優(yōu)化列表接口進行分頁示例實現(xiàn)的詳細內(nèi)容,更多關(guān)于Python優(yōu)化的資料請關(guān)注本站其它相關(guān)文章!
版權(quán)聲明:本站文章來源標注為YINGSOO的內(nèi)容版權(quán)均為本站所有,歡迎引用、轉(zhuǎn)載,請保持原文完整并注明來源及原文鏈接。禁止復(fù)制或仿造本網(wǎng)站,禁止在非www.sddonglingsh.com所屬的服務(wù)器上建立鏡像,否則將依法追究法律責任。本站部分內(nèi)容來源于網(wǎng)友推薦、互聯(lián)網(wǎng)收集整理而來,僅供學(xué)習(xí)參考,不代表本站立場,如有內(nèi)容涉嫌侵權(quán),請聯(lián)系alex-e#qq.com處理。