Django中间件工作流程及写法实例代码


Posted in Python onFebruary 06, 2018

熟悉web开发的同学对hook钩子肯定不陌生,通过钩子可以方便的实现一些触发和回调,并且做一些过滤和拦截。

django中的中间件(middleware)就是类似钩子的一种存在。下面我们来介绍一下,并且给出一些实例。

1、Middleware的工作流程

Django中间件工作流程及写法实例代码

我盗了一个图,看网上很多人用这个图,来源已经追不明白了。简单声明一下,这个图不是我的。看着图我们分析一下:

1)django的请求相应流程:HttpRequest -> RequestMiddleware -> view function -> ResponseMiddleware -> HttpResponse

可以看到一个请求到响应的过程,中间夹着两个middleware流程,请求中间件和响应中间件。

也就是说,django提供了一种机制,在:

  1. 请求到达视图函数中间
  2. 视图函数到响应之间

支持嵌入钩子。

这种钩子的特点:

  1. 全局,一旦你使用了中间件,并且发布生效的话,所有的请求都会经过你嵌入的中间件。
  2. 性能敏感,如果你的中间件性能差的话,那么会影响服务的整体性能。

2) django的middleware包含四个钩子函数:process_request/process_view/process_response/process_exception

process_request:接受request之后确定所执行的view之前

process_view:确定了所要执行的view之后,view真正执行之前

process_response:view执行之后

process_exceptionview:view执行抛出异常

而插入middleware的过程是在settings.py中配置,如下默认配置,我只截取了两个中间件:SessionMiddleware和CommonMiddleware。

MIDDLEWARE_CLASSES = (
  'django.contrib.sessions.middleware.SessionMiddleware',
  'django.middleware.common.CommonMiddleware',
  
  ...    
)

我们简单看一下SessionMiddleware的实现

import time
from importlib import import_module

from django.conf import settings
from django.utils.cache import patch_vary_headers
from django.utils.http import cookie_date


class SessionMiddleware(object):
  def __init__(self):
    engine = import_module(settings.SESSION_ENGINE)
    self.SessionStore = engine.SessionStore

  def process_request(self, request):
    session_key = request.COOKIES.get(settings.SESSION_COOKIE_NAME, None)
    request.session = self.SessionStore(session_key)

  def process_response(self, request, response):
    """
    If request.session was modified, or if the configuration is to save the
    session every time, save the changes and set a session cookie or delete
    the session cookie if the session has been emptied.
    """
    try:
      accessed = request.session.accessed
      modified = request.session.modified
      empty = request.session.is_empty()
    except AttributeError:
      pass
    else:
      # First check if we need to delete this cookie.
      # The session should be deleted only if the session is entirely empty
      if settings.SESSION_COOKIE_NAME in request.COOKIES and empty:
        response.delete_cookie(settings.SESSION_COOKIE_NAME)
      else:
        if accessed:
          patch_vary_headers(response, ('Cookie',))
        if modified or settings.SESSION_SAVE_EVERY_REQUEST:
          if request.session.get_expire_at_browser_close():
            max_age = None
            expires = None
          else:
            max_age = request.session.get_expiry_age()
            expires_time = time.time() + max_age
            expires = cookie_date(expires_time)
          # Save the session data and refresh the client cookie.
          # Skip session save for 500 responses, refs #3881.
          if response.status_code != 500:
            request.session.save()
            response.set_cookie(settings.SESSION_COOKIE_NAME,
                request.session.session_key, max_age=max_age,
                expires=expires, domain=settings.SESSION_COOKIE_DOMAIN,
                path=settings.SESSION_COOKIE_PATH,
                secure=settings.SESSION_COOKIE_SECURE or None,
                httponly=settings.SESSION_COOKIE_HTTPONLY or None)
    return response

可以看到在SessionMiddleware中默认只实现了process_requestprocess_response两个hook函数。

我们就以这个例子说明一下一个请求的执行过程。我们假设场景是这样的:

1)从上而下配置了两个Middleware(注意顺序):SessionMiddleware和CommonMiddleware

2)每个Middleware中的四个钩子函数齐全process_request/process_view/process_response/process_exception

执行顺序应该是这样的:

1、HttpRequest

2、SessionMiddleware process_request

3、SessionMiddleware process_view

4、CommonMiddleware process_request

5、CommonMiddleware process_view

6、view

7、CommonMiddleware process_response

8、CommonMiddleware process_exception(如有必要)

9、SessionMiddleware process_response

10、SessionMiddleware process_exception(如有必要)

11、HttpResponse

2、Middleware的写法

Middleware的写法很简单:

1)实现一个类,继承object就行;

2)重写其中的四个钩子函数就可以了。

这里要着重说一个常用的功能。

拦截器/过滤器(filter)

一般来说,每一个请求都要经过process_request这个钩子函数。你的实现中,函数的执行结果必然有两种(你要自己做异常处理):

1)None

2)HttpResponse 对象

如果返回None,请求流程继续执行,也就是继续进入其他的Middleware或者钩子函数。

如果返回HttpResponse对象,那么就直接返回到页面。通过这个功能我们可以做黑名单。

给一个例子:

就是统计pv

# -*- coding:utf-8 -*-
from datetime import datetime
from data_monitor.utils.dbmanager import MysqlManager
from data_monitor.common.constant import MYSQL_JOBS as mysql_config

class RequestHookMiddleware(object):

  def process_request(self, request):
    try:
      username = request.COOKIES.get('username')
      uri = request.path
      timestamp = str(datetime.now())
      db_obj = MysqlManager(
        mysql_config.get('host'),
        mysql_config.get('port'),
        mysql_config.get('db'),
        mysql_config.get('user'),
        mysql_config.get('password'),
        format=True,
      )
      field_str = 'username, uri, timestamp'
      value_str = '"%s","%s","%s"' % (username, uri, timestamp)
      db_obj.insert('pv', field_str, value_str)
      db_obj.close()
      return
    except Exception, ex:
      return

总结

以上就是本文关于Django中间件工作流程及写法实例代码的全部内容,希望对大家有所帮助。感兴趣的朋友可以继续参阅本站其他相关专题,如有不足之处,欢迎留言指出。感谢朋友们对本站的支持!

Python 相关文章推荐
python基础教程之实现石头剪刀布游戏示例
Feb 11 Python
如何搜索查找并解决Django相关的问题
Jun 30 Python
python创建进程fork用法
Jun 04 Python
python爬虫实战之最简单的网页爬虫教程
Aug 13 Python
Python 关于反射和类的特殊成员方法
Sep 14 Python
python对list中的每个元素进行某种操作的方法
Jun 29 Python
python利用requests库进行接口测试的方法详解
Jul 06 Python
python全栈知识点总结
Jul 01 Python
Python完全识别验证码自动登录实例详解
Nov 24 Python
浅谈python中频繁的print到底能浪费多长时间
Feb 21 Python
Java Unsafe类实现原理及测试代码
Sep 15 Python
python cv2图像质量压缩的算法示例
Jun 04 Python
Django数据库表反向生成实例解析
Feb 06 #Python
Python使用functools实现注解同步方法
Feb 06 #Python
django中send_mail功能实现详解
Feb 06 #Python
Python打印“菱形”星号代码方法
Feb 05 #Python
Django权限机制实现代码详解
Feb 05 #Python
Django中的Signal代码详解
Feb 05 #Python
Python实现XML文件解析的示例代码
Feb 05 #Python
You might like
《OVERLORD》手游英文版即将上线 手机上也能扮演骨王
2020/04/09 日漫
点评山进PR-D3L三波段收音机
2021/03/02 无线电
中东人咖啡哲学
2021/03/03 咖啡文化
smarty静态实验表明,网络上是错的~呵呵
2006/11/25 PHP
PHP依赖倒置(Dependency Injection)代码实例
2014/10/11 PHP
php打印一个边长为N的实心和空心菱型的方法
2015/03/02 PHP
css把超出的部分显示为省略号的方法兼容火狐
2008/07/23 Javascript
关于URL中的特殊符号使用介绍
2011/11/03 Javascript
妙用Jquery的val()方法
2012/06/27 Javascript
jquery 如何动态添加、删除class样式方法介绍
2012/11/07 Javascript
IE中图片的onload事件无效问题和解决方法
2014/06/06 Javascript
jquery中的常用事件bind、hover、toggle等示例介绍
2014/07/21 Javascript
JavaScript中的Repaint和Reflow用法详解
2015/07/27 Javascript
js显示当前日期时间和星期几
2015/10/22 Javascript
分享一些常用的jQuery动画事件和动画函数
2015/11/27 Javascript
JavaScript数组去重的几种方法效率测试
2016/10/23 Javascript
浅谈jquery拼接字符串效率比较高的方法
2017/02/22 Javascript
js封装成插件的步骤方法
2017/09/11 Javascript
js中null与空字符串""的区别讲解
2019/01/17 Javascript
python使用PIL模块实现给图片打水印的方法
2015/05/22 Python
python利用正则表达式提取字符串
2016/12/08 Python
Python 删除整个文本中的空格,并实现按行显示
2018/07/24 Python
pyspark.sql.DataFrame与pandas.DataFrame之间的相互转换实例
2018/08/02 Python
python实现DEM数据的阴影生成的方法
2019/07/23 Python
Python拆分大型CSV文件代码实例
2019/10/07 Python
K最近邻算法(KNN)---sklearn+python实现方式
2020/02/24 Python
解决django中form表单设置action后无法回到原页面的问题
2020/03/13 Python
Jupyter notebook命令和编辑模式常用快捷键汇总
2020/11/17 Python
call在Python中改进数列的实例讲解
2020/12/09 Python
HTML5 FileReader对象的具体使用方法
2020/05/22 HTML / CSS
大学生期末自我鉴定
2014/02/01 职场文书
幼儿园工作总结2015
2015/04/01 职场文书
唱歌比赛拉拉队口号
2015/12/25 职场文书
护理专业毕业自我鉴定
2019/08/12 职场文书
2019最新版劳务派遣管理制度
2019/08/16 职场文书
死磕 java同步系列之synchronized解析
2021/06/28 Java/Android