Flask の JSONify()、to_dict()、make_response()、および SerializerMixin を理解する

Flask は、Python オブジェクトから JSON への変換から構造化 HTTP 応答の作成まで、データを応答に変換するためのツールをいくつか提供します。この投稿では、Flask でデータ応答を操作するための 4 つの便利な関数とツールである jsonify()、to_dict()、make_response()、および SerializerMixin について説明します。これらのツールを理解することは、より優れた API と効果的なデータ管理の作成に役立ちます。

jsonify()
これは、Python データ構造を API の Web 開発で広く使用されている軽量のデータ交換形式である JSON 形式に変換する組み込みの Flask 関数です。この関数は、応答 Content-Type を application/json に自動的に設定し、Flask 応答オブジェクトを返すため、REST API でデータを返すのに最適です。

例:

from flask import jsonify

@app.route('/data')
def get_data():
    data = {"message": "Hello, World!", "status": "success"}
    return jsonify(data)

ここでは、jsonify(data)で辞書データをJSON形式に変換し、レスポンスボディとして設定しています。この関数は、JSON 変換と応答の書式設定を処理するため、小さく明確に定義されたデータを返す必要がある場合に役立ちます。 jsonify() は単純なデータ型では適切に機能しますが、何らかの変換 (to_dict() の使用など) を行わないと SQLAlchemy モデルなどの複雑なオブジェクトを直接サポートしないことに注意することが重要です。

to_dict()
これはネイティブの Flask 関数ではありませんが、SQLAlchemy または他のオブジェクト リレーショナル マッピング (ORM) モデル インスタンスを辞書として表すためにモデル クラスでよく使用されます。このモデル属性の辞書への変換により、データを API 応答用の JSON 形式に変換しやすくなります。
例:

class Student(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), nullable=False)

    def to_dict(self):
        return {
            "id": self.id,
            "username": self.username
        }

@app.route('/user/<int:id>')
def get_student(id):
    student = Student.query.get(id)
    return jsonify(student.to_dict()) if student else jsonify({"error": "Student not found"}), 404

to_dict() メソッドを使用すると、応答に含める正確なデータを指定できるため、柔軟性が高まります。これは、機密データ (パスワードなど) を非表示にし、必要な属性のみを選択的に表示するのに役立ちます。

make_response()
これは、カスタム HTTP 応答を作成できる Flask ユーティリティ関数です。 jsonify() は JSON データ応答を簡素化しますが、make_response() を使用すると、ステータス コード、ヘッダー、データ形式など、応答のあらゆる部分を制御できます。

例:

from flask import make_response, jsonify
from models import db

class Student(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), nullable=False)

    def to_dict(self):
        return {
            "id": self.id,
            "username": self.username
        }

@app.route('/student/<int:id>', methods=['GET'])
def get_student(id):
    # Query the database for the student
    student = Student.query.get(id)

    # If student is found, return data with a 200 status
    if student:
        response_data = {
            "message": "Student found",
            "data": student.to_dict()
        }
        return make_response(jsonify(response_data), 200)

    # If student is not found, return a structured error response with a 404 status
    error_data = {
        "error": "Student not found",
        "student_id": id,
        "status_code": 404
    }
    return make_response(jsonify(error_data), 404)

ここで、make_response() を使用すると、ステータス コードと応答本文の形式を制御できます。この柔軟性は、応答オブジェクトの制御が最も重要である場合に理想的です。

SerializerMixin
これは sqlalchemy-serializer ライブラリからのもので、SQLAlchemy モデルのシリアル化を自動化するための強力なツールです。これは、モデル間の関係を含む複雑なデータ型を処理できる to_dict() メソッドを提供し、シリアル化するフィールドを制御する Serialize_rules 属性を含みます。

使用法:

from flask import jsonify

@app.route('/data')
def get_data():
    data = {"message": "Hello, World!", "status": "success"}
    return jsonify(data)

SerializerMixin は、SQLAlchemy モデルの辞書への変換を自動化し、複雑なモデルや関係を扱うときに便利です。 Serialize_rules を使用すると、フィールドやリレーションシップを動的に含めたり除外したりできるため、モデルごとにカスタムの to_dict メソッドを作成する時間を節約できます。

比較とその関係
これらの各ツールは、Flask API の構築において役割を果たします。 jsonify() と make_response() は、JSON とカスタム レスポンスを作成するために不可欠な Flask 関数ですが、to_dict() と SerializerMixin は、JSON のシリアル化を容易にするためにモデル インスタンスを辞書に変換することに重点を置いています。

それぞれをいつ使用するかをまとめます:

• jsonify() を使用して、単純な Python データ構造を JSON 形式に簡単に変換します。
• 特に機密データや複雑なデータを扱う場合は、モデルで to_dict() を使用して、JSON 変換用の特定のフィールドを含むカスタム辞書を作成します。
• make_response() を使用して HTTP 応答に対する完全な制御を定義し、ステータス コード、ヘッダー、またはカスタム エラー メッセージを設定できるようにします。
• SQLAlchemy モデルを使用していて、最小限の構成でモデル (リレーションシップを含む) を JSON に自動的に変換したい場合は、SerializerMixin を使用してください。

結論として、jsonify()、to_dict()、make_response()、および SerializerMixin はすべて、Flask API でデータを変換および管理するために不可欠なツールです。これらを効果的に使用すると、API がより柔軟で安全になり、管理しやすくなります。

参考文献

• Flask ドキュメント: make_response()

• SQLAlchemy SerializerMixin

以上がFlask の JSONify()、to_dict()、make_response()、および SerializerMixin を理解するの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。