Flask RESTful API开发 Model与Resource(上)

资源 Resource 的摆放

在使用Flask-RESTful的Resource类简化API开发步骤时,所有的资源都可以通过继承Resource类来构建一个单独的class,
并将所有与此资源相关的CRUD操作作为methods添加到对应的class下,使得整个程序结构更加清晰明了。

这种情况下,各资源之间互不影响,可以专门建立一个名为resources的文件夹,并将各资源class单独建立文件:

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

注意在一些较旧的python版本中需要在文件夹中添加init.py来告诉python可以将其视为package。

更清晰的资源操作方法

使用各资源class下的get()方法来对应GET尝试获取资源。
最简单的情况下,只要根据发来的请求直接提供对应的信息即可。
比如,请求中包含了用户姓名,则返回姓名对应的用户信息:

# user.py
class User(Resource):

  def get(self, name):
    {% 根据提供的name从数据库中找到对应user的逻辑 %}
    return {'user': user}, 200 if user is not None else 404

而这段冗长的由name找到数据库中user的逻辑可以提取出来单独作为一个method使代码更优美:

# 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):
    {% 根据提供的name从数据库中找到对应user的逻辑 %}
    return user

这样有了单独的find_by_name后,get只要直接调用它即可。

新 Method 到新 Class

将与底层数据库的交互逻辑转移到新的method中去可以大幅提高代码的可读性。
在此基础上我们还可以更进一步,将所有类似的逻辑从原资源中剥离出来,构建一个新class:

# user.py
class UserModel():

  @classmethod
  def find_by_name(cls, name):
    {% 根据提供的name从数据库中找到对应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调用者直接交互的方法,get()/post()/put() ...
其余辅助CRUD操作的逻辑都被转移到了新的对应class中,由CRUD操作来调用,
比如之前用来举例的 Class User (资源) 对应 Class UserModel (辅助)

为了更好的工程结构,可以把所有的辅助class单独成文件,
并集中到专门的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

文件名尽量便于识别,可以一眼认出与资源class的对应关系:

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

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

因此,resources(资源)文件夹下都是外部API调用者直接交互的部分,
即API的外部展示
models(模型)下则是各种内部逻辑(如与数据库的交互),
即API的内部表示

整体交互关系如下:
API caller <--> resources <--> models <--> DataBases

这样,我们就可以得到一个较为清晰的代码结构。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,834评论 25 707
  • 新一年的第二天。休息在家包羊肉饺子,陈之前说想吃。 早上吃了蛋炒饭就去菜市场买羊肉和大葱。回来自己剁馅,和面,...
    望飞雪阅读 126评论 0 1
  • 夜幕轻垂,天琴,天鹰,最亮的星子在辉映 酒过七分,镜子里的你,像看到了终点 记得吗!用座标来横量两颗星子,一辈子也...
    0夏风鸾歌0阅读 303评论 1 2
  • 冬风渐暖,二月春生。地上落花枝上红。晴空时有飞鸟过,荒径渐闻草虫鸣。 光阴流转,青春难现。拄笔半因六月天。一纸文凭...
    德路阅读 195评论 0 0