Memahami JSONify(), to_dict(), make_response(), dan SerializerMixin dalam Flask

Flask menyediakan beberapa alatan untuk transformasi data kepada respons, daripada menukar objek Python kepada JSON kepada mencipta respons HTTP berstruktur. Dalam siaran ini, kami akan meneroka jsonify(), to_dict(), make_response(), dan SerializerMixin, yang merupakan empat fungsi dan alatan berguna untuk bekerja dengan respons data dalam Flask. Memahami alatan ini akan membantu mencipta API yang lebih baik dan pengurusan data yang berkesan.

jsonify()
Ia ialah fungsi Flask terbina dalam yang menukar struktur data Python kepada format JSON, format pertukaran data ringan yang digunakan secara meluas dalam pembangunan web untuk API. Fungsi ini secara automatik menetapkan Jenis Kandungan respons kepada aplikasi/json dan mengembalikan objek respons Flask, menjadikannya sesuai untuk mengembalikan data dalam API REST.

Contoh:

from flask import jsonify

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

Di sini, jsonify(data) menukar data kamus ke dalam format JSON dan menetapkannya sebagai badan tindak balas. Fungsi ini berguna apabila anda perlu mengembalikan data yang kecil dan jelas, kerana ia mengendalikan penukaran JSON dan pemformatan respons untuk anda. Adalah penting untuk ambil perhatian bahawa jsonify() berfungsi dengan baik dengan jenis data ringkas tetapi tidak menyokong objek kompleks secara langsung, seperti model SQLAlchemy, tanpa sedikit penukaran (seperti menggunakan to_dict()).

to_dict()
Ia bukan fungsi Flask asli tetapi biasanya digunakan dalam kelas model untuk mewakili SQLAlchemy atau contoh model Object Relational Mapping(ORM) sebagai kamus. Penukaran atribut model kepada kamus ini menjadikan data lebih mudah untuk ditukar kepada format JSON untuk respons API.
Contoh:

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

Kaedah to_dict() menyediakan fleksibiliti dengan membenarkan anda menentukan data yang tepat untuk disertakan dalam respons. Ia berguna untuk menyembunyikan data sensitif (seperti kata laluan) dan secara terpilih hanya menunjukkan atribut yang diperlukan.

buat_tindak balas()
Ia ialah fungsi utiliti Flask yang membolehkan anda membuat respons HTTP tersuai. Walaupun jsonify() memudahkan respons data JSON, make_response() membenarkan anda mengawal setiap bahagian respons, termasuk kod status, pengepala dan format data.

Contoh:

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)

Di sini, make_response() membenarkan kawalan ke atas kod status dan format badan respons. Fleksibiliti ini sesuai apabila kawalan objek tindak balas adalah sangat penting.

SerializerMixin
Ia adalah daripada perpustakaan sqlalchemy-serializer dan merupakan alat yang berkuasa untuk mengautomasikan penyirian model SQLAlchemy. Ia menyediakan kaedah to_dict() yang boleh mengendalikan jenis data kompleks yang merangkumi perhubungan antara model dan termasuk atribut serialize_rules untuk mengawal medan untuk disirikan.

Penggunaan:

from flask import jsonify

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

SerializerMixin mengautomasikan penukaran model SQLAlchemy kepada kamus yang menjadikannya berguna apabila bekerja dengan model dan perhubungan yang kompleks. Dengan serialize_rules, anda boleh memasukkan atau mengecualikan medan atau perhubungan secara dinamik, yang menjimatkan masa anda menulis kaedah to_dict tersuai untuk setiap model.

Perbandingan dan Bagaimana Ia Berkaitan
Setiap alatan ini mempunyai tempatnya dalam membina API Flask. jsonify() dan make_response() ialah fungsi Flask yang penting untuk mencipta JSON dan respons tersuai, manakala to_dict() dan SerializerMixin tertumpu pada menukar contoh model kepada kamus untuk pensirilan JSON yang lebih mudah.

Berikut ialah ringkasan masa untuk menggunakan setiap satu:

• Gunakan jsonify() untuk menukar struktur data Python ringkas kepada format JSON dengan mudah.
• Gunakan to_dict() pada model anda untuk membuat kamus tersuai dengan medan khusus untuk penukaran JSON, terutamanya apabila bekerja dengan data sensitif atau kompleks.
• Gunakan make_response() untuk menentukan kawalan penuh ke atas respons HTTP, membolehkan anda menetapkan kod status, pengepala atau mesej ralat tersuai.
• Gunakan SerializerMixin jika anda menggunakan model SQLAlchemy dan mahu menukar model secara automatik (termasuk perhubungan) kepada JSON dengan konfigurasi minimum.

Kesimpulannya, jsonify(), to_dict(), make_response(), dan SerializerMixin adalah semua alatan penting untuk mengubah dan mengurus data dalam Flask API. Menggunakannya dengan berkesan akan menjadikan API anda lebih fleksibel, selamat dan terurus.

Rujukan

• Dokumentasi Kelalang: make_response()

• SQLAlchemy SerializerMixin

Atas ialah kandungan terperinci Memahami JSONify(), to_dict(), make_response(), dan SerializerMixin dalam Flask. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!