Django之上下文处理器和中间件

################# 上下文处理器：
    上下文处理器是可以返回一些数据，在全局模板中都可以使用。
    比如登录后的用户信息，在很多页面中都需要使用，那么我们可以放在上下文处理器中，就没有必要在每个视图函数中都返回这个对象。

    在settings.TEMPLATES.OPTIONS.context_processors中，有许多内置的上下文处理器。这些上下文处理器的作用如下：
        django.template.context_processors.debug：增加一个debug和sql_queries变量。在模板中可以通过他来查看到一些数据库查询。
        django.template.context_processors.request：增加一个request变量。这个request变量也就是在视图函数的第一个参数。
        django.contrib.auth.context_processors.auth：Django有内置的用户系统，这个上下文处理器会增加一个user对象。
        django.contrib.messages.context_processors.messages：增加一个messages变量。
        django.template.context_processors.media：在模板中可以读取MEDIA_URL。比如想要在模板中使用上传的文件，
                                                  那么这时候就需要使用settings.py中设置的MEDIA_URL来拼接url。
                                                  示例代码如下：
                                                        <img src="" />
        django.template.context_processors.static：在模板中可以使用STATIC_URL。
        django.template.context_processors.csrf：在模板中可以使用csrf_token变量来生成一个csrf token。
################# 自定义上下文处理器：
有时候我们想要返回自己的数据。那么这时候我们可以自定义上下文处理器。自定义上下文处理器的步骤如下：
    1.你可以根据这个上下文处理器是属于哪个app，然后在这个app中创建一个文件专门用来存储上下文处理器。
      比如context_processors.py。或者是你也可以专门创建一个Python包，用来存储所有的上下文处理器。
    2.在你定义的上下文处理器文件中，定义一个函数，这个函数只有一个request参数。这个函数中处理完自己的逻辑后，
      把需要返回给模板的数据，通过字典的形式返回。如果不需要返回任何数据，那么也必须返回一个空的字典。示例代码如下：
         def frontuser(request):
           userid = request.session.get("userid")
           userModel = models.FrontendUser.objects.filter(pk=userid).first()
           if userModel:
             return {'frontuser':userModel}
           else:
             return {}
################# 中间件：中间件是在request和response处理过程中的一个插件。
    比如在request到达视图函数之前，我们可以使用中间件来做一些相关的事情，
    比如可以判断当前这个用户有没有登录，如果登录了，就绑定一个user对象到request上。
    也可以在response到达浏览器之前，做一些相关的处理，比如想要统一在response上设置一些cookie信息等。    
################# 自定义中间件：
    中间件所处的位置没有规定。只要是放到项目当中即可。
    一般分为两种情况，如果中间件是属于某个app的，那么可以在这个app下面创建一个python文件用来存放这个中间件，
    也可以专门创建一个Python包，用来存放本项目的所有中间件。创建中间件有两种方式，一种是使用函数，一种是使用类，接下来对这两种方式做个介绍：
    ## 使用函数的中间件：
        def simple_middleware(get_response):
              # 这个中间件初始化的代码

              def middleware(request):
                  # request到达view的执行代码

                  response = get_response(request)

                  # response到达浏览器的执行代码

                  return response

              return middleware
    ## 使用类的中间件：
        class SimpleMiddleware(object):
              def __init__(self, get_response):
                  self.get_response = get_response
                  # 这个中间件初始化的代码
                  def __call__(self, request):
                      # request到达view之前执行的代码

                      response = self.get_response(request)

                      # response到达用户浏览器之前执行的代码

                      return response    
    在写完中间件后，还需要在settings.MIDDLEWARES中配置写好的中间件才可以使用。
    比如我们写了一个在request到达视图函数之前，判断这个用户是否登录，
    如果已经登录就绑定一个user对象到request上的中间件，这个中间件放在当前项目的middlewares.users下：
        def user_middleware(get_response):
              # 这个中间件初始化的代码

              def middleware(request):
                  # request到达view的执行代码
                  userid = request.session.get("userid")
                  userModel = FrontUser.objects.filter(pk=userid).first()
                  if userModel:
                          setattr(request,'frontuser',userModel)

                  response = get_response(request)

                  # response到达浏览器的执行代码

                  return response

              return middleware
    那么就可以在settings.MIDDLEWARES下做以下配置：
        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.users.user_middleware'
        ]        
    中间件的执行是有顺序的，他会根据在MIDDLEWARE中存放的顺序来执行。
    因此如果有些中间件是需要基于其他中间件的，那么就需要放在其他中间件的后面来执行。
################# Django内置的中间件：
    1.django.middleware.common.CommonMiddleware：通用中间件。他的作用如下：
        1）限制settings.DISALLOWED_USER_AGENTS中指定的请求头来访问本网站。DISALLOWED_USER_AGENT是一个正则表达式的列表。示例代码如下：
                  import re
                  DISALLOWED_USER_AGENTS = [
                      re.compile(r'^\s$|^$'),
                      re.compile(r'.*PhantomJS.*')
                  ]
        2）如果开发者在定义url的时候，最后有一个斜杠。但是用户在访问url的时候没有提交这个斜杠，那么CommonMiddleware会自动的重定向到加了斜杠的url上去。
    2.django.middleware.gzip.GZipMiddleware：将响应数据进行压缩。如果内容长度少于200个长度，那么就不会压缩。
    3.django.contrib.messages.middleware.MessageMiddleware：消息处理相关的中间件。
    4.django.middleware.security.SecurityMiddleware：做了一些安全处理的中间件。比如设置XSS防御的请求头，比如做了http协议转https协议的工作等。
    5.django.contrib.sessions.middleware.SessionMiddleware：session中间件。会给request添加一个处理好的session对象。
    6.django.contrib.auth.middleware.AuthenticationMiddleware：会给request添加一个user对象的中间件。
    7.django.middleware.csrf.CsrfViewMiddleware：CSRF保护的中间件。
    8.django.middleware.clickjacking.XFrameOptionsMiddleware：做了clickjacking攻击的保护。clickjacking保护是攻击者在自己的病毒网站上，
      写一个诱惑用户点击的按钮，然后使用iframe的方式将受攻击的网站（比如银行网站）加载到自己的网站上去，并将其设置为透明的，用户就看不到，
      然后再把受攻击的网站（比如银行网站）的转账按钮定位到病毒网站的按钮上，这样用户在点击病毒网站上按钮的时候，
      实际上点击的是受攻击的网站（比如银行网站）上的按钮，从而实现了在不知不觉中给攻击者转账的功能。
    9.缓存中间件：用来缓存一些页面的。
        django.middleware.cache.UpdateCacheMiddleware。
        django.middleware.cache.FetchFromCacheMiddleware。
################# 内置中间件放置的顺序：
    1.SecurityMiddleware：应该放到最前面。因为这个中间件并不需要依赖任何其他的中间件。如果你的网站同时支持http协议和https协议，
                          并且你想让用户在使用http协议的时候重定向到https协议，那么就没有必要让他执行下面一大串中间件再重定向，这样效率更高。
    2.UpdateCacheMiddleware：应该在SessionMiddleware, GZipMiddleware, LocaleMiddleware之前。
    3.GZipMiddleware。
    4.ConditionalGetMiddleware。
    5.SessionMiddleware。
    6.LocaleMiddleware。
    7.CommonMiddleware。
    8.CsrfViewMiddleware。
    9.AuthenticationMiddleware。
    10.MessageMiddleware。
    11.FetchFromCacheMiddleware。
    12.FlatpageFallbackMiddleware。
    13.RedirectFallbackMiddleware。
Django之上下文处理器和中间件

猜你喜欢
