django view CBV and FBV

table of Contents

CBV and FBV view

CBV and FBV view

What is a view?

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

   响应可以是一张网页的HTML内容，一个重定向，一个404错误，一个XML文档，或者一张图片。放置在项目
（project）或应用程序（app）目录中的名为`views.py`的文件中。

Here is a view returns the current date and time in the form of an HTML document:

from django.http import HttpResponse
import datetime

def current_datetime(request):
    now = datetime.datetime.now()
    html = "<html><body>It is now %s.</body></html>" % now
    return HttpResponse(html)

Let's explain the above code line by line:

首先，我们从 django.http模块导入了HttpResponse类，以及Python的datetime库。

接着，我们定义了current_datetime函数。它就是视图函数。每个视图函数都使用HttpRequest对象作为第一个参数，
并且通常称之为request。

注意，视图函数的名称并不重要；不需要用一个统一的命名方式来命名，以便让Django识别它。
我们将其命名为current_datetime，是因为这个名称能够比较准确地反映出它实现的功能。

这个视图会返回一个HttpResponse对象，其中包含生成的响应。每个视图函数都负责返回一个HttpResponse对象。

Django使用请求和响应对象来通过系统传递状态。

当浏览器向服务端请求一个页面时，Django创建一个HttpRequest对象，该对象包含关于请求的元数据。然后，
Django加载相应的视图，将这个HttpRequest对象作为第一个参数传递给视图函数。

每个视图负责返回一个HttpResponse对象。

FBV function based view based on a function of view

from app01 import models
from django.shortcuts import render, redirect, HttpResponse

import datetime
def mul(request):
    now = datetime.datetime.now()
    return render(request, 'mul.html',{'now':now})

Use FBV

#urls.py 文件
from django.conf.urls import url
from django.contrib import admin
from app01 import views

urlpatterns = [
    url(r'^mul', views.mul),
]

CBV class based view based on the view class

from app01 import models
from django.views import View
from django.shortcuts import render, redirect, HttpResponse

class AddPublisher(View):
    def get(self,request):
        """处理get请求"""
        return response
    
    def post(self,request):
        """处理post请求"""
        return response
#处理求响的逻辑很清晰

Use CBV:

#urls.py 文件
from django.conf.urls import url
from django.contrib import admin
from app01 import views

urlpatterns = [
url(r'^add_publisher/', views.AddPublisher.as_view()),
]#固定写法注意.as_view()是要加括号的

Tips

我们写的视图,可以接收,处理8种请求,页面发来的8种请求:   
from app01 import views   #ctrl+鼠标右击views 查看源码    

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']  

#可以看到views 默认接收了八种请求'get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace'
#那我在写视图函数是可以重新定义http_method_names = ['get',post]让这个视图,让它只接收get和post请求

In CBV view:

1561123065662

How to get CBV page request type, and the response

1. 项目启动，执行AddPublisher.as_view()       ——》  view

    url(r'add_publisher/',views.AddPublisher.as_view())

    url(r'add_publisher/', view )

2. 请求到来时执行view函数：

   1. 实例化AddPublisher   ——》 self

   2. self.request = reqeust

   3. 执行self.dispatch(request,*args,**kwargs)  

      1. 判断请求方式是否被允许     http_method_names  = []

         1. 允许

            通过反射获取到当前请求方式对应的方法   ——》 handler

         2. 不允许

            self.http_method_not_allowed    ——》  handler

      2. 执行handler(request,*args,**kwargs)     ——》  返回响应

Uses a decorator's FBV

FBV is itself a function, and so add to the normal function decorators no difference:

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")

Decorator of CBV

Method class independent functions are not identical, the method can not be directly applied to a function of decorator class, we need to first convert it to a method decorators.
Django provides method_decorator decorative function for converting a method decorator decorators.

# 装饰器加载方法上
import tinme
from django.views import View
from django.utils.decorators import method_decorator   #导入方法装饰器

def timer(func):
    def inner(request, *args, **kwargs):
        start = time.time()
        ret = func(request, *args, **kwargs)
        print("函数执行的时间是{}".format(time.time() - start))
        return ret
    return inner

class AddClass(View):

    @method_decorator(timer)
    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时要注意，请求过来后会先执行dispatch()这个方法，如果需要批量对具体的请求处理方法，如get，
post等做一些操作的时候，这里我们可以手动改写dispatch方法，这个dispatch方法就和在FBV上加装饰器的效果一样。
import tinme
from django.views import View
from django.utils.decorators import method_decorator   #导入方法装饰器

def timer(func):
    def inner(request, *args, **kwargs):
        start = time.time()
        ret = func(request, *args, **kwargs)
        print("函数执行的时间是{}".format(time.time() - start))
        return ret
    return inner

class Login(View):
    
    @method_decorator(timer) #相当于给get,post请求都加上了装饰器
    def dispatch(self, request, *args, **kwargs):
        obj = super(Login,self).dispatch(request, *args, **kwargs)
        return obj
 
    def get(self,request):
        return render(request,'login.html')
 
    def post(self,request):
        print(request.POST.get('user'))
        return HttpResponse('Login.post')

#装饰器加在类上
import tinme
from django.views import View
from django.utils.decorators import method_decorator   #导入方法装饰器

def timer(func):
    def inner(request, *args, **kwargs):
        start = time.time()
        ret = func(request, *args, **kwargs)
        print("函数执行的时间是{}".format(time.time() - start))
        return ret
    return inner
@method_decorator(timer,name = 'get') #相当于给get,加上了装饰器
@method_decorator(timer,name = 'post')
class Login(View):
    
    def get(self,request):
        return render(request,'login.html')
 
    def post(self,request):
        print(request.POST.get('user'))
        return HttpResponse('Login.post')

使用method_decorator与不使用的区别：
"""
def timer(func):
    pritn(func)
    def inner(request, *args, **kwargs):
        print(args)
        start = time.time()
        ret = func(request, *args, **kwargs)
        print("函数执行的时间是{}".format(time.time() - start))
        return ret
"""        
    

不使用用method_decorator

func   ——》 <function AddPublisher.get at 0x000001FC8C358598>

args  ——》 (<app01.views.AddPublisher object at 0x000001FC8C432C50>, <WSGIRequest: GET '/add_publisher/'>)


使用method_decorator之后：

func ——》 <function method_decorator.<locals>._dec.<locals>._wrapper.<locals>.bound_func at 0x0000015185F7C0D0>

args ——》 (<WSGIRequest: GET '/add_publisher/'>,)

Request object

The request object

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

Official Documents
Common values related requests
request.path_info returns the user to access url, excluding the domain name (id and port), parameters such as: (/ index /)
request.path with the same path_info
request.method string HTTP method used in the request indicates, represents all uppercase (8 types).
request.GET contains all HTTP GET parameters dictionary-like object (carried on the url parameter)
request.POST contains all HTTP POST dictionary-like object parameters (POST request data submitted)
request.body request body, byte type request.POST data is extracted from inside the body to as (b 'content')
Attributes
All property should be considered read-only, unless otherwise noted.

属性：
　　django将请求报文中的请求行、头部信息、内容主体封装成 HttpRequest 类中的属性。
   除了特殊说明的之外，其他均为只读的。


0.HttpRequest.scheme
   表示请求方案的字符串（通常为http或https）

1.HttpRequest.body

　　一个字符串，代表请求报文的主体。在处理非 HTTP 形式的报文时非常有用，例如：二进制图片、XML,Json等。

　　但是，如果要处理表单数据的时候，推荐还是使用 HttpRequest.POST 。

　　另外，我们还可以用 python 的类文件方法去操作它，详情参考 HttpRequest.read() 。

 

2.HttpRequest.path

　　一个字符串，表示请求的路径组件（不含域名）。

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



3.HttpRequest.method

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

　　例如："GET"、"POST"

 

4.HttpRequest.encoding

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

 

5.HttpRequest.GET 

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

 

6.HttpRequest.POST

　　一个类似于字典的对象，如果请求中包含表单数据，则将这些数据封装成 QueryDict 对象。

　　POST 请求可以带有空的 POST 字典 —— 如果通过 HTTP POST 方法发送一个表单，但是表单中没有任何的数据，
QueryDict 对象依然会被创建。
   因此，不应该使用 if request.POST  来检查使用的是否是POST 方法；应该使用 if request.method == "POST" 

　　另外：如果使用 POST 上传文件的话，文件信息将包含在 FILES 属性中。

 7.HttpRequest.COOKIES

　　一个标准的Python 字典，包含所有的cookie。键和值都为字符串。

 

8.HttpRequest.FILES

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

　　注意，FILES 只有在请求的方法为POST 且提交的<form> 带有enctype="multipart/form-data" 的情况下才会
   包含数据。否则，FILES 将为一个空的类似于字典的对象。

 

9.HttpRequest.META

 　　一个标准的Python 字典，包含所有的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 首部转换为 META 的键时，
    都会将所有字母大写并将连接符替换为下划线最后加上 HTTP_  前缀。
    所以，一个叫做 X-Bender 的头部将转换成 META 中的 HTTP_X_BENDER 键。

 
10.HttpRequest.user

　　一个 AUTH_USER_MODEL 类型的对象，表示当前登录的用户。

　　如果用户当前没有登录，user 将设置为 django.contrib.auth.models.AnonymousUser 的一个实例。
你可以通过 is_authenticated() 区分它们。

    例如：

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

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

     -------------------------------------------------------------------------------------

    匿名用户
    class models.AnonymousUser

    django.contrib.auth.models.AnonymousUser 类实现了django.contrib.auth.models.User 接口，但具有下面几个不同点：

    id 永远为None。
    username 永远为空字符串。
    get_username() 永远返回空字符串。
    is_staff 和 is_superuser 永远为False。
    is_active 永远为 False。
    groups 和 user_permissions 永远为空。
    is_anonymous() 返回True 而不是False。
    is_authenticated() 返回False 而不是True。
    set_password()、check_password()、save() 和delete() 引发 NotImplementedError。
    New in Django 1.8:
    新增 AnonymousUser.get_username() 以更好地模拟 django.contrib.auth.models.User。

 

11.HttpRequest.session

 　　一个既可读又可写的类似于字典的对象，表示当前的会话。只有当Django 启用会话的支持时才可用。
    完整的细节参见会话的文档。

Upload file example

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")
    
#html 
<form action="" method="post" enctype="multipart/form-data">#要写enctype
    {% csrf_token %}#防跨站伪造
    <input type="file"  name="f1">
    <button>上传</button>
</form>

method

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()   #带参数 不包涵IP 端口

　　返回 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') 装饰你的视图以让响应能够正确地缓存。

Note: a plurality of key-value pairs, when the input type such as checkbox, SELECT labels, with:

request.POST.getlist("hobby")

Response object

与由Django自动创建的HttpRequest对象相比，HttpResponse对象是我们的职责范围了。我们写的每个视图都需要实例化，
填充和返回一个HttpResponse。
HttpResponse类位于django.http模块中。
"""
from django.shortcuts import render, redirect, HttpResponse
HttpResponse('字符串')    ——》  ’字符创‘
render(request,'模板的文件名',{k1:v1})   ——》 返回一个完整的TML页面
redirect('重定向的地址')    ——》 重定向   Location ： 地址
"""

#前后端分离项目 利用json传输数据
from django.http.response import JsonResponse
def json_data(request):
    data = {'name':'alex','age':73}
JsonResponse(data) #浏览器会自己做json反序列化 把数据变为可用的

JsonResponse(data,safe=False) #列表序列化

use
Passing strings

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

Set or delete response headers

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

Attributes

HttpResponse.content：响应内容

HttpResponse.charset：响应内容的编码

HttpResponse.status_code：响应的状态码

JsonResponse objects
JsonResponse is HttpResponse subclass, designed to generate a response JSON-encoded.

from django.http import JsonResponse

response = JsonResponse({'foo': 'bar'})
print(response.content)

b'{"foo": "bar"}'

The default can only pass a dictionary, a dictionary if you want to pass a non-keyword arguments need to set up safe.

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

Django shortcut functions
Official Documents
render()

Combined with a given template with a given context dictionary and returns an HttpResponse object after rendering.

parameter:

request: a request for an object that generates the response.
Parameters to use the full name of the template, optional: template_name
context: add a dictionary to the template context. The default is an empty dictionary. If a value in the dictionary is callable, the view will be called before rendering the template.
content_type: MIME type generated document to be used. The default value of DEFAULT_CONTENT_TYPE settings. The default is 'text / html'
status: status code of the response. The default is 200.
useing: The name of the template engine load the template.

A simple example:

from django.shortcuts import render

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

The above code is equal to:

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()
Parameters can be:

  一个模型：将调用模型的get_absolute_url() 函数
  一个视图，可以带有参数：将使用urlresolvers.reverse 来反向解析名称
  一个绝对的或相对的URL，将原封不动的作为重定向的位置。
    
默认返回一个临时的重定向；传递permanent=True 可以返回一个永久的重定向。

Example:

You can use a variety of ways redirect()function.

ORM pass a specific object (to understand)

ORM will call the specific object get_absolute_url()methods to obtain the redirected URL:

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

Pass the name of a view

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

Transfer to redirect to a specific URL

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

Of course, it can be a full URL

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

By default, redirect()it returns a temporary redirect. All of the above forms are receiving a permanentparameter;
if set True, returns a permanent redirection:

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

Further reading:

Temporary Redirect (response status code: 302) and permanent redirect (response status code: 301) for the average user is no difference, and
it is mainly for the search engine robots.

A temporary redirect page to page B, then A is indexed by search engines page.

A permanent redirect page to page B, then B is indexed by search engines page.