关于 Flask CRUD 视图的最佳实践

Best practices regarding Flask CRUD Views

我目前正在开发一个 CRUD 应用程序,它最终会跨越一个相当大的数据库,我想使用最佳实践来解决这个问题。

当我设计 Flask 视图时,我目前将所有功能都放在一个视图中,就像这样。

@userBlueprint.route('/<string:lang>/user', methods=['GET'])
@userBlueprint.route('/<string:lang>/user/<string:function>', methods=['GET', 'POST'])
@userBlueprint.route('/<string:lang>/user/<string:function>/<int:id>', methods=['GET', 'POST'])
def userView(lang=None, id=None, function=None):
    if function == None:
        pass
    elif function == 'delete':
        pass        
    else:
        if function == 'update':
            pass
        elif function == 'new':
            pass

您可以想象,当考虑所有数据库功能(关系、选择字段选择生成、多租户控制等)时,此视图会变得相当大。

完成相同任务的另一种方法是像这样构建五个视图。

@userBlueprint.route('/<string:lang>/user', methods=['GET'])
def getUsers(lang=None):
    pass

@userBlueprint.route('/<string:lang>/user', methods=['POST'])
def newUsers(lang=None):
    pass

@userBlueprint.route('/<string:lang>/user/<int:id>', methods=['GET'])
def getUser(lang=None, id=None):
    pass

@userBlueprint.route('/<string:lang>/user/<int:id>', methods=['POST'])
def deleteUser(lang=None, id=None):
    pass

@userBlueprint.route('/<string:lang>/user/<int:id>', methods=['POST'])
def modifyUser(lang=None, id=None):
    pass

这里的缺点当然是我需要放入很多重复的代码。

是否考虑了其中一种方法"best practice",如果没有,是否有第三种选择?

它的built-in工具是flaskmethod views,它们是专门为帮助你在不同的函数中实现不同的对象动作而设计的:

class UserAPI(MethodView):

    def get(self, user_id):
        if user_id is None:
            # return a list of users
            pass
        else:
            # expose a single user
            pass

    def post(self):
        # create a new user
        pass

    def delete(self, user_id):
        # delete a single user
        pass

    def put(self, user_id):
        # update a single user
        pass

user_view = UserAPI.as_view('user_api')
app.add_url_rule('<string:lang>/user/', defaults={'user_id': None}, view_func=user_view, methods=['GET'])
app.add_url_rule('<string:lang>/user/', view_func=user_view, methods=['POST'])
app.add_url_rule('<string:lang>/user/<int:user_id>', view_func=user_view, methods=['GET', 'PUT', 'DELETE'])

为不同的表实现多个视图将非常容易:创建 BaseAPI 方法视图并从中创建子类。 Getting/updating/deleting一个对象对于不同的表可能是相似的。

您还可以查看 flask-admin 包中 CRUD 的实现。它的路线是这样分组的:

  • <string:tablename>/ (GET) — 显示对象列表
  • <string:tablename>/new/ (GET, POST) — 显示创建对象的表单/创建对象
  • <string:tablename>/edit/ (GET, POST) - 显示用于编辑对象/更新对象的表单
  • <string:tablename>/delete/ (POST) - 删除对象