Django4 中文入门教程 Django4.0 中间件-异步支持

2024-02-25 开发教程 Django4 中文入门教程匿名 6℃

中间件支持同步和异步请求的任意组合。如果Django不能同时支持它们，它会调整请求来适应中间件的需求，但会有性能损失。

默认情况下，Django假设你的中间件只能处理同步请求。如果要改变这种模式，需要在你的中间件工厂函数或类中添加入如下属性：

sync_capable 是一个布尔值，来表明中间件是否处理同步请求。默认为 True。
async_capable 是一个布尔值，来表明中间件是否处理异步请求。默认为 False。

如果中间件的sync_capable = True并且 async_capable = True，那么Django 会将请求传递给它而不进行转换。在这种情况下，你可以使用 asyncio.iscoroutinefunction() 来检查传递的 get_response 是否是一个协同函数，从而确定中间件是否接收到异步请求。
django.utils.decorators 模块包含 sync_only_middleware()，async_only_middleware() 和 sync_and_async_middleware() 装饰器，允许你将这些标志应用到中间件工厂函数中。
返回的可调用对象必须符合 get_response 方法的同步或异步性质。如果你有一个异步的 get_response，你必须返回一个协程函数（async def）。
process_view、process_template_response 和 process_exception 方法，如果有的话，也应该进行调整以匹配同步／异步模式。然而，如果你不这样做，Django 会根据需要单独调整它们，但会有额外的性能损失。
下面以一个例子来说明如何创建一个支持这两种功能的中间件函数：

import asyncio
from django.utils.decorators import sync_and_async_middleware
@sync_and_async_middleware
def simple_middleware(get_response):
    # One-time configuration and initialization goes here.
    if asyncio.iscoroutinefunction(get_response):
        async def middleware(request):
            # Do something here!
            response = await get_response(request)
            return response
    else:
        def middleware(request):
            # Do something here!
            response = get_response(request)
            return response
    return middleware

注解：如果你声明了一个同时支持同步和异步调用的混合中间件，你得到的调用种类可能与底层视图不匹配。Django 会优化中间件调用栈，使其尽可能少的同步／异步转换。

因此，即使你包装的是一个异步视图，如果在你和视图之间有其他的、同步的中间件，你也可能会在同步模式下被调用。

上一节： Django4.0 中间件-异常处理

下一节： Django4.0 中间件-升级Django1.10之前的中间件

"Django4 中文入门教程"的目录

Django4 中文入门教程 Django4.0 中间件-异步支持