Flask RESTful API开发 Model与Resource(下)

Model的由来

Model与Resource(上) 中,
models文件夹下那些对应Resource的类,
它们的主要任务是:
提供并管理 Resource类下CRUD操作需要用到的逻辑,
这些逻辑更多的涉及内部操作,
不与API调用者直接交互,
因此从CRUD中剥离出来能使代码结构更清晰。

与数据库的交互

那么,问题来了,
哪些API调用者不直接交互的内部逻辑会被CRUD操作使用到?
最重要的一部分就是与底层数据库的交互

这样的话,models文件夹下的那些模型类,
ItemModel, UserModel, ...
它们的主要任务就是,
抽象出与底层数据库交互的方法,
search_by_name(), search_by_id()
再提供给Resource类下的CRUD方法调用。

ORM

假设我们使用了传统关系型数据库MySQL存储数据,
模型类下的各个methods就将需要读取,搜索,删除MySQL中的数据。

第一种方法是使用相应的SQL语句来与数据库交互。

但还有一个更好的方法:
使用ORM (object relational mapping)。

这里没有篇幅对ORM展开介绍,Wiki推荐阅读

Flask有一个很好的第三方拓展Flask-SQLAlchemy来帮助引入ORM。
如果使用的不是关系型数据库,
还有类似的比如Flask-MongoEngine等可供选择。

改造模型类

引入Flask-SQLAlchemy并实例化最关键的SQLAlchemy类:

# db.py
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

SQLAlchemy类下有着众多帮助实现ORM的函数。

接着需要对已有的模型类进行对应改造:

# models/userModel.py
from db import db

class UserModel(db.Model):
    # UserModel对应的表格: users
    __tablename__ = 'users'

    # 
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80))
    password = db.Column(db.String(80))

    def __init__(self, username, password):
        self.username = username
        self.password = password

    def save_to_db(self):
        # 插入行
        db.session.add(self)
        # 提交改动
        db.session.commit()

    @classmethod
    def find_by_username(cls, username):
        # 根据一定条件检索
        return cls.query.filter_by(username=username).first()

    @classmethod
    def find_by_id(cls, _id):
        return cls.query.filter_by(id=_id).first()

这样一来,
就通过SQL_Alchemy类的实例化:db下的辅助函数,
替代了纯SQL语句。

在资源类中利用模型类

对应的资源类useruserList仍只需调用模型类和其下的各个函数,
就可以方便地实现CRUD操作。

# resources/user.py

from flask_restful import Resource, reqparse
# 导入对应的模型类
from models.user import UserModel

class User(Resource):
  def get(self, name):
    # 调用模型类下的函数
    user = UserModel.find_by_name(name)
    if user:
      return user.json()
    return {'message': 'User not found'}, 404
# resources/userList.py

from flask_restful import Resource, reqparse
# 导入对应的模型类
from models.user import UserModel

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

推荐阅读更多精彩内容