Django框架-Django视图(views)系统
Django的视图系统
定义:一个视图函数(或类),简称为视图,是一个简单的python函数或类,它接受web请求并且返回web响应。
响应可以是一张网页的html内容,一个重定向,一个404错误,一个xml文档,或一张图片。
无论视图本身包含什么逻辑,都要返回响应,代码写在那里都无所谓,只要它在你当前项目目录下面。为了将代码放在某处,大家预定成俗将视图放在项目project或应用程序app目录中的名为views.py的文件中。
1、每个视图函数,都使用HttpRequest对象作为第一个参数,并且通常称之为request。
2、每个视图函数,都会返回一个HttpResponse对象,其中包含生成的响应。
Django使用请求和响应对象来通过系统传递状态。
当浏览器向服务端请求一个页面是,Django创建一个HttpRequest对象,该对象包含关于请求的元数据,然后,Django加载相应的视图,将这个HttpRequest对象作为第一个参数传递给视图函数,每个视图函数负责返回一个HttpResponse对象。
常见的render,redirect,HttpResponse对象返回的都是一个HttpResponse对象。
Django中视图编码分类
主要分为两类:FBV(创建视图函数)和CBV(创建视图类)
FBV(function based view):就是将业务逻辑写在一个函数中
-----views.py
1 from django.shortcuts import render,Httpresponse,redirect 2 from app_name import models 3 4 def add_class(request): 5 if request.method =='POST': 6 class_name = request.POST.get('class_name') 7 models.Classes.objects.create(name=class_name) 8 return redirect('/class_list/') 9 return render(request,'add_class.html')
----urls.py
1 from app_name from views
2 urlpatterns = [
3 url(r'^addclass/$',views.add_class),]
CBV(class based view): 就是以类的方式写
-----views.py
1 from django.views import View 2 from app_name import models 3 4 class Add_class(View): # 必须继承类View 5 6 def get(self,request): 7 return render(request,'add_class.html') 8 9 10 def post(self,request): 11 class_name = request.POST.get('class_name') 12 models.Classes.objects.create(name=class_name) 13 return tedirect('/class_list/')
使用CBV时,urls.py中也做对应的修改:
1 # urls.py中 2 url(r'^add_class/$', views.AddClass.as_view()),
CBV的流程:
1、views.AddClass.as_view() ===》返回view函数对象
2、请求到来的时候执行view函数
2.1、实例化AddClass,赋值给self
self.reuest= request
2.2、执行self.dispatch方法(AddClass如果有,执行自己的,没有的话执行View的)
2.2.1、判断请求方法是否被允许
通过反射获取到请求方法类型
允许:
handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
不允许:
拿到一个http_method_not_allowed方法
2.2.2、执行获取到的方法类型对应类中定义的方法,get(request,)或post(request,)
2.2.3、得到httpResponse对象对象,返回给self.dispatch
2.2.4、得到HttpResponse对象,返回django处理
给视图加装饰器
1、FBV加装饰器
操作:直接在函数上方加装饰器 @wrapper_name
2、CBV加装饰器
必须导入:from django.utils.decorators import method_decorator
操作:三种方案
2.1、直接在方法上加:
1 @method_decorator(wapper_name) 2 def get(self,request):pass
2.2、给自定义的dispatch方法加:
1 @method_decorator(wrapper_name) 2 def dispatch(self,request,*args,**kwargs)
2.3、给类加
1 # 直接在类上面加 2 @method_decorator(wapper_name, name='post') #给方法post加装饰器 3 @method_decorator(wapper_name, name='get') 4 class AddClass(View) 5 6 注:其实也可以直接给View中的dispatch方法加装饰器,这样同样可以实现给自己类下的所有方法加装饰器(自己未定义dispatch方法时) 7 @method_decorator(wapper_name, name='dispatch') 8 class AddClass(View)
注:为视图加装饰器豁免单个或保护csrf_token: from django.views.decorators.csrf import csrf_exempt,csrf_protect
在FBV可以直接上加@csrf_exempt, 但在CBV上必须在类上加且只能给dispatch方法加。
Requset对象和Respondse对象
request对象
当一个页面被请求时,Django就会船舰一个包含本次请求原信息的HttpReques对象。
Django会将这个对象自动传递给响应的视图函数,一般视图函数预定俗称的使用request参数承接这个对象。
请求相关的常用值
- path_info 返回用户访问的url,不包含域名,仅path不带参数 /index/
- path 同上
- get_full_path() 返回完整路径,不含域名 /midd/index/?wd=333&key=3333
- method 请求中使用的HTTP方法的字符串表示,全大写表示
- GET 包含所有HTTP GET参数的类字典对象
- POST 包含所有HTTP POST参数的类字典对象
- body 请求体,byte类型的request.POST的数据就是从body里面提取到的
- FILES 上传文件,{} 注意form标签加enctype="multipart/form-data"属性
- HTTP_REFERER 跳转到上次访问的页面,用户在未登录前要访问的页面,登录后跳转到该页面, redirect(request.Meta.get('HTTP_REFERER','')
HTTP_REFERER
属性
所有的属性应该被认为是只读的,除非另有说明。
1 属性: 2 django将请求报文中的请求行、头部信息、内容主体封装成 HttpRequest 类中的属性。 3 除了特殊说明的之外,其他均为只读的。 4 5 6 0.HttpRequest.scheme 7 表示请求方案的字符串(通常为http或https) 8 9 1.HttpRequest.body 10 11 一个字符串,代表请求报文的主体。在处理非 HTTP 形式的报文时非常有用,例如:二进制图片、XML,Json等。 12 13 但是,如果要处理表单数据的时候,推荐还是使用 HttpRequest.POST 。 14 15 另外,我们还可以用 python 的类文件方法去操作它,详情参考 HttpRequest.read() 。 16 17 18 19 2.HttpRequest.path 20 21 一个字符串,表示请求的路径组件(不含域名)。 22 23 例如:"/music/bands/the_beatles/" 24 25 26 27 3.HttpRequest.method 28 29 一个字符串,表示请求使用的HTTP 方法。必须使用大写。 30 31 例如:"GET"、"POST" 32 33 34 35 4.HttpRequest.encoding 36 37 一个字符串,表示提交的数据的编码方式(如果为 None 则表示使用 DEFAULT_CHARSET 的设置,默认为 'utf-8')。 38 这个属性是可写的,你可以修改它来修改访问表单数据使用的编码。 39 接下来对属性的任何访问(例如从 GET 或 POST 中读取数据)将使用新的 encoding 值。 40 如果你知道表单数据的编码不是 DEFAULT_CHARSET ,则使用它。 41 42 43 44 5.HttpRequest.GET 45 46 一个类似于字典的对象,包含 HTTP GET 的所有参数。详情请参考 QueryDict 对象。 47 48 49 50 6.HttpRequest.POST 51 52 一个类似于字典的对象,如果请求中包含表单数据,则将这些数据封装成 QueryDict 对象。 53 54 POST 请求可以带有空的 POST 字典 —— 如果通过 HTTP POST 方法发送一个表单,但是表单中没有任何的数据,QueryDict 对象依然会被创建。 55 因此,不应该使用 if request.POST 来检查使用的是否是POST 方法;应该使用 if request.method == "POST" 56 57 另外:如果使用 POST 上传文件的话,文件信息将包含在 FILES 属性中。 58 59 7.HttpRequest.COOKIES 60 61 一个标准的Python 字典,包含所有的cookie。键和值都为字符串。 62 63 64 65 8.HttpRequest.FILES 66 67 一个类似于字典的对象,包含所有的上传文件信息。 68 FILES 中的每个键为<input type="file" name="" /> 中的name,值则为对应的数据。 69 70 注意,FILES 只有在请求的方法为POST 且提交的<form> 带有enctype="multipart/form-data" 的情况下才会 71 包含数据。否则,FILES 将为一个空的类似于字典的对象。 72 73 74 75 9.HttpRequest.META 76 77 一个标准的Python 字典,包含所有的HTTP 首部。具体的头部信息取决于客户端和服务器,下面是一些示例: 78 79 CONTENT_LENGTH —— 请求的正文的长度(是一个字符串)。 80 CONTENT_TYPE —— 请求的正文的MIME 类型。 81 HTTP_ACCEPT —— 响应可接收的Content-Type。 82 HTTP_ACCEPT_ENCODING —— 响应可接收的编码。 83 HTTP_ACCEPT_LANGUAGE —— 响应可接收的语言。 84 HTTP_HOST —— 客服端发送的HTTP Host 头部。 85 HTTP_REFERER —— Referring 页面。 86 HTTP_USER_AGENT —— 客户端的user-agent 字符串。 87 QUERY_STRING —— 单个字符串形式的查询字符串(未解析过的形式)。 88 REMOTE_ADDR —— 客户端的IP 地址。 89 REMOTE_HOST —— 客户端的主机名。 90 REMOTE_USER —— 服务器认证后的用户。 91 REQUEST_METHOD —— 一个字符串,例如"GET" 或"POST"。 92 SERVER_NAME —— 服务器的主机名。 93 SERVER_PORT —— 服务器的端口(是一个字符串)。 94 从上面可以看到,除 CONTENT_LENGTH 和 CONTENT_TYPE 之外,请求中的任何 HTTP 首部转换为 META 的键时, 95 都会将所有字母大写并将连接符替换为下划线最后加上 HTTP_ 前缀。 96 所以,一个叫做 X-Bender 的头部将转换成 META 中的 HTTP_X_BENDER 键。 97 98 99 10.HttpRequest.user 100 101 一个 AUTH_USER_MODEL 类型的对象,表示当前登录的用户。 102 103 如果用户当前没有登录,user 将设置为 django.contrib.auth.models.AnonymousUser 的一个实例。你可以通过 is_authenticated() 区分它们。 104 105 例如: 106 107 if request.user.is_authenticated(): 108 # Do something for logged-in users. 109 else: 110 # Do something for anonymous users. 111 112 113 user 只有当Django 启用 AuthenticationMiddleware 中间件时才可用。 114 115 ------------------------------------------------------------------------------------- 116 117 匿名用户 118 class models.AnonymousUser 119 120 django.contrib.auth.models.AnonymousUser 类实现了django.contrib.auth.models.User 接口,但具有下面几个不同点: 121 122 id 永远为None。 123 username 永远为空字符串。 124 get_username() 永远返回空字符串。 125 is_staff 和 is_superuser 永远为False。 126 is_active 永远为 False。 127 groups 和 user_permissions 永远为空。 128 is_anonymous() 返回True 而不是False。 129 is_authenticated() 返回False 而不是True。 130 set_password()、check_password()、save() 和delete() 引发 NotImplementedError。 131 New in Django 1.8: 132 新增 AnonymousUser.get_username() 以更好地模拟 django.contrib.auth.models.User。 133 134 135 136 11.HttpRequest.session 137 138 一个既可读又可写的类似于字典的对象,表示当前的会话。只有当Django 启用会话的支持时才可用。 139 完整的细节参见会话的文档。
方法
1 1.HttpRequest.get_host() 2 3 根据从HTTP_X_FORWARDED_HOST(如果打开 USE_X_FORWARDED_HOST,默认为False)和 HTTP_HOST 头部信息返回请求的原始主机。 4 如果这两个头部没有提供相应的值,则使用SERVER_NAME 和SERVER_PORT,在PEP 3333 中有详细描述。 5 6 USE_X_FORWARDED_HOST:一个布尔值,用于指定是否优先使用 X-Forwarded-Host 首部,仅在代理设置了该首部的情况下,才可以被使用。 7 8 例如:"127.0.0.1:8000" 9 10 注意:当主机位于多个代理后面时,get_host() 方法将会失败。除非使用中间件重写代理的首部。 11 12 13 14 2.HttpRequest.get_full_path() 15 16 返回 path,如果可以将加上查询字符串。 17 18 例如:"/music/bands/the_beatles/?print=true" 19 20 21 22 3.HttpRequest.get_signed_cookie(key, default=RAISE_ERROR, salt='', max_age=None) 23 24 返回签名过的Cookie 对应的值,如果签名不再合法则返回django.core.signing.BadSignature。 25 26 如果提供 default 参数,将不会引发异常并返回 default 的值。 27 28 可选参数salt 可以用来对安全密钥强力攻击提供额外的保护。max_age 参数用于检查Cookie 对应的时间戳以确保Cookie 的时间不会超过max_age 秒。 29 30 复制代码 31 >>> request.get_signed_cookie('name') 32 'Tony' 33 >>> request.get_signed_cookie('name', salt='name-salt') 34 'Tony' # 假设在设置cookie的时候使用的是相同的salt 35 >>> request.get_signed_cookie('non-existing-cookie') 36 ... 37 KeyError: 'non-existing-cookie' # 没有相应的键时触发异常 38 >>> request.get_signed_cookie('non-existing-cookie', False) 39 False 40 >>> request.get_signed_cookie('cookie-that-was-tampered-with') 41 ... 42 BadSignature: ... 43 >>> request.get_signed_cookie('name', max_age=60) 44 ... 45 SignatureExpired: Signature age 1677.3839159 > 60 seconds 46 >>> request.get_signed_cookie('name', False, max_age=60) 47 False 48 复制代码 49 50 51 52 4.HttpRequest.is_secure() 53 54 如果请求时是安全的,则返回True;即请求通是过 HTTPS 发起的。 55 56 57 58 5.HttpRequest.is_ajax() 59 60 如果请求是通过XMLHttpRequest 发起的,则返回True,方法是检查 HTTP_X_REQUESTED_WITH 相应的首部是否是字符串'XMLHttpRequest'。 61 62 大部分现代的 JavaScript 库都会发送这个头部。如果你编写自己的 XMLHttpRequest 调用(在浏览器端),你必须手工设置这个值来让 is_ajax() 可以工作。 63 64 如果一个响应需要根据请求是否是通过AJAX 发起的,并且你正在使用某种形式的缓存例如Django 的 cache middleware, 65 你应该使用 vary_on_headers('HTTP_X_REQUESTED_WITH') 装饰你的视图以让响应能够正确地缓存。
注意:键值对的值是多个的时候,比如checkbox类型的input标签,select标签,需要用:
request.POST.getlist("hobby")
上传文件示例
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")
Respondse对象
与由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=UTF-8' del response['Content-Type']
属性
HttpResponse.content:响应内容
HttpResponse.charset:响应内容的编码
HttpResponse.status_code:响应的状态码
JsonResponse对象
JsonResponse是HttpResponse的子类,专门用来生成JSON编码的响应。
from django.http import JsonResponse response = JsonResponse({'foo': 'bar'}) print(response.content) b'{"foo": "bar"}'
默认只能传递字典类型,如果要传递非字典类型需要设置一下safe关键字参数。
response = JsonResponse([1, 2, 3], safe=False)
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页面。
小结:
response ——》httpresponse对象
1、HttpResponse(‘字符串’) ----》页面显示字符串内容 【Content-Type : text/html;charset=utf8】
2、render(request,‘模板文件名’,{}) ----》返回一个完整的页面
3、redirect(‘/index/’) 跳转,重定向 Location:/index/
4.JsonResponse(dict) ———》 Content-Type:application/json
重点扩展:
视图分发:在自己的app中建立views文件夹,里面写视图py文件,需要将app中的原views.py删除!