Django学习笔记5

视图系统（从属于视图层）

 Django的view（视图）

一个视图函数（类），简称视图，是一个简单的Python 函数（类），它接受Web请求并且返回Web响应。

响应可以是一张网页的HTML内容，一个重定向，一个404错误，一个XML文档，或者一张图片。

无论视图本身包含什么逻辑，都要返回响应。代码写在哪里也无所谓，只要它在你当前项目目录下面。除此之外没有更多的要求了——可以说“没有什么神奇的地方”。为了将代码放在某处，大家约定成俗将视图放置在项目（project）或应用程序（app）目录中的名为views.py的文件中。

CBV和FBV

FBV和CBV

FBV（function base views） 就是在视图里使用函数处理请求。 
在之前django的学习中，我们一直使用的是这种方式，所以不再赘述。

CBV（class base views） 就是在视图里使用类处理请求。 
Python是一个面向对象的编程语言，如果只用函数来开发，有很多面向对象的优点就错失了（继承、封装、多态）。所以Django在后来加入了Class-Based-View。可以让我们用类写View。这样做的优点主要下面两种：

• 提高了代码的复用性，可以使用面向对象的技术，比如Mixin（多继承） 
• 可以用不同的函数针对不同的HTTP方法处理，而不是通过很多if判断，提高代码可读性

FBV版：

# FBV版添加班级
def add_class(request):
    if request.method == "POST":
        class_name = request.POST.get("class_name")
        models.Classes.objects.create(name=class_name)
        return redirect("/class_list/")
    return render(request, "add_class.html")

CBV版：

# CBV版添加班级
from django.views import View


class AddClass(View):

    def get(self, request):
        return render(request, "add_class.html")

    def post(self, request):
        class_name = request.POST.get("class_name")
        models.Classes.objects.create(name=class_name)
        return redirect("/class_list/")

注意：

使用CBV时，urls.py中也做对应的修改：

# urls.py中
url(r'^add_class/$', views.AddClass.as_view()),

cbv流程及源码分析

class View(object):
    """
    Intentionally simple parent class for all views. Only implements
    dispatch-by-method and simple sanity checking.
    """

    http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

    def __init__(self, **kwargs):
        """
        Constructor. Called in the URLconf; can contain helpful extra
        keyword arguments, and other things.
        """
        # Go through keyword arguments, and either save their values to our
        # instance, or raise an error.
        for key, value in six.iteritems(kwargs):
            setattr(self, key, value)

    @classonlymethod
    def as_view(cls, **initkwargs):
        """
        Main entry point for a request-response process.
        """
        for key in initkwargs:
            if key in cls.http_method_names:
                raise TypeError("You tried to pass in the %s method name as a "
                                "keyword argument to %s(). Don't do that."
                                % (key, cls.__name__))
            if not hasattr(cls, key):
                raise TypeError("%s() received an invalid keyword %r. as_view "
                                "only accepts arguments that are already "
                                "attributes of the class." % (cls.__name__, key))

        def view(request, *args, **kwargs):
            self = cls(**initkwargs)
            if hasattr(self, 'get') and not hasattr(self, 'head'):
                self.head = self.get
            self.request = request
            self.args = args
            self.kwargs = kwargs
            return self.dispatch(request, *args, **kwargs)
        view.view_class = cls
        view.view_initkwargs = initkwargs

        # take name and docstring from class
        update_wrapper(view, cls, updated=())

        # and possible attributes set by decorators
        # like csrf_exempt from dispatch
        update_wrapper(view, cls.dispatch, assigned=())
        return view

    def dispatch(self, request, *args, **kwargs):
        # Try to dispatch to the right method; if a method doesn't exist,
        # defer to the error handler. Also defer to the error handler if the
        # request method isn't on the approved list.
        if request.method.lower() in self.http_method_names:
            handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
        else:
            handler = self.http_method_not_allowed
        return handler(request, *args, **kwargs)

    def http_method_not_allowed(self, request, *args, **kwargs):
        logger.warning(
            'Method Not Allowed (%s): %s', request.method, request.path,
            extra={'status_code': 405, 'request': request}
        )
        return http.HttpResponseNotAllowed(self._allowed_methods())

    def options(self, request, *args, **kwargs):
        """
        Handles responding to requests for the OPTIONS HTTP verb.
        """
        response = http.HttpResponse()
        response['Allow'] = ', '.join(self._allowed_methods())
        response['Content-Length'] = '0'
        return response

    def _allowed_methods(self):
        return [m.upper() for m in self.http_method_names if hasattr(self, m)]

cbv执行流程：浏览器向服务器发送一个get请求，基于类的视图执行流程

首先，django启动，会执行视图类下的as_view()：

urlpatterns = [
    url(r'^admin/', admin.site.urls),

    # as_view()  执行类的as_view()   
    url(r'books/',views.BookView.as_view()),
]

　　as_view():由于BookView没有实现as_view()方法，会调用父类(View)中的as_view()方法：

@classonlymethod
    def as_view(cls, **initkwargs):
        """
        请求响应过程的主要入口点
        """
        ......
        def view(request, *args, **kwargs):
            self = cls(**initkwargs)
            if hasattr(self, 'get') and not hasattr(self, 'head'):
                self.head = self.get
            self.request = request
            self.args = args
            self.kwargs = kwargs
            
            #view方法返回self.dispatch()方法的返回值
            return self.dispatch(request, *args, **kwargs)
        view.view_class = cls
        view.view_initkwargs = initkwargs
        update_wrapper(view, cls, updated=())
        update_wrapper(view, cls.dispatch, assigned=())
        
        #返回view方法内存地址,当用户访问books/的时候，会调用改view()方法
        return view

　　self.dispatch():由于BookView没有实现dispatch()，所以会调用View类的dispatch()

dispatch的主要作用：view视图的一部分 - 接受request 参数和参数的方法，并返回HTTP响应。

检测HTTP请求方法，并尝试委托给匹配HTTP方法的方法，一个GET将被委托给get()，一POST来post()，等等。

def dispatch(self, request, *args, **kwargs):
    # 尝试把用户请求分发到正确的方法，如果方法不存在，遵从错误的处理程序
    # 如果请求方法不在已批准的列表中，也会遵从错误的处理程序
    if request.method.lower() in self.http_method_names:
        # 使用反射，例如用户访问是get请求
        # handler = getattr(BookView,"get",错误处理程序)
        handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
    else:
        handler = self.http_method_not_allowed
        
    # return get(request,*args, **kwargs)
    return handler(request, *args, **kwargs)

　　URLconf中可以变化为：

此时URLconf的配置
 url(r'books/',views.BookView.as_view()),
 等价于
 url(r'books/',view) # 由于view return self.dispatch()
 等价于
 url(r'books/',self.dispatch())
 等价于
 url(r'books/',handler(request,*args,**kwargs)
 --> url(r'books/',get(request,*args,**kwargs)
 --> url(r'books/',post(request,*args,**kwargs)
 等等

dispatch()的独特作用：

上面的CBV执行流程可以简化为请求来--url分发给dispatch()--dispatch()通过反射分发给各函数--得到各函数的返回值，通过dispatch()返还response

所以dispatch的一个作用可以给每一个CBV中的函数当做装饰器，可以拆分出来作为基类然后继承，如下

给视图加装饰器

使用装饰器装饰FBV

FBV本身就是一个函数，所以和给普通的函数加装饰器无差：

def wrapper(func):
    def inner(*args, **kwargs):
        start_time = time.time()
        ret = func(*args, **kwargs)
        end_time = time.time()
        print("used:", end_time-start_time)
        return ret
    return inner


# FBV版添加班级
@wrapper
def add_class(request):
    if request.method == "POST":
        class_name = request.POST.get("class_name")
        models.Classes.objects.create(name=class_name)
        return redirect("/class_list/")
    return render(request, "add_class.html")

使用装饰器装饰CBV

类中的方法与独立函数不完全相同，因此不能直接将函数装饰器应用于类中的方法 ，我们需要先将其转换为方法装饰器。

Django中提供了method_decorator装饰器用于将函数装饰器转换为方法装饰器。

# CBV版添加班级
from django.views import View
from django.utils.decorators import method_decorator

class AddClass(View):

    @method_decorator(wrapper)
    def get(self, request):
        return render(request, "add_class.html")

    def post(self, request):
        class_name = request.POST.get("class_name")
        models.Classes.objects.create(name=class_name)
        return redirect("/class_list/")

Request对象和Response对象

Django 使用Request 对象和Response 对象在系统间传递状态，具体实现一般都是HttpRequest和HttpResponse。

当请求一个页面时，Django会建立一个包含请求元数据的 HttpRequest 对象。 当Django 加载对应的视图时，HttpRequest 对象将作为视图函数的第一个参数。 每个视图会返回一个HttpResponse 对象。

本文档对HttpRequest 和HttpResponse 对象的API 进行说明，这些API 定义在django.http 模块中，具体位置见下图

request对象

当一个页面被请求时，Django就会创建一个包含本次请求原信息的HttpRequest对象。
Django会将这个对象自动传递给响应的视图函数，一般视图函数约定俗成地使用 request 参数承接这个对象，request参数就是HttpRequest对象。

请求相关的常用属性值

所有属性应被视为只读，除非另有说明。

• HttpRequest.scheme

一个字符串，表示请求的方案（通常是http 或https）。

• HttpRequest.body

一个字节字符串，表示原始HTTP 请求的正文。 它对于处理非HTML 形式的数据非常有用：二进制图像、XML等。 如果要处理常规的表单数据，应该使用HttpRequest.POST。

你还可以使用类似文件的接口从HttpRequest中读取数据。 参见HttpRequest.read()。

• HttpRequest.path

  表示请求页面的完整路径的字符串，不包括方案或域。

  例如："/music/bands/the_beatles/"

• HttpRequest.path_info

  在某些Web 服务器配置下，主机名后的URL 部分被分成脚本前缀部分和路径信息部分。 path_info 属性将始终包含路径信息部分，不论使用的Web 服务器是什么。 使用它代替path 可以让代码在测试和开发环境中更容易地切换。

  例如，如果应用的WSGIScriptAlias 设置为"/music/bands/the_beatles/"，那么当"/minfo" 是"/minfo/music/bands/the_beatles/" 时path_info 将是path。

• HttpRequest.method

一个字符串，表示请求使用的HTTP 方法。 必须使用大写。 像这样：

if request.method == 'GET':
    do_something()
elif request.method == 'POST':
    do_something_else()

• HttpRequest.encoding

一个字符串，表示提交的数据的编码方式（如果为None 则表示使用DEFAULT_CHARSET 设置）。 这个属性是可写的，你可以修改它来修改访问表单数据使用的编码。 任何随后的属性访问（例如从GET或POST读取）将使用新的encoding值。 如果你知道表单数据的编码不在DEFAULT_CHARSET 中，则使用它。

• HttpRequest.content_type

Django 1.10中新增。

表示从CONTENT_TYPE头解析的请求的MIME类型的字符串。

• HttpRequest.content_params

Django 1.10中新增。

包含在CONTENT_TYPE标题中的键/值参数字典。

• HttpRequest.GET

一个类似于字典的对象，包含HTTP GET 的所有参数。 详情请参考下面的QueryDict 文档。

• HttpRequest.POST

一个包含所有给定的HTTP POST参数的类字典对象，提供了包含表单数据的请求。 详情请参考下面的QueryDict 文档。 如果需要访问请求中的原始或非表单数据，可以使用HttpRequest.body 属性。

POST请求可能带有一个空的POST字典 — 如果通过HTTP POST方法请求一个表单但是没有包含表单数据。 所以，你不应该使用if request.POST来检查使用的是否是POST方法；请使用if request.method == "POST"（参见HttpRequest.method）。

POST 不包含文件上传信息。 参见FILES。

• HttpRequest.COOKIES

包含所有Cookie的字典。 键和值都为字符串。

• HttpRequest.FILES

一个类似于字典的对象，包含所有上传的文件。 FILES中的每个键为<input type="file" name="" />中的name。 FILES中的每个值是一个UploadedFile。

更多信息参见管理文件。

如果请求方法是POST且请求的<form>带有enctype="multipart/form-data"，那么FILES将只包含数据。 否则，FILES将为一个空的类似于字典的对象。

• HttpRequest.META

包含所有可用HTTP标头的字典。 具体的头部信息取决于客户端和服务器，下面是一些示例：

• CONTENT_LENGTH —— 请求的正文的长度（是一个字符串）。
• CONTENT_TYPE —— 请求的正文的MIME 类型。
• HTTP_ACCEPT —— 响应可接收的Content-Type。
• HTTP_ACCEPT_ENCODING —— 响应可接收的编码。
• HTTP_ACCEPT_LANGUAGE —— 响应可接收的语言。
• HTTP_HOST —— 客服端发送的HTTP Host 头部。
• HTTP_REFERER —— Referring 页面。
• HTTP_USER_AGENT —— 客户端的user-agent 字符串。
• QUERY_STRING —— 单个字符串形式的查询字符串（未解析过的形式）。
• REMOTE_ADDR —— 客户端的IP 地址。
• REMOTE_HOST —— 客户端的主机名。
• REMOTE_USER —— 服务器认证后的用户。
• REQUEST_METHOD —— 一个字符串，例如"GET" 或"POST"。
• SERVER_NAME —— 服务器的主机名。
• SERVER_PORT —— 服务器的端口（是一个字符串）。

从上面可以看到，除CONTENT_LENGTH 和CONTENT_TYPE 之外，请求中的任何HTTP 头部转换为HTTP_ 的键时，都会将所有字母大写并将连接符替换为下划线最后加上META 前缀。 所以，一个叫做X-Bender 的头部将转换成META 中的HTTP_X_BENDER 键。

请注意，runserver将名称中带有下划线的所有标题剥离，因此您将不会在META中看到它们。 这可以根据WSGI环境变量中下划线的标点和下划线之间的歧义来防止标题欺骗。 它匹配像Nginx和Apache 2.4+之类的Web服务器的行为。

HttpRequest.resolver_match

代表已解析的URL的ResolverMatch的实例。 此属性仅在URL解析发生后设置，这意味着它可以在所有视图中使用，但不能在URL解析之前执行的中间件（您可以在process_view()中使用它）。

• HttpRequest.session

从SessionMiddleware：一个可读写的，类似字典的对象，表示当前会话。

• HttpRequest.site

从CurrentSiteMiddleware：代表当前站点的get_current_site()返回的Site或RequestSite的实例。

•  HttpRequest.user

来自AuthenticationMiddleware：表示当前登录的用户的AUTH_USER_MODEL的实例。 如果用户当前未登录，则user将被设置为AnonymousUser的实例。 您可以使用is_authenticated将它们分开，如下所示：

if request.user.is_authenticated:
    ... # Do something for logged-in users.
else:
    ... # Do something for anonymous users.

　　user 只有当Django 启用 AuthenticationMiddleware 中间件时才可用。

上传文件示例

上传表单界面

<form action="/upload/" method="post" enctype="multipart/form-data">  一定要加enctype="multipart/form-data"才能传文件
    <input type="file" name="upload_file">
    <input type="submit" value="开始上传">
</form>

上传处理函数

def upload(request):
    """
    保存上传文件前，数据需要存放在某个位置。默认当上传文件小于2.5M时，django会将上传文件的全部内容读进内存。从内存读取一次，写磁盘一次。
    但当上传文件很大时，django会把上传文件写到临时文件中，然后存放到系统临时文件夹中。
    :param request: 
    :return: 
    """
    if request.method == "POST":
        # 从请求的FILES中获取上传文件的文件名，file为页面上type=files类型input的name属性值
        filename = request.FILES["file"].name
        # 在项目目录下新建一个文件
        with open(filename, "wb") as f:
            # 从上传的文件对象中一点一点读
            for chunk in request.FILES["file"].chunks():
                # 写入本地文件
                f.write(chunk)
        return HttpResponse("上传OK")

上传文件示例代码

　　主要方法

1.HttpRequest.get_host()

　　根据从HTTP_X_FORWARDED_HOST（如果打开 USE_X_FORWARDED_HOST，默认为False）和 HTTP_HOST 头部信息返回请求的原始主机。
如果这两个头部没有提供相应的值，则使用SERVER_NAME 和SERVER_PORT，在PEP 3333 中有详细描述。

　　USE_X_FORWARDED_HOST：一个布尔值，用于指定是否优先使用 X-Forwarded-Host 首部，仅在代理设置了该首部的情况下，才可以被使用。

　　例如："127.0.0.1:8000"

　　注意：当主机位于多个代理后面时，get_host() 方法将会失败。除非使用中间件重写代理的首部。

 

2.HttpRequest.get_full_path()

　　返回 path，如果可以将加上查询字符串。

　　例如："/music/bands/the_beatles/?print=true"

 

3.HttpRequest.get_signed_cookie(key, default=RAISE_ERROR, salt='', max_age=None)

　　返回签名过的Cookie 对应的值，如果签名不再合法则返回django.core.signing.BadSignature。

　　如果提供 default 参数，将不会引发异常并返回 default 的值。

　　可选参数salt 可以用来对安全密钥强力攻击提供额外的保护。max_age 参数用于检查Cookie 对应的时间戳以确保Cookie 的时间不会超过max_age 秒。

>>> request.get_signed_cookie('name')
'Tony'
>>> request.get_signed_cookie('name', salt='name-salt')
'Tony' # 假设在设置cookie的时候使用的是相同的salt
>>> request.get_signed_cookie('non-existing-cookie')
...
KeyError: 'non-existing-cookie' # 没有相应的键时触发异常
>>> request.get_signed_cookie('non-existing-cookie', False)
False
>>> request.get_signed_cookie('cookie-that-was-tampered-with')
...
BadSignature: ... 
>>> request.get_signed_cookie('name', max_age=60)
...
SignatureExpired: Signature age 1677.3839159 > 60 seconds
>>> request.get_signed_cookie('name', False, max_age=60)
False

4.HttpRequest.is_secure()

　　如果请求时是安全的，则返回True；即请求通是过 HTTPS 发起的。

 

5.HttpRequest.is_ajax()

　　如果请求是通过XMLHttpRequest 发起的，则返回True，方法是检查 HTTP_X_REQUESTED_WITH 相应的首部是否是字符串'XMLHttpRequest'。

　　大部分现代的 JavaScript 库都会发送这个头部。如果你编写自己的 XMLHttpRequest 调用（在浏览器端），你必须手工设置这个值来让 is_ajax() 可以工作。

　　如果一个响应需要根据请求是否是通过AJAX 发起的，并且你正在使用某种形式的缓存例如Django 的 cache middleware，
你应该使用 vary_on_headers('HTTP_X_REQUESTED_WITH') 装饰你的视图以让响应能够正确地缓存。

请求相关方法 

response响应对象

与由Django自动创建的HttpRequest 对象相比，HttpResponse 对象由程序员创建. 您编写的每个视图都负责实例化，填充和返回一个HttpResponse。

HttpResponse 类是在django.http模块中定义的。

主要属性

• HttpResponse.content

一个用来代替content的字节字符串，如果必要，则从一个Unicode对象编码而来。

• HttpResponse.charset

一个字符串，用来表示response将会被编码的字符集。 如果没有在HttpResponse实例化的时候给定这个字符集，那么将会从content_type 中解析出来。并且当这种解析成功的时候，DEFAULT_CHARSET选项将会被使用。

• HttpResponse.status_code

响应的 HTTP status code。

除非明确设置了reason_phrase，否则在构造函数之外修改status_code的值也会修改reason_phrase的值。

• HttpResponse.reason_phrase

响应的HTTP原因短语。 它使用 HTTP standard’s默认原因短语。

除非明确设置，否则reason_phrase由status_code的值决定。

• HttpResponse.streaming

这个选项总是False。

由于这个属性的存在，使得中间件（middleware）能够区别对待流式response和常规response。

• HttpResponse.closed

True如果响应已关闭。

方法参考：官方文档

传递字符串

典型的应用是传递一个字符串作为页面的内容到HttpResponse 构造函数:

>>> from django.http import HttpResponse
>>> response = HttpResponse("Here's the text of the Web page.")
>>> response = HttpResponse("Text only, please.", content_type="text/plain")

　　如果你想增量增加内容，你可以将response 看做一个类文件对象

>>> response = HttpResponse()
>>> response.write("<p>Here's the text of the Web page.</p>")
>>> response.write("<p>Here's another paragraph.</p>")

　　设置或删除响应头信息

response = HttpResponse()
response['Content-Type'] = 'text/html; charset=UTF-8'
del response['Content-Type']

JsonResponse对象

JsonResponse是HttpResponse的子类，专门用来生成JSON编码的响应。

def json_test(request):
    data = {"name": "weilianxin", "age": 18}
    # import json
    # data_json = json.dumps(data)  # 把data序列化转化成json格式的字符串
    # return HttpResponse(data_json)
    # 这几行相当于下面两行
    
    from django.http import JsonResponse
    return JsonResponse(data)

默认只能传递字典类型，如果要传递非字典类型需要设置一下safe关键字参数。

response = JsonResponse([1, 2, 3], safe=False)

Django shortcut functions

render()

结合一个给定的模板和一个给定的上下文字典，并返回一个渲染后的 HttpResponse 对象。

参数：

     request： 用于生成响应的请求对象。

     template_name：要使用的模板的完整名称，可选的参数

     context：添加到模板上下文的一个字典。默认是一个空字典。如果字典中的某个值是可调用的，视图将在渲染模板之前调用它。

     content_type：生成的文档要使用的MIME类型。默认为 DEFAULT_CONTENT_TYPE 设置的值。默认为'text/html'

     status：响应的状态码。默认为200。

　　　useing: 用于加载模板的模板引擎的名称。

一个简单的例子：

from django.shortcuts import render

def my_view(request):
    # 视图的代码写在这里
    return render(request, 'myapp/index.html', {'foo': 'bar'})

上面的代码等于：

from django.http import HttpResponse
from django.template import loader

def my_view(request):
    # 视图代码写在这里
    t = loader.get_template('myapp/index.html')
    c = {'foo': 'bar'}
    return HttpResponse(t.render(c, request))

redirect()

参数可以是：

• 一个模型：将调用模型的get_absolute_url() 函数
• 一个视图，可以带有参数：将使用urlresolvers.reverse 来反向解析名称
• 一个绝对的或相对的URL，将原封不动的作为重定向的位置。

默认返回一个临时的重定向；传递permanent=True 可以返回一个永久的重定向。

示例:

你可以用多种方式使用redirect() 函数。

传递一个具体的ORM对象（了解即可）

将调用具体ORM对象的get_absolute_url() 方法来获取重定向的URL：

from django.shortcuts import redirect
 
def my_view(request):
    ...
    object = MyModel.objects.get(...)
    return redirect(object)

传递一个视图的名称

def my_view(request):
    ...
    return redirect('some-view-name', foo='bar')

传递要重定向到的一个具体的网址

def my_view(request):
    ...
    return redirect('/some/url/')

当然也可以是一个完整的网址

def my_view(request):
    ...
    return redirect('http://example.com/')

默认情况下，redirect() 返回一个临时重定向。以上所有的形式都接收一个permanent 参数；如果设置为True，将返回一个永久的重定向：

def my_view(request):
    ...
    object = MyModel.objects.get(...)
    return redirect(object, permanent=True)　　

扩展阅读： 

临时重定向（响应状态码：302）和永久重定向（响应状态码：301）对普通用户来说是没什么区别的，它主要面向的是搜索引擎的机器人。

A页面临时重定向到B页面，那搜索引擎收录的就是A页面。

A页面永久重定向到B页面，那搜索引擎收录的就是B页面。