主页 / coding / 问题 / 79307475
Accepted
Konrad Viltersten
Asked: 2024-12-25 19:30:32 +0800 CST

无法决定基于资源还是基于路由的调用

  • 772

由于我对 Python 以及 Flask 非常陌生，因此我对惯例、最佳实践和常用知识感到困惑。我尝试遵循 Microsoft 提供的示例（因为我们正在使用 Azure），我开始怀疑它们可能是... Microsoft'ish（即“它有效，但是...”）。

根据各种示例，我创建了两个端点，它们进行相同的计算，从而产生等效的有效载荷（但结构不同！），我无法确定哪种方法是推荐的。一种是使用资源（与路由相结合），另一种是显式路由。

from flask import Flask
from flask_restful import Api, Resource, request
from logic import compute

app = Flask(__name__)
api = Api(app)

class computer (Resource):
    def get(self):
        return compute(request.args.to_dict())

api.add_resource(computer, "/compute-resource")

@app.route("/compute-route", methods=["GET"])
def execute():
    return compute(request.args.to_dict())

if __name__ == "__main__":
    app.run()

我在输出中注意到的唯一（奇怪的是出乎意料的）是后者似乎按字母顺序对返回的 JSON 字段进行排序，而第一个却没有。

  1. 这两种方法中哪一种更可取或者它们是否同样适用？
  2. 字段排序的偏差说明了什么问题？
python

1 个回答

  1. Best Answer

    您的问题涉及设计 Flask API 时常见的困境：是使用基于Flask-RESTful 的Resource方法还是基于 Flask 路由的方法。两者都有效且各有千秋，具体取决于您的用例和偏好。

    主要区别

    1. Flask-RESTful（Resource）：

      • 鼓励面向对象编程。
      • 适用于资源（“用户”或“订单”等实体）映射到 URL 端点的 RESTful API。
      • 使用类方法轻松组织不同 HTTP 方法（、、、GET）的逻辑。POSTPUTDELETE
      • 字段排序：Flask-RESTful 默认不对 JSON 键进行排序，这就是您观察到未排序字段的原因。

      例子：

      class UserResource(Resource):
    def get(self):
        return {"name": "Alice", "age": 25}  # Order preserved.

    2. 基于路线的方法（@app.route）：

      • 对于 Flask 初学者来说，它是传统的并且更容易理解。
      • 非常适合小型应用程序或非 RESTful API，其中端点是程序性的或一次性的。
      • 字段排序：该jsonify函数（Flask 隐式使用@app.route）在序列化为 JSON 时默认按字母顺序对键进行排序。

      例子：

      @app.route("/user")
def user():
    return {"age": 25, "name": "Alice"}  # Alphabetically sorted as {"age": 25, "name": "Alice"}.

    最佳实践

    1. 何时使用Flask-RESTful：

      • 您的应用程序需要 RESTful 设计原则。
      • 您有多个需要组织的资源和端点。
      • 您计划扩展 API 或在团队中工作，基于类的方法有助于提高可读性和可维护性。

    2. 何时使用基于路线：

      • 该应用程序很小，添加 Flask-RESTful 有点小题大做。
      • 端点数量有限，不需要复杂的组织。
      • 与 Flask-RESTful 提供的额外抽象相比，您更喜欢简单性。

    你的情况

    由于两种方法都会产生相同的结果，唯一的区别是字段顺序：

    1. 如果您正在构建 RESTful API（例如，用于 Azure 集成或更大的项目），请坚持使用 Flask-RESTful，因为它的结构和可扩展性。
    2. 如果这是一个小型实用程序或一次性端点，则基于路线的方法完全没问题。

    关于字段排序

    字段排序的偏差是由于：

    • Flask-RESTful直接使用 Python 的json库，它保留了字典的插入顺序。
    • 基于路由的方法使用 Flask 的jsonify，它sort_keys=True在转储 JSON 时默认应用。

    如果您想控制基于路由的方法中的字段排序，您可以像这样禁用排序：

    from flask import jsonify

@app.route("/compute-route", methods=["GET"])
def execute():
    return jsonify(compute(request.args.to_dict())), 200, {"Content-Type": "application/json"}

    推荐

    为了实现可维护性和可扩展性，尤其是在使用 Azure 或类似平台时，请采用 Flask-RESTfulResource。它符合 REST API 标准，并随着项目的增长保持代码井然有序。

    • 1

相关问题