ミドルウェアは、Django のリクエスト/レスポンス処理にフックを加えるためのフレームワークです。これは、Django の入力あるいは出力をグローバルに置き換えるための、軽量で低レベルの「プラグイン」システムです。
\n各ミドルウェアのコンポーネントは、それぞれある特定の機能を実行する役目を持っています。たとえば、Django には AuthenticationMiddleware というミドルウェアコンポーネントがあります。このミドルウェアは、セッションを利用して、リクエストとユーザーとを関連付けます。
このドキュメントでは、ミドルウェアが機能するしくみ、ミドルウェアを有効にする方法、そして、自分でミドルウェアを書く方法について説明します。Django には組み込みのミドルウェアがいくつか用意されているので、自分で書かなくてもすぐに使い始めることができます。これらの組み込みのミドルウェアについては、組み込みミドルウェアリファレンス にドキュメントされているので参照してください。
\nミドルウェアファクトリは、ミドルウェアを返す get_response を取る呼び出し可能なオブジェクトです。ミドルウェアは (ビューと同じように) リクエストを受け取ってレスポンスを返す呼び出し可能なオブジェクトです。
ミドルウェアは、以下のように関数として書くことができます:
\ndef simple_middleware(get_response):\n # One-time configuration and initialization.\n\n def middleware(request):\n # Code to be executed for each request before\n # the view (and later middleware) are called.\n\n response = get_response(request)\n\n # Code to be executed for each request/response after\n # the view is called.\n\n return response\n\n return middleware\nもしくは、インスタンスを呼び出し可能なクラスとして書くこともできます:
\nclass SimpleMiddleware:\n def __init__(self, get_response):\n self.get_response = get_response\n # One-time configuration and initialization.\n\n def __call__(self, request):\n # Code to be executed for each request before\n # the view (and later middleware) are called.\n\n response = self.get_response(request)\n\n # Code to be executed for each request/response after\n # the view is called.\n\n return response\nDjango によって渡される get_response 呼び出し可能オブジェクトは、実際の (これがミドルウェアの最後にリストアップされている場合) ビューか、チェーン内の次のミドルウェアの可能性があります。現在のミドルウェアはこれが何かを知る必要も気にする必要もなく、ただ次に来るものを表します。
上記は、わずかに単純化したものです -- チェーン内の際にリストアップされたミドルウェアに対する get_response は実際のビューではなく ビューミドルウェア を適用する処理を行うハンドラからのラッパーメソッドです。これは適切な URL 属性でビューを呼び出し、テンプレートレスポンス と 例外 を適用します。
Middleware can either support only synchronous Python (the default), only\nasynchronous Python, or both. See 非同期サポート for details of how to\nadvertise what you support, and know what kind of request you are getting.
\nミドルウェアは、あなたの Ptyhon パスのどこでも使うことができます。
\n__init__(get_response)Link to this heading#ミドルウェアファクトリは get_response 引数を受け取る必要があります。ミドルウェアに対してグローバルな宣言を初期化することもできます。いくつかの注意事項があります:
Django は get_response 引数でミドルウェアを初期化するため、__init__() で他の引数を必須にすることはできません。
リクエストごとに 1 回呼ばれる __call__() メソッドとは異なり、__init__() はウェブサーバが起動したときに 1回だけ 呼ばれます。
起動時にミドルウェアを使うかどうかを決めることは、ときに有用です。この場合、ミドルウェアの __init__() メソッドが MiddlewareNotUsed を投げる可能性があります。Django はミドルウェアプロセスからこのミドルウェアを削除し、DEBUG が True のときはデバッグメッセージを django.request ロガーに記録します。
ミドルウェア要素をアクティブ化するには、Django の設定内の MIDDLEWARE リストに追加してください。
MIDDLEWARE では、各ミドルウェア要素は文字列で表されます: ミドルウェアファクトリのクラスや関数名に対する完全な Python パスです。 例えば、以下は django-admin startproject で生成されるデフォルト値です:
MIDDLEWARE = [\n 'django.middleware.security.SecurityMiddleware',\n 'django.contrib.sessions.middleware.SessionMiddleware',\n 'django.middleware.common.CommonMiddleware',\n 'django.middleware.csrf.CsrfViewMiddleware',\n 'django.contrib.auth.middleware.AuthenticationMiddleware',\n 'django.contrib.messages.middleware.MessageMiddleware',\n 'django.middleware.clickjacking.XFrameOptionsMiddleware',\n]\nDjango の導入では、ミドルウェアは必須ではありません — お望みならば MIDDLEWARE は空でも構いません — しかし、最低でも CommonMiddleware を使うことを強くお勧めします。
ミドルウェアは他のミドルウェアに依存するため、MIDDLEWARE の順番は重要です。AuthenticationMiddleware はセッション内に認証済みユーザを保持します。したがって、SessionMiddleware の後に起動する必要があります。Django のミドルウェアクラスの順番については、Middleware の順序 を参照してください。
ビューを呼び出す前、リクエストの段階で、Django は MIDDLEWARE 内で定義された順番で上から下に向かってミドルウェアを適用します。
これはタマネギのように考えることができます: 各ミドルウェアクラスは、タマネギの中心にあるビューをラップする "レイヤ" です。リクエストがタマネギのすべてのレイヤ (つまり中心にあるビューにいたる全ての道) を通過すると (各レイヤーは get_response を呼び出してリクエストを次のレイヤに渡します)、レスポンスは各レイヤーを (逆順で) 通過して戻ります。
いずれかのレイヤが短絡し、get_response を呼び出さずにレスポンスを返すことを決定した場合、そのレイヤの内側にあるタマネギの (ビューを含む) レイヤはリクエストおよびレスポンスを受け取りません。 レスポンスは、リクエストが通過したのと同じレイヤーを介してのみ返されます。
上述した基本的なリクエストやレスポンスのミドルウェアパターンのほかに、3 つの特殊なメソッドをクラスベースのミドルウェアに追加することができます:
\nprocess_view()Link to this heading#request は HttpRequest クラスのオブジェクトです。view_func は、直後に Django が使用する Python の関数です (関数の名前の文字列ではなく、実際の関数オブジェクトです)。view_args はビューに渡される位置引数のリスト、view_kwargs はビューに渡されるキーワード引数のディクショナリです。view_args も view_kwargs も、第一引数 (request) を含んでいません。
process_view() は、Django がビューを呼び出す直前に呼び出されます。
None もしくは HttpResponse オブジェクトを返す必要があります。None を返す場合、Django はこのリクエストの処理を続け、他のすべての process_view() ミドルウェアを実行し、さらに適切なビューを実行します。HttpResponse オブジェクトを返す場合、Django はわざわざ適切なビューを呼び出すことはしません; レスポンスミドルウェアを HttpResponse に適用し、結果を返します。
process_exception()Link to this heading#request は HttpRequest オブジェクトです。exception は、ビュー関数から投げられた Exception オブジェクトです。
Django calls process_exception() when a view raises an exception.\nprocess_exception() should return either None or an\nHttpResponse object. If it returns an\nHttpResponse object, the template response and response\nmiddleware will be applied and the resulting response returned to the\nbrowser. Otherwise, default exception handling kicks in.
Again, middleware are run in reverse order during the response phase, which\nincludes process_exception. If an exception middleware returns a response,\nthe process_exception methods of the middleware classes above that\nmiddleware won't be called at all.
process_template_response()Link to this heading#request は HttpRequest クラスのオブジェクトです。response は、Django のビューまたはミドルウェアから返される、TemplateResponse クラスのオブジェクト (あるいはそれと同等なもの) です。
process_template_response() は、レスポンスオブジェクトが r\nender() メソッドを持っている場合、つまり、TemplateResponse クラスのオブジェクト (あるいはそれと同等のもの) である場合に、ビューの実行の直後に呼ばれます。
このメソッドは、render メソッドを実装したレスポンスオブジェクトでなければなりません。このメソッド内では、与えられた response に対して response.template_name や response.context_data を修正したり、あるいは、新規に TemplateResponse クラスのオブジェクト (あるいはそれと同等なもの) を作成したりすることができます。
ただし、レスポンスを自分でレンダリング (render) する必要はありません。なぜなら、レスポンスオブジェクトは、すべてのテンプレートレスポンスミドルウェアが呼び出された後に、自動的にレンダリングされるからです。
\nレスポンスフェーズでは、ミドルウェアは逆順に呼び出されます。これには、process_template_response() も含まれます。
HttpResponse とは違い、StreamingHttpResponse は content 属性を持ちません。そのため、ミドルウェアはもはや、すべてのレスポンスが content 属性を持っていることを前提にすることができなくなります。したがって、content にアクセスする必要がある場合には、レスポンスオブジェクトがストリーミングレスポンスオブジェクトかどうかをチェックし、その結果によって処理を場合分けしなければなりません。
if response.streaming:\n response.streaming_content = wrap_streaming_content(response.streaming_content)\nelse:\n response.content = alter_content(response.content)\nDjango automatically converts exceptions raised by the view or by middleware\ninto an appropriate HTTP response with an error status code. Certain\nexceptions are converted to 4xx status codes, while an unknown\nexception is converted to a 500 status code.
\nThis conversion takes place before and after each middleware (you can think of\nit as the thin film in between each layer of the onion), so that every\nmiddleware can always rely on getting some kind of HTTP response back from\ncalling its get_response callable. Middleware don't need to worry about\nwrapping their call to get_response in a try/except and handling an\nexception that might have been raised by a later middleware or the view. Even\nif the very next middleware in the chain raises an\nHttp404 exception, for example, your middleware won't see\nthat exception; instead it will get an HttpResponse\nobject with a status_code of 404.
Middleware can support any combination of synchronous and asynchronous\nrequests. Django will adapt requests to fit the middleware's requirements if it\ncannot support both, but at a performance penalty.
\nBy default, Django assumes that your middleware is capable of handling only\nsynchronous requests. To change these assumptions, set the following attributes\non your middleware factory function or class:
\nsync_capable is a boolean indicating if the middleware can handle\nsynchronous requests. Defaults to True.
async_capable is a boolean indicating if the middleware can handle\nasynchronous requests. Defaults to False.
If your middleware has both sync_capable = True and\nasync_capable = True, then Django will pass it the request without\nconverting it. In this case, you can work out if your middleware will receive\nasync requests by checking if the get_response object you are passed is a\ncoroutine function, using asyncio.iscoroutinefunction().
The django.utils.decorators module contains\nsync_only_middleware(),\nasync_only_middleware(), and\nsync_and_async_middleware() decorators that\nallow you to apply these flags to middleware factory functions.
The returned callable must match the sync or async nature of the\nget_response method. If you have an asynchronous get_response, you must\nreturn a coroutine function (async def).
process_view, process_template_response and process_exception\nmethods, if they are provided, should also be adapted to match the sync/async\nmode. However, Django will individually adapt them as required if you do not,\nat an additional performance penalty.
Here's an example of how to create a middleware function that supports both:
\nimport asyncio\nfrom django.utils.decorators import sync_and_async_middleware\n\n@sync_and_async_middleware\ndef simple_middleware(get_response):\n # One-time configuration and initialization goes here.\n if asyncio.iscoroutinefunction(get_response):\n async def middleware(request):\n # Do something here!\n response = await get_response(request)\n return response\n\n else:\n def middleware(request):\n # Do something here!\n response = get_response(request)\n return response\n\n return middleware\nDjango provides django.utils.deprecation.MiddlewareMixin to ease creating\nmiddleware classes that are compatible with both MIDDLEWARE and the\nold MIDDLEWARE_CLASSES, and support synchronous and asynchronous requests.\nAll middleware classes included with Django are compatible with both settings.
The mixin provides an __init__() method that requires a get_response\nargument and stores it in self.get_response.
__call__() メソッド:
(定義されている場合) self.process_request(request) を呼び出します。
self.get_response(request) を呼び出し、後のミドルウェアとビューからレスポンスを得ます。
(定義されている場合) self.process_response(request, response) を呼び出します。
レスポンスを返します。
MIDDLEWARE_CLASSES で使われている場合は、__call__() メソッドは決して使われません; Django は process_request() と process_response() を直接呼び出します。
ほとんどの場合、この mixin を継承することで、旧式のミドルウェアと十分な下位互換性を持つ新しいシステムと互換性を持たせることができます。 新しい短絡セマンティクスは無害であり、既存のミドルウェアにとっても有益です。 いくつかのケースでは、ミドルウェアクラスは新しいセマンティクスに調整するためにいくつかの変更を必要とすることがあります。
\nMIDDLEWARE と MIDDLEWARE_CLASSES の動作には以下のような違いがあります。
Under MIDDLEWARE_CLASSES, every middleware will always have its\nprocess_response method called, even if an earlier middleware\nshort-circuited by returning a response from its process_request\nmethod. Under MIDDLEWARE, middleware behaves more like an onion:\nthe layers that a response goes through on the way out are the same layers\nthat saw the request on the way in. If a middleware short-circuits, only\nthat middleware and the ones before it in MIDDLEWARE will see the\nresponse.
Under MIDDLEWARE_CLASSES, process_exception is applied to\nexceptions raised from a middleware process_request method. Under\nMIDDLEWARE, process_exception applies only to exceptions\nraised from the view (or from the render method of a\nTemplateResponse). Exceptions raised from\na middleware are converted to the appropriate HTTP response and then passed\nto the next middleware.
Under MIDDLEWARE_CLASSES, if a process_response method raises\nan exception, the process_response methods of all earlier middleware are\nskipped and a 500 Internal Server Error HTTP response is always\nreturned (even if the exception raised was e.g. an\nHttp404). Under MIDDLEWARE, an exception\nraised from a middleware will immediately be converted to the appropriate\nHTTP response, and then the next middleware in line will see that\nresponse. Middleware are never skipped due to a middleware raising an\nexception.