Django 视图系统

时间 2019-11-17

标签 django 视图系统栏目 Python 繁體版

原文原文链接

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

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

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

1、一个简单的视图django

下面是一个以HTML文档的形式返回当前日期和时间的视图：json

from django.http import HttpResponse
import datetime

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

让咱们来逐行解释下上面的代码：浏览器

首先，咱们从django.http模块导入了HttpResponse类，以及Python的datetime库。
接着，咱们定义了current_datetime函数。它就是视图函数。每一个视图函数都使用HttpResponse对象做为第一个参数，而且一般称之为request。

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

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

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

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

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

2、CBV和FBV

咱们以前写过的都是基于函数的view，就叫FBV。还能够把view写成基于类的。

# urls.py中
url(r'^login.html$', views.Login.as_view(), name='login'),


# views.py 中
from django.views import View
class Login(View):
    

    def diapatch(self, request, *args, **kwargs):
        print('before')
        obj = super(Login, self).dispatch(request, *args, **keargs)
        print('after')
        return obj
    

    def get(self, request):
        print(request.POST.get('user'))
        return HttpResponse('Login.post')

使用 CBV 时要注意，请求过来后会先执行 dispatch() 这个方法，若是须要批量对具体的请求处理方法，如 get, post等作一些操做时候，这里咱们能够手动改写 dispatch 方法，这个 dispatch 方法就和在 FBV上加装饰器的效果是同样的。

Request 对象

一、属性

全部的属性应该被认为是只读的，除非另有说明。

属性：
    Django 将请求报文中的请求行、头部信息、内容主体封装成 HttpResponse 类中的属性。
    除特殊说明的以外，其余均为只读的。
'''
0、HttpRequest.scheme
        表示请求方案的字符串（一般为http 或 https(这是后来加密了的版本)）

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

        可是，若是要处理表单数据的时候，推荐仍是使用 HttpRequest.POST。

        另外，咱们还能够用 Python 的类文件方法来操做它，详情参考 HttpResponse.read()。



二、HttpRequest.path

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

        例如："/music/bands/the_beatles"


三、HttpRequest.method

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

        例如："GET"、"POST"



四、HttpRequest.encoding

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


五、HttpRequest.GET
  
       一个相似于字典的对象，包含 HTTP GET 的全部参数。详情须要参考QueryDict 对象。



六、HttpRequest.POST

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

       POST 请求能够带有空的 POST 字典——若是经过 HTTP POST 方法发送一个表单，可是表单中没有任何的数据， QueryDict 对象依然会被建立。
      所以，不该该使用 if request.POST 来检查使用的是不是 POST 方法；应该使用 if request.method == "POST"

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



七、HttpRequest.COOKIES
    
        一个标准的 Python 字典，包含全部的 cookie。键和值都为字符串。


八、 HttpRequest.FILES

        一个相似于字典的对象，包含全部的上传文件信息。
        FILES 中的每一个键为 <input type="file" name="" />中的 name，值则为对应的数据。
        
        注意，FILES 只有在请求的方法为 POST 且提交的 <form> 带有 enctype="multipart/form-data" 的状况下才会包含数据。不然，FILES 将为一个空的相似于字典的对象。



九、 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            ———— 服务器认证后的用户
        REQUESR_METHOD     ———— 一个字符串，例如 "GET" 或 "POST"
        SERVER_NAME            ———— 服务器的主机名
        SERBER_PORT            ———— 服务器的端口（是一个字符串）
        
        从上面能够看到，除 CONTENT_LENGTH 和 CONTENT_TYPE 以外，请求中的任何 HTTP 首部转换为 META 的键时，都会将全部字母大写并将链接符替换为下划线最后加上 HTTP_  前缀。因此，一个叫作 X-Bender 的头部将转换成 META 中的 HTTP_X_BENDER 键。


十、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
    geoups 和 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。




十一、HttpRequest.session

     一个既可读又可写的相似于字典的对象，表示当前的会话。只有当Django 启用会话的支持时才可用。


'''

上传文件示例

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_FORWARDE_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_singned_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("hobby")

Response对象

与由Django自动建立的 HttpRequest 对象相比，HttpResponse 对象是外面的职责范围了。咱们写的每一个视图都须要实例化，填充和返回一个 HttpResponse。

HttpResponse 类位于django.http 模块中。

一、使用

传递字符串

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 = HttpResponse()
response['Content-type'] = 'text/html; charset = utf8'
del response['Content-Type']

2.属性

HttpResponse.content: 响应内容

HttpResponse.charset: 响应内容的编码

HttpResponse.status_code: 响应的状态码

JsonResponse对象

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

from django.http import JsonReaponse

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

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

默认只能传递字典类型，若是要传递非字典类型须要设置一下 safe 关键字参数。

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

Django shortcut functions

一、render()

render(request, template_name[, context])

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

其默认的Content-type 标头设置为 application/json。

参数：

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

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

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

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

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

一个简单的例子：

from django.shortcuts import render

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

上面的代码等于：

from django.http import HttpResponse
from diango.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相关）

将调用 get_absolute_url() 方法来获取重定向的 URL：

from django.shortcuts import redirect

def my_view(request):
    ...
    object = MyModel.object.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.object.get(.....)
    return redirect(objct, permanent=True)

扩展阅读：

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

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

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