django框架(八)——中间件和上下文处理器

一、中间件的引入

二、django中的中间件

在django中，中间件其实就是一个类，在请求到来和结束后，django会根据自己的规则在合适的时机执行中间件中相应的方法，在django项目的settings.py中，有一个MIDDLEWARE_CLASSES变量，其中每一个元素就是一个中间件，如下图所示：

三、中间件中的五个方法

• Request预处理函数: process_request(self, request)

① 这个方法的调用时机在Django接收到request之后，但仍未解析URL以确定应当运行的视图函数。Django向它传入相应的Request对象，以便在方法中修改。

② 如果返回None，Django将继续处理这个request，执行后续的中间件， 然后调用相应的 view。

③ 如果返回HttpResponse对象，Django将不再执行任何除了process_response以外其它的中间件以及相应的view，Django将立即返回该HttpResponse。

• View预处理函数process_view(self,request,callback,callback_args,callback_kwargs)
  这个方法的调用时机在 Django 执行完 request 预处理函数并确定待执行的 view （即callback参数）之后，但在 view 函数实际执行之前。

request：HttpRequest 对象。

callback：Django将调用的处理request的python函数. 这是实际的函数对象本身, 而不是字符串表述的函数名。

args：将传入view的位置参数列表，但不包括request参数(它通常是传入view的第一个参数)。

kwargs：将传入view的关键字参数字典。

process_view() 应当返回None或 HttpResponse 对象。如果返回 None， Django将继续处理这个request ，执行后续的中间件， 然后调用相应的view。

如果返回 HttpResponse 对象，Django 将不再执行任何其它的中间件(不论种类)以及相应的view，Django将立即返回。

• Template模版渲染函数：process_template_response()

默认不执行，只有在视图函数的返回结果对象中有render方法才会执行，并把对象的render方法的返回值返回给用户（注意不返回视图函数的return的结果了，而是返回视图函数 return值（对象）中rende方法的结果）

• Exception后处理函数:process_exception(self, request, exception)

这个方法只有在 request 处理过程中出了问题并且view 函数抛出了一个未捕获的异常时才会被调用。这个钩子可以用来发送错误通知，将现场相关信息输出到日志文件，或者甚至尝试从错误中自动恢复。

这个函数的参数除了一贯的request对象之外，还包括view函数抛出的实际的异常对象exception 。

process_exception() 应当返回None或HttpResponse对象。

如果返回None，Django将用框架内置的异常处理机制继续处理相应request。

如果返回HttpResponse对象，Django将使用该response对象，而短路框架内置的异常处理机制。

• Response后处理函数:process_response(self, request, response)
  这个方法的调用时机在 Django 执行 view 函数并生成 response 之后。

该处理器能修改response 的内容；一个常见的用途是内容压缩，如gzip所请求的HTML页面。

这个方法的参数相当直观：request是request对象，而response则是从view中返回的response对象。

process_response() 必须返回 HttpResponse 对象. 这个 response 对象可以是传入函数的那一个原始对象（通常已被修改），也可以是全新生成的。

三、自定义中间件

在student app 下创建selfmiddleware.py文件，在其中添加如下代码

from django.utils.deprecation import MiddlewareMixin


class MiddlewareTest1(MiddlewareMixin):
    def process_request(self, request):
        print('0000')
        return None

    def process_view(self, request, callback, callback_args, callback_kwargs):
        print('1111')
        return None

    def process_template_response(self, request, response):
        print('2222')
        return response

    def process_exception(self, request, exception):
        print('3333')
        return HttpResponse(exception)

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

class MiddlewareTest2(MiddlewareMixin):
    def process_request(self, request):
        print('5555')
        return None

    def process_view(self, request, callback, callback_args, callback_kwargs):
        print('6666')
        return None

    def process_template_response(self, request, response):
        print('7777')
        return response

    def process_exception(self, request, exception):
        print('8888')
        return HttpResponse(exception)

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

注册中间件，在settings.py中

MIDDLEWARE = [
    'student.selfmiddleware.MiddlewareTest1',
    'student.selfmiddleware.MiddlewareTest2',
]

在视图函数中(这里的代码是为了方便执行process_template_response方法)：

class Test:
    def __init__(self, req):
        self.req = req

    def render(self):
        return HttpResponse('Render_OK')


def test(request):
    print('执行视图函数')
    res = Test(request)
    return res

访问该视图后，执行结果如下图所示

如上图，分析源码得知前二个方法是从前往后执行的，后三个方法是从后往前执行的 。所以前两个方法是请求进来时要穿越的，而后三个方法是请求出去时要穿越的，具体流程如下：

注册中间件时是有先后顺序的，请求从前往后，响应从后往前

自定义中间件要注意以下事项：
1、process_response一定要有reurn否则会报错，自定义的中间件response方法没有return，会交给下一个中间件，导致http请求中断了。

2.1、process_view（self, request, callback,callback_args, callback_kwargs）方法介绍：

(1)执行完所有中间件的request方法‘

(2)url匹配成功

(3)拿到视图函数的名称、参数，（注意不执行）再执行process_view()方法

(4)最后去执行视图函数

2.2、既然process_view 拿到视图函数的名称、参数，（不执行） 再执行process_view()方法，最后才去执行视图函数，所以可以在执行process_view环节时直接把函数执行进行return返回。注意：此时的process_view2将不再被调用执行，而是直接跳转到最后一个中间件， 执行最后一个中间件的response方法，逐步返回。

3、process_template_response方法默认也不会执行，只有在视图函数的返回对象中有render方法才会执行.并把对象的render方法的返回值返回给用户（注意不返回视图函数的return的结果了，而是返这个结果对象里render方法的返回值，并且process_template_response方法也要返回response不然会报错。

4、添加process_exception方法后发现在函数正常执行情况下该方法不会被调用

（1）执行完所有 request 方法；

（2）执行所有 process_view方法；

（3）如果视图函数出错，执行process_exception方法，如果第一个中间件的process_exception方法有了返回值就不再执行其他中间件process_exception，直接执行response方法；

（4）执行所有response方法；最后返回process_exception的返回值

四、上下文处理器

• 作用：在模板中想要使用的变量是从视图函数中的context这个上下文的参数传递进来的，每个视图函数需要什么参数就传什么参数，上下文处理器就是创建模板变量
• 自定义上下文处理器

① 在teacher app目录下创建一个context_processor.py的中件，在其中添加如下代码

# 此函数中必须传入request这个参数
def slogan(request):
	return {'slogan': '我们是最棒的'}

② 注册上下文处理器，在settings.py中

TEMPLATES = [
        'OPTIONS': {
            'context_processors': [
                'teacher.context_processor.slogan'
            ],
        },

③ 在视图函数中

def test(request):
    return render(request, 'teacher/test.html')

④ 在test.html中，直接引用即可

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>test</title>
</head>
<body>
    <h1>{{ slogan }}</h1>
</body>
</html>

⑤ 在浏览器中访问，如下图所示，在项目的其他模板中均可使用

五、小结

• 中间件是在用户请求到响应的过程中去加入一些额外的逻辑功能
• 上下文处理器是给所有的模板增加模板变量