Flask RESTful API开发 Model与Resour

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语句。

在资源类中利用模型类

对应的资源类user与userList仍只需调用模型类和其下的各个函数，
就可以方便地实现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()]}