37. Django 2.1.7 中间件

Posted 2021-04-10 海洋的渔夫

参考文献

• https://docs.djangoproject.com/zh-hans/2.1/topics/http/middleware/#middleware

• https://docs.djangoproject.com/zh-hans/2.1/topics/http/middleware/#writing-your-own-middleware

• https://www.liangzl.com/get-article-detail-27931.html

中间件

Django中的中间件是一个轻量级、底层的插件系统，可以介入Django的请求和响应处理过程，修改Django的输入或输出。中间件的设计为开发者提供了一种无侵入式的开发方式，增强了Django框架的健壮性，其它的MVC框架也有这个功能，名称为IoC。

Django在中间件中预置了五个方法，这五个方法的区别在于不同的阶段执行，对输入或输出进行干预，方法如下：1）初始化：无需任何参数，服务器响应第一个请求的时候调用一次，用于确定是否启用当前中间件。

def __init__(self):
    pass

2）处理请求前：在每个请求上，request对象产生之后，url匹配之前调用，返回None或HttpResponse对象。

def process_request(self, request):
    pass

3）处理视图前：在每个请求上，url匹配之后，视图函数调用之前调用，返回None或HttpResponse对象。

def process_view(self, request, view_func, *view_args, **view_kwargs):
    pass

4）处理响应后：视图函数调用之后，所有响应返回浏览器之前被调用，在每个请求上调用，返回HttpResponse对象。

def process_response(self, request, response):
    pass

5）异常处理：当视图抛出异常时调用，在每个请求上调用，返回一个HttpResponse对象。

def process_exception(self, request,exception):
    pass

激活中间件

若要激活中间件组件，请将其添加到 Django 设置中的 MIDDLEWARE 列表中。

在 MIDDLEWARE 中，每个中间件组件由字符串表示：指向中间件工厂的类或函数名的完整 Python 路径。

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',
]

Django 安装不需要任何中间件——如果您愿意的话，MIDDLEWARE 可以为空——但是强烈建议您至少使用 `CommonMiddleware`^[1]。

MIDDLEWARE 的顺序很重要，因为中间件会依赖其他中间件。例如：类 `AuthenticationMiddleware`^[2] 在会话中存储经过身份验证的用户；因此，它必须在 `SessionMiddleware`^[3] 后面运行 。中间件。Session中间件。请参阅 Middleware ordering ，用于一些关于 Django 中间件类排序的常见提示。

示例

中间件是一个独立的python类，，可以定义这五个方法中的一个或多个。

1）在assetinfo/目录下创建middleware.py文件，代码如下：

class my_mid:
    def __init__(self, get_response=None):
        self.get_response = get_response
        print('--------------init')

    def __call__(self, request):
        response = self.get_response(request)
        print('--------------call')
        return response

    def process_request(self,request):
        print('--------------request')

    def process_view(self,request, view_func, *view_args, **view_kwargs):
        print('--------------view')

    def process_response(self,request, response):
        print('--------------response')
        return response

2）在mysite/settings.py文件中，向MIDDLEWARE项中注册自定义中间件。

3）修改assetinfo/views.py中视图index。

def index(request):
    context = {
        'info': '资产管理',
        'list': ['测试服务器', 'redis服务器', 'memcached服务器', 'nginx服务器'],
    }
    print("=======index============")
    return render(request, 'assetinfo/index.html', context)

4）运行服务器，访问index，命令行中效果如下图：

5）刷新页面，命令行中效果如下图：

异常中间件

1）在assetinfo/middleware.py中定义两个异常类如下：

class exp1:
    def __init__(self, get_response=None):
        self.get_response = get_response
        print('--------------init exp1')

    def __call__(self, request):
        response = self.get_response(request)
        print('--------------call exp1')
        return response

    def process_exception(self,request,exception):
        print('--------------exp1')
        print(exception)

class exp2:
    def __init__(self, get_response=None):
        self.get_response = get_response
        print('--------------init exp2')

    def __call__(self, request):
        response = self.get_response(request)
        print('--------------call exp2')
        return response

    def process_exception(self,request,exception):
        print('--------------exp2')
        print(exception)

2）在mysite/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',
    'assetinfo.middleware.my_mid', # 注册中间件
    'assetinfo.middleware.exp1', # 注册异常中间件1
    'assetinfo.middleware.exp2', # 注册异常中间件2
)

3）修改booktest/views.py中视图index。

def index(request):
    context = {
        'info': '资产管理',
        'list': ['测试服务器', 'redis服务器', 'memcached服务器', 'nginx服务器'],
    }
    print("=======index============")
    raise Exception('自定义异常')
    return render(request, 'assetinfo/index.html', context)

4） 访问index视图，命令行打印如下：

总结：如果多个注册的中间件类中都有process_exception的方法，则先注册的后执行。

参考资料

[1]

django.middleware.common.CommonMiddleware: https://docs.djangoproject.com/zh-hans/2.1/ref/middleware/#django.middleware.common.CommonMiddleware

[2]

django.contrib.auth.middleware.AuthenticationMiddleware: https://docs.djangoproject.com/zh-hans/2.1/ref/middleware/#django.contrib.auth.middleware.AuthenticationMiddleware

[3]

django.contrib.sessions.middleware.SessionMiddleware: https://docs.djangoproject.com/zh-hans/2.1/ref/middleware/#django.contrib.sessions.middleware.SessionMiddleware