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实现栈的方法
May 26 Python
Python编程入门之Hello World的三种实现方式
Nov 13 Python
详解Python进程间通信之命名管道
Aug 28 Python
python用BeautifulSoup库简单爬虫实例分析
Jul 30 Python
Python反射和内置方法重写操作详解
Aug 27 Python
Django之Mode的外键自关联和引用未定义的Model方法
Dec 15 Python
python 利用pandas将arff文件转csv文件的方法
Feb 12 Python
Python如何通过Flask-Mail发送电子邮件
Jan 29 Python
python3 正则表达式基础廖雪峰
Mar 25 Python
Django实现celery定时任务过程解析
Apr 21 Python
Jupyter Notebook的连接密码 token查询方式
Apr 21 Python
使用Python开发贪吃蛇游戏 SnakeGame
Apr 30 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
PHP HTML代码串 截取实现代码
2009/06/29 PHP
使用php测试硬盘写入速度示例
2014/01/27 PHP
php中目录操作opendir()、readdir()及scandir()用法示例
2019/06/08 PHP
实现点击列表弹出列表索引的两种方式
2013/03/08 Javascript
js动态设置div的值下例子
2013/10/29 Javascript
JS获取随机数函数可自定义最小值最大值
2014/05/08 Javascript
javascript将浮点数转换成整数的三个方法
2014/06/23 Javascript
JavaScript学习总结之JS、AJAX应用
2016/01/29 Javascript
第一次接触JS require.js模块化工具
2016/04/17 Javascript
JS生成某个范围的随机数【四种情况详解】
2016/04/20 Javascript
BootStrap 智能表单实战系列(五) 表单依赖插件处理
2016/06/13 Javascript
js简单实现调整网页字体大小的方法
2016/07/23 Javascript
浅谈Javascript数据属性与访问器属性
2016/07/26 Javascript
详解如何在Vue2中实现组件props双向绑定
2017/03/29 Javascript
JSON在Javascript中的使用(eval和JSON.parse的区别)详细解析
2017/09/05 Javascript
koa socket即时通讯的示例代码
2018/09/07 Javascript
详解如何理解vue的key属性
2019/04/14 Javascript
详解webpack打包vue项目之后生成的dist文件该怎么启动运行
2019/09/06 Javascript
Vue中key的作用示例代码详解
2020/06/10 Javascript
Vue 根据条件判断van-tab的显示方式
2020/08/03 Javascript
[03:37]2015国际邀请赛第四日现场精彩集锦
2015/08/08 DOTA
python K近邻算法的kd树实现
2018/09/06 Python
python3中类的继承以及self和super的区别详解
2019/06/26 Python
python opencv minAreaRect 生成最小外接矩形的方法
2019/07/01 Python
500行python代码实现飞机大战
2020/04/24 Python
Python实现常见的几种加密算法(MD5,SHA-1,HMAC,DES/AES,RSA和ECC)
2020/05/09 Python
Python Socket TCP双端聊天功能实现过程详解
2020/06/15 Python
如何用tempfile库创建python进程中的临时文件
2021/01/28 Python
中国最大的名表商城:万表网
2016/08/29 全球购物
小学英语教学反思
2014/01/30 职场文书
幼儿园元旦亲子活动方案
2014/02/17 职场文书
年度考核自我鉴定
2014/03/19 职场文书
《悯农》教学反思
2014/04/28 职场文书
2016猴年春节慰问信
2015/11/30 职场文书
MySQL 使用自定义变量进行查询优化
2021/05/14 MySQL
详解Mysql和Oracle之间的误区
2021/05/18 MySQL