Django之视图(view)

Posted rx-h

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Django之视图(view)相关的知识,希望对你有一定的参考价值。

       Django之视图(view)       

  一个视图函数(类),简称视图,是一个简单的Python 函数(类),它接受Web请求并且返回Web响应。简单理解就是接受请求返回响应。响应可以是一张网页的html内容,一个重定向,一个404错误,一个XML文档,或者一张图片等等。无论视图本身包含什么逻辑,都要返回响应。代码写在哪里也无所谓,只要它在你当前项目目录下面。为了形成一致的标准,将视图放置在项目(project)或应用程序(app)目录中的名为views.py的文件中。

先给个例子,体会一下:

技术图片
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)
views.py中的函数
技术图片
from django.contrib import admin

from django.urls import path
from app01 import views
urlpatterns = [
     path(‘current_datetime/‘, views.current_datetime)
               #请求路径                     所映射的执行函数
]
urls.py中引入路径以及通过请求执行对应函数的映射

下来看一下关于每一行的解释:

  • 首先,我们从 django.http模块导入了HttpResponse类,以及Python的datetime库。
  • 接着,我们定义了current_datetime函数。它就是视图函数。每个视图函数都使用HttpRequest对象作为第一个参数,并且通常称之为request。注意,视图函数的名称不需要用一个统一的命名方式来命名。我们将其命名为current_datetime,是因为这个名称能够比较准确地反映出它实现的功能。
  • 这个视图会返回一个HttpResponse对象,其中包含生成的响应。每个视图函数都负责返回一个HttpResponse对象。

Django使用请求和响应对象来通过系统传递状态。
当浏览器向服务端请求一个页面时,Django创建一个HttpRequest对象,该对象包含关于请求的元数据。然后,Django加载相应的视图,将这个HttpRequest对象作为第一个参数传递给视图函数。
每个视图负责返回一个HttpResponse对象。

          CBV和FBV          

我们之前写过的都是基于函数的view,就叫FBV。还可以把view写成基于类的。CBV(class base view)和FBV(function base view)

注意:在views中使用类必须继承View。

以添加出版社为例:

技术图片
from django.shortcuts import render, redirect, HttpResponse
from app01 import models

def add_publisher(request):
    if request.method == POST:
        pub = request.POST.get(publisher_name, None)
        models.publisherList.objects.create(publisher=pub)
        return redirect(/publisher_list/)
    return render(request, add_publisher.html)
FBV版
技术图片
from django.views import View
class AddPublisher(View):
    def get(self, request):
        return render(request, add_publisher.html)

    def post(self, request):
        pub = request.POST.get(publisher_name, None)
        error_msg = ‘‘
        if pub:
            models.publisherList.objects.create(publisher=pub)
            return redirect(/publisher_list/)
        else:
            error_msg = 名字不为空
            return render(request, add_publisher.html, {"error_msg": error_msg})
#  在urls中如何使用:  path(‘add_publisher/‘, views.AddPublisher.as_view())
#这里将GET和POST方法分开来写
CBV版

 

#  在urls中如何使用:  path(‘add_publisher/‘, views.AddPublisher.as_view())

 

  给视图加装饰器  

使用装饰器装饰FBV:FBV本身就是一个函数,所以和给普通的函数加装饰器无差。

使用装饰器装饰CBV:类中的方法与独立函数不完全相同,因此不能直接将函数装饰器应用于类中的方法 ,我们需要先将其转换为方法装饰器。Django中提供了method_decorator装饰器用于将函数装饰器转换为方法装饰器。

技术图片
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
wrapper
技术图片
from django.views import View
from django.utils.decorators import method_decorator
class AddPublisher(View):
    @method_decorator(wrapper)
    def get(self, request):
        return render(request, add_publisher.html)

    def post(self, request):
        pub = request.POST.get(publisher_name, None)
        error_msg = ‘‘
        if pub:
            models.publisherList.objects.create(publisher=pub)
            return redirect(/publisher_list/)
        else:
            error_msg = 名字不为空
            return render(request, add_publisher.html, {"error_msg": error_msg})
CBV加装饰器

       Request对象和Response对象       

        request对象          

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

  请求相关的常用值  

  • path_info     返回用户访问url,不包括域名
  • method        请求中使用的HTTP方法的字符串表示,全大写表示。
  • GET              包含所有HTTP  GET参数的类字典对象
  • POST           包含所有HTTP POST参数的类字典对象
  • body            请求体,byte类型 request.POST的数据就是从body里面提取到的

      属性      

所有的属性应该被认为是只读的,除非另有说明

技术图片
属性:
  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       —— 客服端发送的HTTPHost头部。
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启用会话的支持时才可用。具体的细节参见会话的文档。
request属性相关
技术图片
def upload_file(request):
    if request.method == POST:
        filename = request.FILES[upload_file].name  #获取需要上传的文件的文件名
        with open(filename, wb) as f:      #写入文件f
            for i in request.FILES[upload_file].chunks():
                f.write(i)
        return HttpResponse(ok)   #上传完成后,相应页面一个“ok”
    return render(request, upload_file.html)    刚开始进入上传页面时,给前端返回此响应
上传文件示例

 

<form action=/upload/ method=post enctype=multipart/form-data>
# # 注意,必须加上enctype属性

      方法      

技术图片
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)装饰你的视图以让响应能够正确地缓存。
请求相关方法

注意:键值对的值是多个的时候,比如checkbox类型的input标签,select标签,需要用:

request.POST.getlist("books")

        Response对象         

与由Django自动创建的HttpRequest对象相比,HttpResponse对象是我们的职责范围了。我们写的每个视图都需要实例化,填充和返回一个HttpResponse。HttpResponse类位于django.http模块中。

    使用    

技术图片
from django.http import HttpResponse
response: HttpResponse = HttpResponse("Here‘s the text of the Web page.")
response = HttpResponse("Text only, please.", content_type="text/plain")
# eg:
# urls.py:path(‘test/‘,views.test)

def test(request):
    return HttpResponse("Here‘s the text of the Web page.")
# 在浏览器中访问:127.0.0.1:8000/test/即可得到页面内容(Here‘s the text of the Web page.)
传递字符串至前端页面
技术图片
response = HttpResponse()
response[Content-Type] = text/html; charset=UTF-8
del response[Content-Type]
设置或删除响应头信息

    属性    

HttpResponse.content:响应内容
HttpResponse.charset:响应内容的编码
HttpResponse.status_code:响应的状态码

    JsonResponse对象     

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

技术图片
# views.py文件
def json_test(request):
    from django.http import JsonResponse
    data = {name: 小小子, age: 18}
    #  data1 = [11, 12, 34, 56]  注意:要想传列表数据,必须在JsonResponse中加入safe=False
    return JsonResponse(data)

# urls.py文件
path(json_test/,views.json_test)
jsonResponse

  Django shortcut functions  

官方文档

   render()   

 

def render(request, template_name, context=None, content_type=None, status=None, using=None):
    """
    Returns a HttpResponse whose content is filled with the result of calling
    django.template.loader.render_to_string() with the passed arguments.
    """
    content = loader.render_to_string(template_name, context, request, using=using)
    return HttpResponse(content, content_type, status)

结合一个给定的模板和一个给定的上下文字典,并返回一个渲染后的 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})  
    # 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页面。

以上是关于Django之视图(view)的主要内容,如果未能解决你的问题,请参考以下文章

django之urls与视图函数views的简单学习

Django - - - -视图层之视图函数(views)

Django之views系统

Django 之 Views视图理解

Django 基础 之 视图层(views)

Django之view