Flask-Anfrage und -Antwort

Der Kern einer Webanwendung ist "Anfragen zu empfangen und Antworten zurückzugeben". Dieses Kapitel erklärt umfassend, wie man Anfragedaten liest und verschiedene Arten von Antworten in Flask erstellt.

Alle Beispiele können direkt im Entwicklungsserver ausgeführt und überprüft werden.


Anfrageobjekt — request

Flask stellt alle Anfrageinformationen über ein globales Proxy-Objekt bereit.requestAlle Anfrageinformationen werden bereitgestellt.

Obwohl es ein "globales" Objekt ist, verwendet Flask intern Thread-Isolierung, um sicherzustellen, dass jede Anfrage ihre eigenen Daten erhält.

Beispiel

# Importiere request, ein threadsicheres Proxy-Objekt
from flask import Flask, request

app = Flask(__name__)

@app.route("/debug")
def debug():
    # Gib verschiedene Anfrageinformationen aus, um das Request-Objekt zu verstehen
    return f"""
<h1>Request-Debugging-Info</h1>
    <ul>
<li>Methode: {request.method}</li>
<li>Pfad: {request.path}</li>
<li>Vollständige URL: {request.url}</li>
<li>Host: {request.host}</li>
<li>Client-IP: {request.remote_addr}</li>
        <li>User-Agent:{request.headers.get('User-Agent')}</li>
    </ul>
    """

Besuchen Siehttp://127.0.0.1:5000/debug?foo=barSie können die detaillierten Anfrageinformationen sehen.


Query-Parameter abrufen — request.args

In der URL?Die Parameter danach werden Query-Parameter (Query String) genannt.

Verwendungrequest.argsBeim Auslesen funktioniert es wie ein Wörterbuch:

Beispiel

@app.route("/search")
def search():
    # request.args.get() ruft den Parameter sicher ab, gibt None zurück, wenn der Schlüssel nicht existiert
    keyword = request.args.get("keyword", "")  # Das Abfrage-Schlüsselwort abrufen
    page = request.args.get("page", "1")       # Die Seitennummer abrufen, Standardwert ist 1
    return f"""
<h1>Suchergebnisse</h1>
<p>Schlüsselwort: {keyword}</p>
<p>Seite: {page}</p>
    """

# Test: /search?keyword=flask&page=2
# Test: /search?keyword=EXAMPLE

Empfohlen.get()Verwenden Sie die Methode anstelle des direkten Indexzugriffs.request.args["key"], da letzterer eine Ausnahme auslöst, wenn der Schlüssel nicht existiert.KeyError, was zu einer 400-Fehlerseite führt.


Formulardaten abrufen — request.form

Um von POST-Anfragen übermittelte Formulardaten zu verarbeiten, verwenden Sierequest.form:

Beispiel

@app.route("/register", methods=["GET", "POST"])
def register():
    if request.method == "POST":
        # Verwende den Wert des Feldes name="username" im Formular
        username = request.form.get("username", "")
        password = request.form.get("password", "")

        if not username or not password:
            return "<h1>Fehler</h1><p>Benutzername und Passwort dürfen nicht leer sein</p>", 400

        return f"<h1>Registrierung erfolgreich</h1><p>Willkommen {username} bei EXAMPLE!</p>"

    # Registrierungsformular bei GET-Anfrage anzeigen
    return """
<h1>Registrieren</h1>
    <form method="post">
<p>Benutzername: <input type="text" name="username"></p>
<p>Passwort: <input type="password" name="password"></p>
<p><input type="submit" value="Registrieren"></p>
    </form>
    """

Hinweis: Auf der HTML-Seite, die das Formular verarbeitet,<form>mussmethod="post"gesetzt werden, andernfalls werden die Daten über die URL-Query-Zeichenkette (GET-Methode) gesendet und sensible Informationen werden in der URL offengelegt.


JSON-Daten abrufen — request.json

In der modernen Webentwicklung ist JSON das am häufigsten verwendete Datenformat.

Wenn der Client eine Anfrage mitContent-Type: application/jsonsendet, verwenden Sierequest.json, um die geparsten Daten abzurufen:

Beispiel

@app.post("/api/user")
def create_user():
    # request.json gibt bereits in ein Python-Dict geparste JSON-Daten zurück
    data = request.json  # Zum Beispiel sendet der Client {"name": "example", "email": "test@example.com"}

    # Feld sicher abrufen
    name = data.get("name", "Unknown")
    email = data.get("email", "Not provided")

    # Dict direkt zurückgeben, Flask konvertiert es automatisch in eine JSON-Antwort
    return {
        "message": "Benutzer erfolgreich erstellt",
        "name": name,
        "email": email
    }

Kann zum Testen mitcurloder Postman verwendet werden:

$ curl -X POST http://127.0.0.1:5000/api/user \
  -H "Content-Type: application/json" \
  -d '{"name": "example", "email": "test@example.com"}'
{
  "message": "用户创建成功",
  "name": "example",
  "email": "test@example.com"
}

Datei-Upload

Verwenden Sie dies, um hochgeladene Dateien zu verarbeiten:request.files, kombiniert mit dem von Werkzeug bereitgestelltensecure_filename()Stellen Sie sicher, dass der Dateiname sicher ist:

Beispiel

import os
from werkzeug.utils import secure_filename  # Gefährliche Dateinamenzeichen filtern

# Upload-Verzeichnis konfigurieren (in einem echten Projekt sollte dies aus der Konfiguration gelesen werden)
UPLOAD_DIR = "uploads"

@app.route("/upload", methods=["GET", "POST"])
def upload_file():
    if request.method == "POST":
        # Prüfen, ob eine Datei hochgeladen wurde
        if "file" not in request.files:
            return "Keine Datei ausgewählt", 400

        file = request.files["file"]

        # Benutzer hat möglicherweise ein leeres Formular übermittelt (keine Datei ausgewählt)
        if file.filename == "":
            return "Dateiname ist leer", 400

        # secure_filename filtert gefährliche Zeichen wie Path Traversal heraus
        # Zum Beispiel würde "../../etc/passwd" als "etc_passwd" verarbeitet werden
        filename = secure_filename(file.filename)

        # Sicherstellen, dass das Upload-Verzeichnis existiert
        os.makedirs(UPLOAD_DIR, exist_ok=True)

        # Datei speichern
        file.save(os.path.join(UPLOAD_DIR, filename))
        return fDatei {filename} erfolgreich hochgeladen

    # GET-Anfrage zeigt das Upload-Formular
    return """
<h1>Datei hochladen</h1>
    <form method="post" enctype="multipart/form-data">
        <p><input type="file" name="file"></p>
<p><input type="submit" value="Hochladen"></p>
    </form>
    """

Wenn das Formular ein Datei-Upload-Feld enthält,<form>Das Attribut muss gesetzt werdenenctype="multipart/form-data", andernfalls werden die Dateidaten nicht vom Browser gesendet.


Vollständiger Leitfaden zu Antworttypen

View-Funktionen können mehrere Datentypen zurückgeben, und Flask wandelt sie automatisch in geeignete HTTP-Antworten um.

Das Verständnis dieser Konvertierungsregel ist der Schlüssel zur Beherrschung von Flask.

String zurückgeben

Der zurückgegebene String dient als HTML-Antwortkörper, mit einem Standard-Statuscode von 200 und Content-Type vontext/html。

Ein Dictionary oder eine Liste zurückgeben (JSON)

Automatisch aufgerufen:jsonify()konvertiert in JSON-Antwort, wobei Content-Type aufapplication/json gesetzt wird。

Beispiel

@app.get("/api/posts")
def get_posts():
    # dict zurückgeben, Flask konvertiert automatisch in JSON
    return {
        "status": "ok",
        "data": [
            {"id": 1, "title": Flask-Tutorial},
            {"id": 2, "title": RESTful-API-Design},
        ]
    }

@app.get("/api/tags")
def get_tags():
    # Liste zurückgeben, Flask konvertiert automatisch in JSON
    return ["Python", "Flask", Webentwicklung, "BEISPIEL"]

Rückgabe eines Tupels—Steuerung des Statuscodes und der Antwort-Header

Das Tupel-Format ist sehr praktisch und hat drei Formen:

Beispiel

# Form 1: (body, status_code)
@app.get("/not-found")
def not_found():
    return <h1>Seite nicht gefunden</h1>, 404

# Form 2: (body, headers_dict)
@app.get("/custom-header")
def custom_header():
    return "OK", {"X-Custom-Header": "example"}

# Form 3: (body, status_code, headers_dict)
@app.post("/api/login")
def api_login():
    # Token und benutzerdefinierten Statuscode zurückgeben
    return {"token": "abc123", "user": "example"}, 201, {"X-RateLimit": "100"}

Redirect

Verwendungredirect()Die Funktion leitet den Benutzer zu einer anderen URL weiter:

Beispiel

from flask import Flask, redirect, url_for

app = Flask(__name__)

@app.route("/")
def index():
    # Bei Besuch der Startseite zur Anmeldeseite weiterleiten
    return redirect(url_for("login"))

@app.route("/login")
def login():
    return <h1>Bitte melden Sie sich zuerst an</h1>

@app.route("/old-page")
def old_page():
    # Alte Seite dauerhaft auf neue Seite verschoben, Statuscode 301 verwenden
    return redirect(url_for("new_page"), code=301)

@app.route("/new-page")
def new_page():
    return <h1>Dies ist eine neue Seite</h1>

Der Standard-Statuscode für Weiterleitungen ist303 See Other, geeignet für die Weiterleitung nach dem Absenden eines Formulars (PRG-Muster).

Für dauerhafte Migrationsszenarien verwenden Siecode=301。


Anfrage beenden — abort

Verwendungabort()Die aktuelle Anfrage sofort beenden und einen HTTP-Fehler zurückgeben:

Beispiel

from flask import abort

@app.route("/post/<int:post_id>")
def view_post(post_id):
    # Angenommen, Artikel-IDs sind nur 1-100
    if post_id < 1 or post_id > 100:
        # Sofort 404 zurückgeben, nachfolgender Code wird nicht ausgeführt
        abort(404)

    return f"<h1>Artikel #{post_id}</h1>"

@app.route("/admin")
def admin():
    # 403 bei unbefugtem Zugriff zurückgeben
    abort(403, description=Sie haben keine Berechtigung, auf diese Seite zuzugreifen)

make_response — die Antwort manuell steuern

Wenn Sie Cookies manuell setzen oder Antwort-Header anpassen müssen, verwenden Siemake_response():

Beispiel

from flask import make_response

@app.route("/set-cookie")
def set_cookie():
    # make_response verpackt den Rückgabewert der View-Funktion in ein Response-Objekt
    resp = make_response(<h1>Cookie gesetzt</h1>)

    # Cookie auf dem Response-Objekt setzen
    resp.set_cookie("theme", "dark", max_age=60*60*24)  # 24 Stunden gültig
    resp.set_cookie("lang", "zh-CN")

    # Sie können auch Antwort-Header anpassen
    resp.headers["X-Powered-By"] = "EXAMPLE-Flask"

    return resp

Kurzreferenztabelle der gängigen Request-Attribute

Eigenschaft Type Beschreibung Beispielwert
request.method str HTTP-Request-Methode "GET", "POST"
request.path str URL-Pfad (ohne Domainnamen) "/search"
request.args MultiDict URL-Query-Parameter ?keyword=flask&page=1
request.form MultiDict POST-Formulardaten username=admin
request.json dict oder None JSON-Anfragekörper (geparst) {"name": "example"}
request.files FileMultiDict Hochgeladene Datei request.files["avatar"]
request.headers Headers Anfrage-Header request.headers["User-Agent"]
request.cookies dict Vom Client gesendetes Cookie request.cookies.get("theme")
request.remote_addr str Client-IP-Adresse "127.0.0.1"
Weitere Erweiterungen