Flask-Middleware und -Erweiterungen

In Flask sind Middleware und Erweiterungen zwei zentrale Mechanismen, um die Funktionalität von Anwendungen zu verbessern und zu erweitern.

Durch Middleware und Erweiterungen können Sie die Funktionalität und Flexibilität von Flask-Anwendungen erheblich verbessern und sie so in die Lage versetzen, verschiedene komplexe Anforderungen zu erfüllen.

Im Folgenden werden die Konzepte beider und ihre Verwendung erläutert.

Flask-Middleware:

  • Verwenden Sie Request-Hooks, um Code an verschiedenen Phasen der Request-Verarbeitung einzufügen.
  • Erstellen Sie benutzerdefinierte Middleware-Klassen, um Anfragen und Antworten zu verarbeiten.

Flask-Erweiterungen:

  • Verwenden Sie vorhandene Erweiterungen (wie Flask-SQLAlchemy, Flask-WTF), um Funktionalität hinzuzufügen.
  • Erstellen Sie benutzerdefinierte Erweiterungen, um spezifische Anforderungen zu erfüllen.

1. Flask-Middleware

Flask-Middleware ist ein Hook zur Verarbeitung von Anfragen und Antworten, der typischerweise verwendet wird, um Operationen auszuführen, bevor Anfragen die View-Funktionen erreichen oder bevor Antworten an Clients gesendet werden. Middleware kann für Protokollierung, Anfrageänderung, Antwortänderung und mehr verwendet werden.

1.1 Request-Hooks

Request-Hooks ermöglichen es Ihnen, Code an verschiedenen Stadien der Anfrageverarbeitung einzufügen. Flask bietet mehrere Hooks zur Behandlung verschiedener Stadien des Anfragelebenszyklus:

  • before_request: Wird vor der Verarbeitung jeder Anfrage ausgeführt.
  • after_request: Wird nach der Verarbeitung jeder Anfrage ausgeführt.
  • teardown_request: Wird nach dem Ende der Anfrageverarbeitung ausgeführt, unabhängig davon, ob eine Ausnahme auftritt.
  • before_first_request: Wird nur ausgeführt, bevor die Anwendung die erste Anfrage verarbeitet.

Code der Datei app.py:

Beispiel

from flask import Flask, request

app = Flask(__name__)

@app.before_request
def before_request():
    print('Before request')

@app.after_request
def after_request(response):
    print('After request')
    return response

@app.teardown_request
def teardown_request(exception):
    print('Teardown request')

@app.route('/')
def index():
    return 'Hello, World!'

if __name__ == '__main__':
    app.run(debug=True)
  • @app.before_request: Gibt "Before request" aus, bevor jede Anfrage verarbeitet wird.
  • @app.after_request: Gibt "After request" aus, nachdem jede Anfrage verarbeitet wurde.
  • @app.teardown_request: Gibt "Teardown request" aus, nachdem jede Anfrage verarbeitet wurde, unabhängig davon, ob eine Ausnahme auftritt.

1.2 Benutzerdefinierte Middleware

Flask ermöglicht es dir außerdem, benutzerdefinierte Middleware-Klassen zu erstellen, die in verschiedenen Phasen der Anfrage- und Antwortverarbeitung arbeiten können.

Code der Datei middleware.py:

Beispiel

class CustomMiddleware:
    def __init__(self, app):
        self.app = app

    def __call__(self, environ, start_response):
        def custom_start_response(status, headers):
            headers.append(('X-Custom-Header', 'Value'))
            return start_response(status, headers)

        return self.app(environ, custom_start_response)

Code der Datei app.py:

Beispiel

from flask import Flask
from middleware import CustomMiddleware

app = Flask(__name__)

app.wsgi_app = CustomMiddleware(app.wsgi_app)

@app.route('/')
def index():
    return 'Hello, World!'

if __name__ == '__main__':
    app.run(debug=True)

CustomMiddleware: Benutzerdefinierte Middleware-Klasse, die einen benutzerdefinierten Antwort-Header hinzufügt.

2. Flask-Erweiterungen

Flask-Erweiterungen sind Plugins, mit denen Flask-Anwendungen um Funktionen erweitert werden. Flask-Erweiterungen können Drittanbieter-Bibliotheken integrieren und bieten Funktionen wie Datenbankintegration, Formularverarbeitung, Benutzerauthentifizierung und mehr.

2.1 Gängige Flask-Erweiterungen

  • Flask-SQLAlchemy: Integriert das SQLAlchemy ORM und macht Datenbankoperationen bequemer.
  • Flask-WTF: Integriert die WTForms-Formularbibliothek und vereinfacht die Formularverarbeitung.
  • Flask-Login: Bietet Benutzersitzungsverwaltung und Benutzerauthentifizierung.
  • Flask-Migrate: Eine Erweiterung für Datenbankmigrationen, basierend auf Alembic.
  • Flask-Mail: Wird zum Versenden von E-Mails verwendet.

2.2 Installation und Verwendung von Flask-Erweiterungen

Am Beispiel von Flask-SQLAlchemy, Installation:

pip install flask-sqlalchemy

Konfiguration und Verwendung, Code der Datei app.py:

Beispiel

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///example.db'
db = SQLAlchemy(app)

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

@app.route('/')
def index():
    return 'Hello, World!'

if __name__ == '__main__':
    app.run(debug=True)

Die SQLAlchemy-Erweiterung integriert SQLAlchemy, sodass Sie Modelle einfach definieren und mit der Datenbank interagieren können.

2.3 Erstellen benutzerdefinierter Erweiterungen

Wenn vorhandene Erweiterungen Ihre Anforderungen nicht erfüllen, können Sie Ihre eigene Erweiterung erstellen. Das Erstellen einer benutzerdefinierten Erweiterung umfasst normalerweise das Definieren einer Klasse, die Initialisierungskonfiguration und zugehörige Funktionalität bereitstellt.

myextension.py Datei-Code:

Beispiel

class MyExtension:
    def __init__(self, app=None):
        if app is not None:
            self.init_app(app)

    def init_app(self, app):
        app.config.setdefault('MY_EXTENSION_CONFIG', 'default_value')
        app.after_request(self.after_request)

    def after_request(self, response):
        response.headers['X-My-Extension'] = 'MyValue'
        return response

Code der Datei app.py:

Beispiel

from flask import Flask
from my import MyExtension

app = Flask(__name__)
my_ext = MyExtension(app)

@app.route('/')
def index():
    return 'Hello, World!'

if __name__ == '__main__':
    app.run(debug=True)

MyExtension: Benutzerdefinierte Erweiterung, die einen benutzerdefinierten Antwort-Header hinzufügt.

Weitere Erweiterungen