Flaskでミドルウェアを作成し使用する方法

概要

Flaskは、ミドルウェア（middleware）を使用して、リクエストとレスポンスの間で処理を実行する能力を持つフレームワークです。ミドルウェアは、リクエストオブジェクト、レスポンスオブジェクト、および次のミドルウェア関数へのアクセスを提供します。ミドルウェアは、Flaskのルートハンドラ内で使用されます。

ここでは、以下のバージョンを使用して、Flaskでミドルウェアを作成する方法を紹介します。

Flask v2.1.0
Python v3.11.4

また、今回作成するコードは全て、GitHubに掲載しています。

ミドルウェアを使用する方法

Flaskでは、ミドルウェアを使用するために、Flaskアプリケーションのwsgi_app属性をオーバーライドします。

from flask import Flask

app = Flask(__name__)

class Middleware():
    def __init__(self, app):
        self.wrapped_app = app

    def __call__(self, environ, start_response):
        print('This is an application-level middleware')
        return self.wrapped_app(environ, start_response)

app.wsgi_app = Middleware(app.wsgi_app)

上記のコードでは、Middlewareという名前のアプリケーションレベルミドルウェアが作成されています。このミドルウェアは、すべてのリクエストに対して実行されます。

ミドルウェアを作成する方法

以下の例では、Middlewareという名前のミドルウェアを作成します。

app.py

from flask import Flask

app = Flask(__name__)

class Middleware():
    def __init__(self, app):
        self.wrapped_app = app

    def __call__(self, environ, start_response):
        print('ミドルウェアの実行')
        return self.wrapped_app(environ, start_response)

app.wsgi_app = Middleware(app.wsgi_app)

@app.route('/')
def root():
    return {"message": "Hello, World!"}

解説

  • Flaskのインスタンスを作成
from flask import Flask
app = Flask(__name__)

Flaskモジュールをインポートし、そのインスタンスを作成します。

  • ミドルウェアクラスの定義
class Middleware():
    def __init__(self, app):
        self.wrapped_app = app

    def __call__(self, environ, start_response):
        print('ミドルウェアの実行')
        return self.wrapped_app(environ, start_response)

Middlewareという名前のミドルウェアクラスを定義します。このクラスは、コンストラクタでFlaskアプリケーションを受け取り、__call__メソッドでミドルウェアのロジックを実装します。

  • ミドルウェアの適用
app.wsgi_app = Middleware(app.wsgi_app)

Flaskアプリケーションのwsgi_app属性を上書きして、新たに定義したミドルウェアを適用します。

  • ルートハンドラの定義
@app.route('/')
def root():
    return {"message": "Hello, World!"}

/というパスへのGETリクエストをハンドリングするルートハンドラーを定義します。リクエストが来ると、{ message: 'Hello, World!' }というオブジェクトをレスポンスとして返します。

テスト

以下のコマンドをターミナルから実行します。

export FLASK_APP=main
flask run

その後、以下のコマンドでテストします。

curl -X GET http://localhost:5000

まとめ

この記事では、Flaskフレームワークを使用してミドルウェアを作成・使用する方法を詳しく解説しました。Flaskはリクエストとレスポンスの間で処理を行う能力を有するフレームワークで、ミドルウェアはこの処理における中心的な役割を果たします。

具体的には、アプリケーションレベルのミドルウェア Middleware を作成し、その使用例を示しました。このミドルウェアは、すべてのリクエストに対して実行されます。Flaskでは、wsgi_app属性を上書きすることで、自作のミドルウェアをアプリケーションに適用します。

また、作成したミドルウェアの動作を確認するため、Flaskサーバーを起動し、curlコマンドを使ってテストリクエストを送信する方法も紹介しました。

Flaskの柔軟なルーティング機能と組み合わせることで、ミドルウェアはWebアプリケーションの開発における重要なツールとなります。これらの知識を活用し、効率的で安全なWebアプリケーション開発を進めていきましょう。

← FastAPIでミドルウェアを作成し使用する方法
FlaskのJinja2テンプレートエンジンの使用方法 →