Django6—视图进阶_djbqko0n6jiro4vb

    return redirect(reverse("user:login"))

## Request/Response对象


Django使用请求和响应对象在系统中传递状态。


当请求页面时，Django创建一个HttpRequest对象，其中包含有关请求的元数据。然后Django加载适当的视图，将HttpRequest作为第一个参数传递给view函数。每个视图负责返回一个HttpResponse对象。


本文档介绍了 模块中定义的APIHttpRequest和 HttpResponse对象的API django.http。  
 `from django.http.request import HttpRequest`  
 `from django.http.response import HttpResponse`  
 `from django.http import HttpResponse, JsonResponse, HttpRequest`


### Request


#### 常用属性


* path：请求服务器的完整“路径”，但不包含域名和参数。比如http://www.baidu.com/xxx/yyy/，那么path就是/xxx/yyy/。
* method：代表当前请求的http方法。比如是GET还是POST。
* GET：一个django.http.request.QueryDict对象。操作起来类似于字典。这个属性中包含了所有以?xxx=xxx的方式上传上来的参数。
* POST：也是一个django.http.request.QueryDict对象。这个属性中包含了所有以POST方式上传上来的参数。
* FILES：也是一个django.http.request.QueryDict对象。这个属性中包含了所有上传的文件。
* COOKIES：一个标准的Python字典，包含所有的cookie，键值对都是字符串类型。
* session：一个类似于字典的对象。用来操作服务器的session。
* META：存储的客户端发送上来的所有header信息。
* CONTENT\_LENGTH：请求的正文的长度（是一个字符串）。
* CONTENT\_TYPE：请求的正文的MIME类型。
* HTTP\_ACCEPT：响应可接收的Content-Type。
* HTTP\_ACCEPT\_ENCODING：响应可接收的编码。
* HTTP\_ACCEPT\_LANGUAGE： 响应可接收的语言。
* HTTP\_HOST：客户端发送的HOST值。
* HTTP\_REFERER：在访问这个页面上一个页面的url。
* QUERY\_STRING：单个字符串形式的查询字符串（未解析过的形式）。
* REMOTE\_ADDR：客户端的IP地址。如果服务器使用了nginx做反向代理或者负载均衡，那么这个值返回的是127.0.0.1，这时候可以使用- - HTTP\_X\_FORWARDED\_FOR来获取，所以获取ip地址的代码片段如下：

 

if request.META.has_key(‘HTTP_X_FORWARDED_FOR’):
ip = request.META[‘HTTP_X_FORWARDED_FOR’]
else:
ip = request.META[‘REMOTE_ADDR’]

* REMOTE\_HOST：客户端的主机名。
* REQUEST\_METHOD：请求方法。一个字符串类似于GET或者POST。
* SERVER\_NAME：服务器域名。
* SERVER\_PORT：服务器端口号，是一个字符串类型。


#### 常用方法


* is\_secure()：是否是采用https协议。
* is\_ajax()：是否采用ajax发送的请求。原理就是判断请求头中是否存在X-Requested-With:XMLHttpRequest。
* get\_host()：服务器的域名。如果在访问的时候还有端口号，那么会加上端口号。比如www.baidu.com:9000。
* get\_full\_path()：返回完整的path。如果有查询字符串，还会加上查询字符串。比如/music/bands/?print=True。
* get\_raw\_uri()：获取请求的完整url。


#### QueryDict对象


我们平时用的request.GET和request.POST都是QueryDict对象，这个对象继承自dict，因此用法跟dict相差无几。其中用得比较多的是get方法和getlist方法。


* get方法：用来获取指定key的值，如果没有这个key，那么会返回None。
* getlist方法：如果浏览器上传上来的key对应的值有多个，那么就需要通过这个方法获取。


### Response


#### 常用属性


* content：返回的内容。
* status\_code：返回的HTTP响应状态码。
* content\_type：返回的数据的MIME类型，默认为text/html。浏览器会根据这个属性，来显示数据。如果是text/html，那么就会解析这个字符串，如果text/plain，那么就会显示一个纯文本。常用的Content-Type如下：
	+ text/html（默认的，html文件）
	+ text/plain（纯文本）
	+ text/css（css文件）
	+ text/javascript（js文件）
	+ multipart/form-data（文件提交）
	+ application/json（json传输）
	+ application/xml（xml文件）
* 设置请求头：response[‘X-Access-Token’] = ‘xxxx’。


#### 常用方法


* set\_cookie：用来设置cookie信息。后面讲到授权的时候会着重讲到。
* delete\_cookie：用来删除cookie信息。
* write：HttpResponse是一个类似于文件的对象，可以用来写入数据到数据体（content）中。


#### JsonResponse类


用来对象dump成json字符串，然后返回将json字符串封装成Response对象返回给浏览器。并且他的Content-Type是application/json。示例代码如下：

from django.http import JsonResponse
def index(request):
return JsonResponse({“username”:“zhiliao”,“age”:18})

默认情况下JsonResponse只能对字典进行dump，如果想要对非字典的数据进行dump，那么需要给JsonResponse传递一个safe=False参数。示例代码如下：

from django.http import JsonResponse
def index(request):
persons = [‘张三’,‘李四’,‘王五’]
return HttpResponse(persons)

以上代码会报错，应该在使用HttpResponse的时候，传入一个safe=False参数，示例代码如下：

return HttpResponse(persons,safe=False)

`部分源码`

class JsonResponse(HttpResponse):
“”"
An HTTP response class that consumes data to be serialized to JSON.

:param data: Data to be dumped into json. By default only dict objects
are allowed to be passed due to a security flaw before EcmaScript 5. See
the safe parameter for more information.
:param encoder: Should be a json encoder class. Defaults to
django.core.serializers.json.DjangoJSONEncoder.
:param safe: Controls if only dict objects may be serialized. Defaults
to True.
:param json_dumps_params: A dictionary of kwargs passed to json.dumps().
“”"

def \_\_init\_\_(self, data, encoder=DjangoJSONEncoder, safe=True,
             json_dumps_params=None, \*\*kwargs):
    if safe and not isinstance(data, dict):
        raise TypeError(
            'In order to allow non-dict objects to be serialized set the '
            'safe parameter to False.'
        )
    if json_dumps_params is None:
        json_dumps_params = {}
    kwargs.setdefault('content\_type', 'application/json')
    data = json.dumps(data, cls=encoder, \*\*json_dumps_params)
    super().__init__(content=data, \*\*kwargs)

## CSV文件生成


### 小的CSV文件


这里将用一个生成小的CSV文件为例，来把生成CSV文件的技术要点讲到位。我们用Python内置的csv模块来处理csv文件，并且使用HttpResponse来将csv文件返回回去。示例代码如下：

import csv
from django.http import HttpResponse

def csv_view(request):
response = HttpResponse(content_type=‘text/csv’)
response[‘Content-Disposition’] = ‘attachment; filename=“somefilename.csv”’

writer = csv.writer(response)
writer.writerow(['username', 'age', 'height', 'weight'])
writer.writerow(['zhiliao', '18', '180', '110'])

return response

这里再来对每个部分的代码进行解释：


* 我们在初始化HttpResponse的时候，指定了Content-Type为text/csv，这将告诉浏览器，这是一个csv格式的文件而不是一个HTML格式的文件，如果用默认值，默认值就是html，那么浏览器将把csv格式的文件按照html格式输出，这肯定不是我们想要的。
* 第二个我们还在response中添加一个Content-Disposition头，这个东西是用来告诉浏览器该如何处理这个文件，我们给这个头的值设置为attachment;，那么浏览器将不会对这个文件进行显示，而是作为附件的形式下载，第二个filename="somefilename.csv"是用来指定这个csv文件的名字。
* 我们使用csv模块的writer方法，将相应的数据写入到response中。


### CSV文件定义为模板


我们还可以将csv格式的文件定义成模板，然后使用Django内置的模板系统，并给这个模板传入一个Context对象，这样模板系统就会根据传入的Context对象，生成具体的csv文件。示例代码如下：


模板文件

{% for row in data %}“{{ row.0|addslashes }}”, “{{ row.1|addslashes }}”, “{{ row.2|addslashes }}”, “{{ row.3|addslashes }}”, “{{ row.4|addslashes }}”
{% endfor %}

视图函数：

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

def some_view(request):
response = HttpResponse(content_type=‘text/csv’)
response[‘Content-Disposition’] = ‘attachment; filename=“somefilename.csv”’

csv_data = (
    ('First row', 'Foo', 'Bar', 'Baz'),
    ('Second row', 'A', 'B', 'C', '"Testing"', "Here's a quote"),
)

t = loader.get_template('my\_template\_name.txt')
response.write(t.render({"data": csv_data}))
return response

### 生成大的CSV文件


以上的例子是生成的一个小的csv文件，如果想要生成大型的csv文件，那么以上方式将有可能会发生超时的情况（服务器要生成一个大型csv文件，需要的时间可能会超过浏览器默认的超时时间）。这时候我们可以借助另外一个类，叫做StreamingHttpResponse对象，这个对象是将响应的数据作为一个流返回给客户端，而不是作为一个整体返回。示例代码如下：

class Echo:
“”"
定义一个可以执行写操作的类，以后调用csv.writer的时候，就会执行这个方法
“”"
def write(self, value):
return value

def large_csv(request):
rows = ([“Row {}”.format(idx), str(idx)] for idx in range(655360))
pseudo_buffer = Echo()
writer = csv.writer(pseudo_buffer)
response = StreamingHttpResponse((writer.writerow(row) for row in rows),content_type=“text/csv”)
response[‘Content-Disposition’] = ‘attachment; filename=“somefilename.csv”’
return response

这里我们构建了一个非常大的数据集rows，并且将其变成一个迭代器。然后因为StreamingHttpResponse的第一个参数只能是一个生成器，因此我们使用圆括号(writer.writerow(row) for row in rows)，并且因为我们要写的文件是csv格式的文件，因此需要调用writer.writerow将row变成一个csv格式的字符串。而调用writer.writerow又需要一个中间的容器，因此这里我们定义了一个非常简单的类Echo，这个类只实现一个write方法，以后在执行csv.writer(pseudo\_buffer)的时候，就会调用Echo.writer方法。  
 **注意：StreamingHttpResponse会启动一个进程来和客户端保持长连接，所以会很消耗资源。所以如果不是特殊要求，尽量少用这种方法。**


**关于StreamingHttpResponse：**  
 这个类是专门用来处理流数据的。使得在处理一些大型文件的时候，不会因为服务器处理时间过长而到时连接超时。这个类不是继承自HttpResponse，并且跟HttpResponse对比有以下几点区别：


* 这个类没有属性content，相反是streaming\_content。
* 这个类的streaming\_content必须是一个可以迭代的对象。
* 这个类没有write方法，如果给这个类的对象写入数据将会报错。


`注意：StreamingHttpResponse会启动一个进程来和客户端保持长连接，所以会很消耗资源。所以如果不是特殊要求，尽量少用这种方法。`


## 类视图


思维导图：<https://processon.com/mindmap/5ff51eff1e08531de81e65c4>  
 ![在这里插入图片描述](https://img-blog.csdnimg.cn/20210106102722451.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2NTgxOTYx,size_16,color_FFFFFF,t_70)


### View


`django.views.generic.base.View`是主要的类视图，所有的类视图都是继承自他。如果我们写自己的类视图，也可以继承自他。然后再根据当前请求的method，来实现不同的方法。比如这个视图只能使用get的方式来请求，那么就可以在这个类中定义get(self,request,\*args,\*\*kwargs)方法。以此类推，如果只需要实现post方法，那么就只需要在类中实现post(self,request,\*args,\*\*kwargs)。示例代码如下：

from django.views import View
class BookDetailView(View):
def get(self,request,*args,**kwargs):
return render(request,‘detail.html’)

类视图写完后，还应该在urls.py中进行映射，映射的时候就需要调用View的类方法`as_view()`来进行转换。示例代码如下：

urlpatterns = [
path(“detail/<book_id>/”,views.BookDetailView.as_view(),name=‘detail’)
]

除了get方法，View还支持以下方法[‘get’,‘post’,‘put’,‘patch’,‘delete’,‘head’,‘options’,‘trace’]。


如果用户访问了View中没有定义的方法。比如你的类视图只支持get方法，而出现了post方法，那么就会把这个请求转发给http\_method\_not\_allowed(request,\*args,\*\*kwargs)。示例代码如下：

class AddBookView(View):
def post(self,request,*args,**kwargs):
return HttpResponse(“书籍添加成功！”)

def http\_method\_not\_allowed(self, request, \*args, \*\*kwargs):
    return HttpResponse("您当前采用的method是：%s，本视图只支持使用post请求！" % request.method)

urls.py中的映射如下：

path(“addbook/”,views.AddBookView.as_view(),name=‘add_book’)

如果你在浏览器中访问addbook/，因为浏览器访问采用的是get方法，而addbook只支持post方法，因此以上视图会返回您当前采用的method是：GET，本视图只支持使用post请求！。


其实不管是get请求还是post请求，都会走dispatch(request,\*args,\*\*kwargs)方法，所以如果实现这个方法，将能够对所有请求都处理到。


### TemplateView


`django.views.generic.base.TemplateView`，这个类视图是专门用来返回模版的。在这个类中，有两个属性是经常需要用到的，一个是template\_name，这个属性是用来存储模版的路径，TemplateView会自动的渲染这个变量指向的模版。另外一个是get\_context\_data，这个方法是用来返回上下文数据的，也就是在给模版传的参数的。示例代码如下：

from django.views.generic.base import TemplateView

class HomePageView(TemplateView):

template_name = "home.html"

def get\_context\_data(self, \*\*kwargs):
    context = super().get_context_data(\*\*kwargs)
    context['username'] = "黄勇"
    return context

在urls.py中的映射代码如下：

from django.urls import path

from myapp.views import HomePageView

urlpatterns = [
path(‘’, HomePageView.as_view(), name=‘home’),
]

如果在模版中不需要传递任何参数，那么可以直接只在urls.py中使用TemplateView来渲染模版。示例代码如下：

from django.urls import path
from django.views.generic import TemplateView

urlpatterns = [
path(‘about/’, TemplateView.as_view(template_name=“about.html”)),
]

### ListView


在网站开发中，经常会出现需要列出某个表中的一些数据作为列表展示出来。比如文章列表，图书列表等等。在Django中可以使用ListView来帮我们快速实现这种需求。示例代码如下：

class ArticleListView(ListView):
model = Article
template_name = ‘article_list.html’
paginate_by = 10
context_object_name = ‘articles’
ordering = ‘create_time’
page_kwarg = ‘page’

def get\_context\_data(self, \*\*kwargs):
    context = super(ArticleListView, self).get_context_data(\*\*kwargs)
    print(context)
    return context

def get\_queryset(self):
    return Article.objects.filter(id__lte=89)

对以上代码进行解释：


* 首先ArticleListView是继承自ListView。
* model：重写model类属性，指定这个列表是给哪个模型的。
* template\_name：指定这个列表的模板。
* paginate\_by：指定这个列表一页中展示多少条数据。
* context\_object\_name：指定这个列表模型在模板中的参数名称。
* ordering：指定这个列表的排序方式。
* page\_kwarg：获取第几页的数据的参数名称。默认是page。
* get\_context\_data：获取上下文的数据。
* get\_queryset：如果你提取数据的时候，并不是要把所有数据都返回，那么你可以重写这个方法。将一些不需要展示的数据给过滤掉。


## Paginator和Page类


Paginator和Page类都是用来做分页的。他们在Django中的路径为`django.core.paginator.Paginator`和`django.core.paginator.Page`。以下对这两个类的常用属性和方法做解释：


### Paginator常用属性和方法


* count：总共有多少条数据。
* num\_pages：总共有多少页。
* page\_range：页面的区间。比如有三页，那么就range(1,4)。


### Page常用属性和方法


* has\_next：是否还有下一页。
* has\_previous：是否还有上一页。
* next\_page\_number：下一页的页码。
* previous\_page\_number：上一页的页码。
* number：当前页。
* start\_index：当前这一页的第一条数据的索引值。
* end\_index：当前这一页的最后一条数据的索引值。


`示例代码`

共{{page_list.paginator.count}}条记录 每页{{page_list.paginator.per_page}}条记录 第{{page_list.number}}/{{page_list.paginator.num_pages}}页

• {% ifequal page_list.number 1%}

自定义的方法

def make_paginator(obj,page,num):
paginator = Paginator(obj,num)
try:
obj_list = paginator.page(page)
except PageNotAnInteger:
obj_list = paginator.page(1)
except EmptyPage:
obj_list = paginator.page(paginator.num_pages)
return obj_list,paginator

## 给类视图添加装饰器


在开发中，有时候需要给一些视图添加装饰器。如果用函数视图那么非常简单，只要在函数的上面写上装饰器就可以了。但是如果想要给类添加装饰器，那么可以通过以下两种方式来实现：


### 装饰dispatch方法

from django.utils.decorators import method_decorator

def login_required(func):
def wrapper(request,*args,**kwargs):
if request.GET.get(“username”):
return func(request,*args,**kwargs)
else:
return redirect(reverse(‘index’))
return wrapper

class IndexView(View):
def get(self,request,*args,**kwargs):
return HttpResponse(“index”)

@method_decorator(login_required)
def dispatch(self, request, \*args, \*\*kwargs):
    super(IndexView, self).dispatch(request,\*args,\*\*kwargs)

### 直接装饰在整个类上

from django.utils.decorators import method_decorator
def login_required(func):
def wrapper(request,*args,**kwargs):
if request.GET.get(“username”):
return func(request,*args,**kwargs)
else:
return redirect(reverse(‘login’))
return wrapper