Django 之中间组件

day71 2018-06-26

 

1. 内容回顾

 

CBV:

class Index(views.View):

　　def get(self, request):

　　　　pass

 

 

FBV:

def index(request):        

　　if request.method == “POST":

　　　　pass

 

1. 分页

　　1. 自定义分页        --> 懂原理、会用

　　2. Django 内置的分页 --> 了解、会用        

2. Cookie

　　1. 下定义：

　　　　保存在浏览器端的键值对

　　2. 用处：

　　　　1. 登录

　　　　2. 记住密码/7天免登录

　　　　3. 用户浏览习惯（每页显示10条）

　　　　4. 简单的投票限制

　　3. Django操作Cookie

　　　　1. 设置Cookie

　　　　　　req = HttpResponse("OK")

　　　　　　req.set_cookie("key", "value")

　　　　　　# 设置加盐的cookie

　　　　　　req.set_signed_cookie("key", "value", salt="shanghais1hao", max_age=秒)

 

　　2. 获取Cookie

　　　　request.COOKIES    --> 大字典

 

　　　　request.COOKIES["key"]

　　　　request.COOKIES.get("key", "")

　　　　# 获取加盐的Cookie

　　　　request.get_signed_cookie("key", default="", salt="shanghais1hao")

 

　　3. 删除Coookie

　　　　req.delete_cookie("key")

4. Session

　　1. 下定义：

　　　　保存在服务端的键值对，依赖于Cookie

　　2. 用处：

　　　　1. 登录

　　　　2. 保存手机验证码/验证码

　　　　3. 保存购物车数据

...

　　3. Django操作Session

 

　　　　1. 设置Session

　　　　　　1. request.session["key"] = "value"

　　　　　　2. request.session.set_expiry(秒/日期对象/时间间隔对象/0/None)

　　　　　　3. request.session.setdefault("k1", "v1")

 

　　2. 获取Session数据

　　　　　　1. request.session.get("k1", "")

　　　　　　2. request.session["k1"]

 

　　　　　　3. request.session.keys()

　　　　　　4. request.session.values()

　　　　　　5. request.session.items()

　　　　　　6. request.session.iterkeys()

　　　　　　7. request.session.itervalues()

　　　　　　8. request.session.iteritems()

 

　　　3. 删除Session

　　　　1. request.session.flush()     --> 多用于注销

　　　　2. request.session.delete()

 

　　4. 手动清除早已经过期的session数据

　　　　　　request.session.clear_expired()

 

　　5. 相关配置项（写在settings.py中的）

　　　　　　1.每次请求都更新Session失效时间

　　　　　　SESSION_SAVE_EVERY_REQUEST = True

　　　　　　2. SESSION_COOKIE_AGE = 1209600      # 设置Cookie超时时间

 

　　　　　　3. SESSION_COOKIE_NAME = "sessionid" # Session的cookie保存在浏览器上时的key

　　　　　　4. 其他：

　　　　　　　　SESSION_COOKIE_PATH ＝ "/"       # Session的cookie保存的路径（默认）

　　　　　　　　SESSION_COOKIE_DOMAIN = None     # Session的cookie保存的域名（默认）

　　　　　　　　SESSION_COOKIE_SECURE = False    # 是否Https传输cookie（默认）

　　　　　　　　SESSION_COOKIE_HTTPONLY = True   # 是否Session的cookie只支持http传输（默认）

 

5. 装饰器工具

　　　　把函数装饰器 --> 方法装饰器

　　　　from django.utils.decorators import method_decorator

 

　　　　Class Index(views.View):

 

　　　　　　　　@method_decorator(你写的装饰器)

　　　　　　　　def get(self, request):

　　　　　　　　　　Pass

 

 

 

2. CSRF相关装饰器

　　from django.views.decorators.csrf import csrf_exempt, csrf_protect

 

2. 今日内容

中间件：https://www.cnblogs.com/liwenzhou/p/8761803.html

1. 中间件概念

 

我们在前面的课程中已经学会了给视图函数加装饰器来判断是用户是否登录，把没有登录的用户请求跳转到登录页面。我们通过给几个特定视图函数加装饰器实现了这个需求。但是以后添加的视图函数可能也需要加上装饰器，这样是不是稍微有点繁琐。

学完今天的内容之后呢，我们就可以用更适宜的方式来实现类似给所有请求都做相同操作的功能了

中间件

中间件介绍

什么是中间件？

官方的说法：中间件是一个用来处理Django的请求和响应的框架级别的钩子。它是一个轻量、低级别的插件系统，用于在全局范围内改变Django的输入和输出。每个中间件组件都负责做一些特定的功能。

但是由于其影响的是全局，所以需要谨慎使用，使用不当会影响性能。

我们一直都在使用中间件，只是没有注意到而已，打开Django项目的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',
]

MIDDLEWARE配置项是一个列表，列表中是一个个字符串，这些字符串其实是一个个类，也就是一个个中间件。

我们之前已经接触过一个csrf相关的中间件了？我们一开始让大家把他注释掉，再提交post请求的时候，就不会被forbidden了，后来学会使用csrf_token之后就不再注释这个中间件了。

 

 

 

2. 如何自定义中间件

1. 按照格式要求写一个类

2. 把我们写好的类在settings.py注册到MIDDLEWARE配置项的列表中

中间件可以定义五个方法，分别是：（主要的是process_request和process_response）

• process_request(self,request)
• process_view(self, request, view_func, view_args, view_kwargs)
• process_template_response(self,request,response)
• process_exception(self, request, exception)
• process_response(self, request, response)

以上方法的返回值可以是None或一个HttpResponse对象，如果是None，则继续按照django定义的规则向后继续执行，如果是HttpResponse对象，则直接将该对象返回给用户。

自定义一个中间件示例

from django.utils.deprecation import MiddlewareMixin

 

class MD1(MiddlewareMixin):

def process_request(self, request):
        print("MD1里面的 process_request")

def process_response(self, request, response):
        print("MD1里面的 process_response")
        return response

自定义怎么用

 

 

3. 每一个中间件中五个可以被重写的方法：

 中间件可以定义五个方法

1. process_request(self,request)

这个request和视图函数中的request是一样的。

 

　　1. 何时执行

　　　　在urls.py之前执行

　　2. 执行的顺序

　　　　按照在列表中注册的顺序依次执行

　　3. 返回值

　　　　1. 返回None, 不错任何处理直接进行下一步

　　　　2. 返回响应对象， 直接跳出（后续中间件的process_request、不执行urls.py和views.py）返回响应

　　实例：

from django.utils.deprecation import MiddlewareMixin

# from django.http import HttpResponse

from django.shortcuts import HttpResponse, redirect

 

class M1(MiddlewareMixin):

    """

    五个支持被重写的方法

    1. process_request(self,request)

    2. process_view(self, request, view_func, view_args, view_kwargs)

    3. process_template_response(self,request,response)

    4. process_exception(self, request, exception)

    5. process_response(self, request, response)

    """

    def process_request(self,request):

        print("哈哈哈，我是自定义中间件M1中的一个卖报的小行家！")

        # 排除login页面

        # request.path_info

        # request.get_full_path()

        next_url = request.path_info

        if not request.path_info.startswith("/login/"):

            # 做登录验证

            login_flag = request.session.get("login", "")

            if not login_flag:

                rep = redirect("/login/?next={}".format(next_url))

                return rep

 

        # return HttpResponse("OK")

　　4，在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',
    'middlewares.MD1',  # 自定义中间件MD1
    'middlewares.MD2'  # 自定义中间件MD2

多个中间件中的process_response方法是按照MIDDLEWARE中的注册顺序倒序执行的，也就是说第一个中间件的process_request方法首先执行，而它的process_response方法最后执行，最后一个中间件的process_request方法最后一个执行，它的process_response方法是最先执行。

 

2. process_view(self, request, view_func, view_args, view_kwargs)

 

　　1. 执行时间：

　　　　在urls.py之后在执行真正的视图函数之前

　　2. 执行顺序

　　　　1. 按照在列表中注册的顺序依次执行

 

　　3. 返回值

　　　　　1. 返回None， 放行

　　　　　2. 返回响应对象，就直接跳出，倒序依次执行所有中间件的process_response方法

 

　　　　defprocess_view(self,request,view_func,view_args,view_kwargs):

　　　　　　print("这是m1中的process_view方法")

　　　　　　print(view_func.__name__)

 

　　　defprocess_view(self,request,view_func,view_args,view_kwargs):

　　　　　　print("这是m2中的process_view方法")

　　　　　　print(view_func.__name__)

　　　　　　#returnHttpResponse("O98K")

 

　　该方法有四个参数

request是HttpRequest对象。

view_func是Django即将使用的视图函数。 （它是实际的函数对象，而不是函数的名称作为字符串。）

view_args是将传递给视图的位置参数的列表.

view_kwargs是将传递给视图的关键字参数的字典。 view_args和view_kwargs都不包含第一个视图参数（request）。

Django会在调用视图函数之前调用process_view方法。

它应该返回None或一个HttpResponse对象。 如果返回None，Django将继续处理这个请求，执行任何其他中间件的process_view方法，然后在执行相应的视图。 如果它返回一个HttpResponse对象，Django不会调用适当的视图函数。 它将执行中间件的process_response方法并将应用到该HttpResponse并返回结果。

3. process_template_response(self,request,response)（用的少）

　　它的参数，一个HttpRequest对象，response是TemplateResponse对象（由视图函数或者中间件产生）。

process_template_response是在视图函数执行完成后立即执行，但是它有一个前提条件，那就是视图函数返回的对象有一个render()方法（或者表明该对象是一个TemplateResponse对象或等价方法）。

class MD1(MiddlewareMixin):

def process_request(self, request):
        print("MD1里面的 process_request")

def process_response(self, request, response):
        print("MD1里面的 process_response")
        return response

def process_view(self, request, view_func, view_args, view_kwargs):
        print("-" * 80)
        print("MD1 中的process_view")
        print(view_func, view_func.__name__)

def process_exception(self, request, exception):
        print(exception)
        print("MD1 中的process_exception")
        return HttpResponse(str(exception))

def process_template_response(self, request, response):
        print("MD1 中的process_template_response")
        return response

class MD2(MiddlewareMixin):
    def process_request(self, request):
        print("MD2里面的 process_request")
        pass

def process_response(self, request, response):
        print("MD2里面的 process_response")
        return response

def process_view(self, request, view_func, view_args, view_kwargs):
        print("-" * 80)
        print("MD2 中的process_view")
        print(view_func, view_func.__name__)

def process_exception(self, request, exception):
        print(exception)
        print("MD2 中的process_exception")

def process_template_response(self, request, response):
        print("MD2 中的process_template_response")
        return response

 

views.py中：

 

def index(request):
    print("app01 中的 index视图")

def render():
        print("in index/render")
        return HttpResponse("O98K")
    rep = HttpResponse("OK")
    rep.render = render
    return rep

 

访问index视图，终端输出的结果：

 

MD2里面的 process_request
MD1里面的 process_request
--------------------------------------------------------------------------------
MD2 中的process_view
<function index at 0x000001C111B97488> index
--------------------------------------------------------------------------------
MD1 中的process_view
<function index at 0x000001C111B97488> index
app01 中的 index视图
MD1 中的process_template_response
MD2 中的process_template_response
in index/render
MD1里面的 process_response
MD2里面的 process_response

 

　　从结果看出：

　　　　视图函数执行完之后，立即执行了中间件的process_template_response方法，顺序是倒序，先执行MD1的，在执行MD2的，接着执行了视图函数返回的HttpResponse对象的render方法，返回了一个新的HttpResponse对象，接着执行中间件的process_response方法。

 

4. process_exception(self, request, exception)

　　该方法两个参数:

一个HttpRequest对象

一个exception是视图函数异常产生的Exception对象。

这个方法只有在视图函数中出现异常了才执行，它返回的值可以是一个None也可以是一个HttpResponse对象。如果是HttpResponse对象，Django将调用模板和中间件中的process_response方法，并返回给浏览器，否则将默认处理异常。如果返回一个None，则交给下一个中间件的process_exception方法来处理异常。它的执行顺序也是按照中间件注册顺序的倒序执行。

　　如果视图函数中无异常，process_exception方法不执行。

想办法，在视图函数中抛出一个异常：

def index(request):
    print("app01 中的 index视图")
    raise ValueError("呵呵")
    return HttpResponse("O98K")

在MD1的process_exception中返回一个响应对象：

 

class MD1(MiddlewareMixin):

def process_request(self, request):
        print("MD1里面的 process_request")

def process_response(self, request, response):
        print("MD1里面的 process_response")
        return response

def process_view(self, request, view_func, view_args, view_kwargs):
        print("-" * 80)
        print("MD1 中的process_view")
        print(view_func, view_func.__name__)

def process_exception(self, request, exception):
        print(exception)
        print("MD1 中的process_exception")
        return HttpResponse(str(exception))  # 返回一个响应对象

 

看输出结果：

 

MD2里面的 process_request
MD1里面的 process_request
--------------------------------------------------------------------------------
MD2 中的process_view
<function index at 0x0000022C09727488> index
--------------------------------------------------------------------------------
MD1 中的process_view
<function index at 0x0000022C09727488> index
app01 中的 index视图
呵呵
MD1 中的process_exception
MD1里面的 process_response
MD2里面的 process_response

 

注意，这里并没有执行MD2的process_exception方法，因为MD1中的process_exception方法直接返回了一个响应对象。

 

5. process_response(self, request, response)

　　1. 何时执行

　　　　在views.py返回响应对象之后执行

 

　　2. 执行的顺序

　　　　按照在列表中注册的倒序依次执行

 

　　3. 返回值

　　　　必须要有返回值，返回要是 响应对象

 

多个中间件中的process_response方法是按照MIDDLEWARE中的注册顺序倒序执行的，也就是说第一个中间件的process_request方法首先执行，而它的process_response方法最后执行，最后一个中间件的process_request方法最后一个执行，它的process_response方法是最先执行。

            defprocess_response(self,request,response):
            """
                :paramrequest:本次请求
                :paramresponse:响应
                :return:
                """
                print("m1中的process_response方法")
                returnresponse
                #rep=HttpResponse("O98K")
                #returnrep
            
            defprocess_response(self,request,response):
                print("m2中的process_response方法")
returnresponse

 

4，中间件的执行流程

 

请求到达中间件之后，先按照正序执行每个注册中间件的process_reques方法，process_request方法返回的值是None，就依次执行，如果返回的值是HttpResponse对象，不再执行后面的process_request方法，而是执行当前对应中间件的process_response方法，将HttpResponse对象返回给浏览器。也就是说：如果MIDDLEWARE中注册了6个中间件，执行过程中，第3个中间件返回了一个HttpResponse对象，那么第4,5,6中间件的process_request和process_response方法都不执行，顺序执行3,2,1中间件的process_response方法。

 

 

process_request方法都执行完后，匹配路由，找到要执行的视图函数，先不执行视图函数，先执行中间件中的process_view方法，process_view方法返回None，继续按顺序执行，所有process_view方法执行完后执行视图函数。加入中间件3 的process_view方法返回了HttpResponse对象，则4,5,6的process_view以及视图函数都不执行，直接从最后一个中间件，也就是中间件6的process_response方法开始倒序执行。

 

process_template_response和process_exception两个方法的触发是有条件的，执行顺序也是倒序。总结所有的执行流程如下：

 

 

中间件版登录验证

中间件版的登录验证需要依靠session，所以数据库中要有django_session表。

urls.py

from django.conf.urls import url
from app01 import views

urlpatterns = [
    url(r'^index/$', views.index),
    url(r'^login/$', views.login, name='login'),
]

 

views.py

from django.shortcuts import render, HttpResponse, redirect

def index(request):
    return HttpResponse('this is index')

def home(request):
    return HttpResponse('this is home')

def login(request):
    if request.method == "POST":
        user = request.POST.get("user")
        pwd = request.POST.get("pwd")

if user == "Q1mi" and pwd == "123456":
            # 设置session
            request.session["user"] = user
            # 获取跳到登陆页面之前的URL
            next_url = request.GET.get("next")
            # 如果有，就跳转回登陆之前的URL
            if next_url:
                return redirect(next_url)
            # 否则默认跳转到index页面
            else:
                return redirect("/index/")
    return render(request, "login.html")

 

login.html

 

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="x-ua-compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>登录页面</title>
</head>
<body>
<form action="{% url 'login' %}">
    <p>
        <label for="user">用户名：</label>
        <input type="text" name="user" id="user">
    </p>
    <p>
        <label for="pwd">密 码：</label>
        <input type="text" name="pwd" id="pwd">
    </p>
    <input type="submit" value="登录">
</form>
</body>
</html>

 

middlewares.py

 

class AuthMD(MiddlewareMixin):
    white_list = ['/login/', ]  # 白名单
    balck_list = ['/black/', ]  # 黑名单

def process_request(self, request):
        from django.shortcuts import redirect, HttpResponse

next_url = request.path_info
        print(request.path_info, request.get_full_path())

if next_url in self.white_list or request.session.get("user"):
            return
        elif next_url in self.balck_list:
            return HttpResponse('This is an illegal URL')
        else:
            return redirect("/login/?next={}".format(next_url))

 

在settings.py中注册

 

 

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',
    'middlewares.AuthMD',
]

 

AuthMD中间件注册后，所有的请求都要走AuthMD的process_request方法。

访问的URL在白名单内或者session中有user用户名，则不做阻拦走正常流程；

如果URL在黑名单中，则返回This is an illegal URL的字符串；

正常的URL但是需要登录后访问，让浏览器跳转到登录页面。

 

来自 <https://www.cnblogs.com/liwenzhou/p/8761803.html>

 

补充：

importlib

 Django的请求流程图