Django中间件简介

2024年1月4日 158次阅读

中间件是Django处理请求和响应处理过程中的一个钩子，它比较轻量级，但是可以用来改变Django全局的的输入和输出。

每一个中间件一般都用来做一些特殊的功能，可以添加多个中间件来实现更多的功能。

今天一起看一下Django的中间件是如何工作的，如何激活，并且自己写一个中间件。Django还内置了一些中间件，可以拿来即用。参考内置中间件

中间件写法参考

中间件可以以函数的形式来写，如下：

def simple_middleware(get_response):
    # One-time configuration and initialization.
    # 配置和初始化的工作，只执行一次

    def middleware(request):
        # Code to be executed for each request before
        # the view (and later middleware) are called.

        # 在view被调用之前，请求还未加工时执行
        response = get_response(request)

        # Code to be executed for each request/response after
        # the view is called.
        # 在请求/响应处理完毕后调用的代码
        return response

    return middleware
  • 函数必须传递的参数为get_response
  • 返回值必须为middleware

除了函数形式为，更多的写法一般是写成类的形式。

class SimpleMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response
        # One-time configuration and initialization.
        # 代码初始化时候执行，可以做一次性的配置

    def __call__(self, request):
        # Code to be executed for each request before
        # the view (and later middleware) are called.
        # 在view被调用之前，请求还未加工时执行

        response = self.get_response(request)

        # Code to be executed for each request/response after
        # the view is called.
        # 请求/响应被处理之后执行
        return response
  • __init__方法只执行一次
  • __call__方法可以执行多次

标记中间件为不可用状态

有时候，你想在项目启动时判断是否要用这个中间件，这种情况下，在你的__init__方法中，抛出MiddlewareNotUsed异常。Django就会移除这个中间件，如果有日志开启的话，DEBUG=True, 你也可以看到日志输出的信息。

激活中间件

如果要激活一个中间件，把它添加到项目settings.py中的MIDDLEWARE部分。

里面的配置，每一个中间件都是以字符串形式来表示，并且要提供完整的路径。如下：

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'libs.middleware.HandleExceptionMiddleware',  # 处理视图函数异常
]

建议至少使用一个中间件，django.middleware.common.CommonMiddleware

中间件的顺序也很重要，有时候某个中间件需要依赖另外一个中间件的执行结果才可以生效。例如：
AuthenticationMiddleware存储用户的认证信息在Session中，因此它必须在SessionMiddleware.中间件之后。

中间件的执行顺序是从数组的，从上往下执行。但是对于响应则是从下往上执行。

中间件的其它钩子

除了基本的请求/响应处理的那个中间件，你还可以添加另外三个特殊的方法。

  • process_view(request, view_func, view_args, view_kwargs) 在Django调用view之前执行，可以返回None或者HttpResponse对象。如果返回的是None，Django会继续执行直到找到合适的视图为止，如果返回的是HttpResponse对象，Django就停止执行，然后返回HttpResponse结果。

  • process_exception(request, exception) 当view抛出异常的时候，会触发Django调用这个函数。可以返回None或者HttpResponse对象。同上面

  • process_template_response(request, response) 当view结束执行的时候调用，如果响应有render()方法，代表它是个 TemplateResponse。这个函数必须要返回一个响应对象有render()方法。

最后

中间件还有很多功能，等待大家一起去发掘。

参考

点赞