Flask RESTful API開發(fā) Model與Resource(上)

資源 Resource 的擺放

在使用Flask-RESTful的Resource類簡化API開發(fā)步驟時(shí)泥兰,所有的資源都可以通過繼承Resource類來構(gòu)建一個(gè)單獨(dú)的class,
并將所有與此資源相關(guān)的CRUD操作作為methods添加到對(duì)應(yīng)的class下苟穆,使得整個(gè)程序結(jié)構(gòu)更加清晰明了。

這種情況下峻呛,各資源之間互不影響踊餐,可以專門建立一個(gè)名為resources的文件夾,并將各資源class單獨(dú)建立文件:

./resources
| --- __init__.py
|--- item.py
|--- user.py

注意在一些較舊的python版本中需要在文件夾中添加init.py來告訴python可以將其視為package闲坎。

更清晰的資源操作方法

使用各資源class下的get()方法來對(duì)應(yīng)GET嘗試獲取資源。
最簡單的情況下茬斧,只要根據(jù)發(fā)來的請求直接提供對(duì)應(yīng)的信息即可腰懂。
比如,請求中包含了用戶姓名项秉,則返回姓名對(duì)應(yīng)的用戶信息:

# user.py
class User(Resource):

  def get(self, name):
    {% 根據(jù)提供的name從數(shù)據(jù)庫中找到對(duì)應(yīng)user的邏輯 %}
    return {'user': user}, 200 if user is not None else 404

而這段冗長的由name找到數(shù)據(jù)庫中user的邏輯可以提取出來單獨(dú)作為一個(gè)method使代碼更優(yōu)美:

# user.py
class User(Resource):

  def get(self, name):
    user = self.find_by_name(name)
    return {'user': user}, 200 if user is not None else 404

  @classmethod
  def find_by_name(cls, name):
    {% 根據(jù)提供的name從數(shù)據(jù)庫中找到對(duì)應(yīng)user的邏輯 %}
    return user

這樣有了單獨(dú)的find_by_name后绣溜,get只要直接調(diào)用它即可。

新 Method 到新 Class

將與底層數(shù)據(jù)庫的交互邏輯轉(zhuǎn)移到新的method中去可以大幅提高代碼的可讀性娄蔼。
在此基礎(chǔ)上我們還可以更進(jìn)一步怖喻,將所有類似的邏輯從原資源中剝離出來,構(gòu)建一個(gè)新class:

# user.py
class UserModel():

  @classmethod
  def find_by_name(cls, name):
    {% 根據(jù)提供的name從數(shù)據(jù)庫中找到對(duì)應(yīng)user的邏輯 %}
    return user
  

class User(Resource):

  def get(self, name):
    # Call the find_by_name() method from class UserModel
    user = UserModel.find_by_name(name)
    return {'user': user}, 200 if user is not None else 404

資源與模型

到目前為止岁诉,所有資源class中僅剩直接與API調(diào)用者直接交互的方法锚沸,get()/post()/put() ...
其余輔助CRUD操作的邏輯都被轉(zhuǎn)移到了新的對(duì)應(yīng)class中,由CRUD操作來調(diào)用涕癣,
比如之前用來舉例的 Class User (資源) 對(duì)應(yīng) Class UserModel (輔助)哗蜈。

為了更好的工程結(jié)構(gòu),可以把所有的輔助class單獨(dú)成文件坠韩,
并集中到專門的models文件夾下距潘,

#models/user.py

class UserModel:
  ...
#resources/user.py

from flask_restful import Resource, reqparse
from models.user import UserModel

class User(Resource):

  def get(self, name):
    # Call the find_by_name() method from class UserModel
    user = UserModel.find_by_name(name)
    return {'user': user}, 200 if user is not None else 404

文件名盡量便于識(shí)別,可以一眼認(rèn)出與資源class的對(duì)應(yīng)關(guān)系:

./resources
| --- __init__.py
|--- item.py
|--- user.py

./models
| --- __init__.py
|--- item.py
|--- user.py

因此同眯,resources(資源)文件夾下都是外部API調(diào)用者直接交互的部分绽昼,
即API的外部展示唯鸭,
models(模型)下則是各種內(nèi)部邏輯(如與數(shù)據(jù)庫的交互)须蜗,
即API的內(nèi)部表示

整體交互關(guān)系如下:
API caller <--> resources <--> models <--> DataBases

這樣目溉,我們就可以得到一個(gè)較為清晰的代碼結(jié)構(gòu)明肮。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市缭付,隨后出現(xiàn)的幾起案子柿估,更是在濱河造成了極大的恐慌,老刑警劉巖陷猫,帶你破解...
    沈念sama閱讀 219,039評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件秫舌,死亡現(xiàn)場離奇詭異的妖,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)足陨,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,426評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門嫂粟,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人墨缘,你說我怎么就攤上這事星虹。” “怎么了镊讼?”我有些...
    開封第一講書人閱讀 165,417評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵宽涌,是天一觀的道長。 經(jīng)常有香客問我蝶棋,道長卸亮,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,868評(píng)論 1 295
  • 正文 為了忘掉前任玩裙,我火速辦了婚禮嫡良,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘献酗。我一直安慰自己寝受,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,892評(píng)論 6 392
  • 文/花漫 我一把揭開白布罕偎。 她就那樣靜靜地躺著很澄,像睡著了一般。 火紅的嫁衣襯著肌膚如雪颜及。 梳的紋絲不亂的頭發(fā)上甩苛,一...
    開封第一講書人閱讀 51,692評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音俏站,去河邊找鬼讯蒲。 笑死,一個(gè)胖子當(dāng)著我的面吹牛肄扎,可吹牛的內(nèi)容都是我干的墨林。 我是一名探鬼主播,決...
    沈念sama閱讀 40,416評(píng)論 3 419
  • 文/蒼蘭香墨 我猛地睜開眼犯祠,長吁一口氣:“原來是場噩夢啊……” “哼旭等!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起衡载,我...
    開封第一講書人閱讀 39,326評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤搔耕,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后痰娱,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體弃榨,經(jīng)...
    沈念sama閱讀 45,782評(píng)論 1 316
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡菩收,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,957評(píng)論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了鲸睛。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片坛梁。...
    茶點(diǎn)故事閱讀 40,102評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖腊凶,靈堂內(nèi)的尸體忽然破棺而出划咐,到底是詐尸還是另有隱情,我是刑警寧澤钧萍,帶...
    沈念sama閱讀 35,790評(píng)論 5 346
  • 正文 年R本政府宣布褐缠,位于F島的核電站,受9級(jí)特大地震影響风瘦,放射性物質(zhì)發(fā)生泄漏队魏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,442評(píng)論 3 331
  • 文/蒙蒙 一万搔、第九天 我趴在偏房一處隱蔽的房頂上張望胡桨。 院中可真熱鬧,春花似錦瞬雹、人聲如沸昧谊。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,996評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽呢诬。三九已至,卻和暖如春胖缤,著一層夾襖步出監(jiān)牢的瞬間尚镰,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,113評(píng)論 1 272
  • 我被黑心中介騙來泰國打工哪廓, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留狗唉,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,332評(píng)論 3 373
  • 正文 我出身青樓涡真,卻偏偏與公主長得像分俯,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子综膀,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,044評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理澳迫,服務(wù)發(fā)現(xiàn)局齿,斷路器剧劝,智...
    卡卡羅2017閱讀 134,661評(píng)論 18 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,167評(píng)論 25 707
  • 新一年的第二天。休息在家包羊肉餃子抓歼,陳之前說想吃讥此。 早上吃了蛋炒飯就去菜市場買羊肉和大蔥拢锹。回來自己剁餡萄喳,和面卒稳,...
    望飛雪閱讀 127評(píng)論 0 1
  • 夜幕輕垂,天琴他巨,天鷹充坑,最亮的星子在輝映 酒過七分,鏡子里的你染突,像看到了終點(diǎn) 記得嗎捻爷!用座標(biāo)來橫量兩顆星子,一輩子也...
    0夏風(fēng)鸞歌0閱讀 310評(píng)論 1 2
  • 冬風(fēng)漸暖,二月春生司志。地上落花枝上紅甜紫。晴空時(shí)有飛鳥過,荒徑漸聞草蟲鳴骂远。 光陰流轉(zhuǎn)囚霸,青春難現(xiàn)。拄筆半因六月天激才。一紙文憑...
    德路閱讀 197評(píng)論 0 0