有时候我们做的网站,需要将一些数据,生成有一个CSV文件给浏览器,并且是作为附件的形式下载下来。
生成小的CSV文件:
def index(request):
response = HttpResponse(content_type='text/csv')
# attachment 代表这个csv文件作为一个附件的形式下载
# filename='abc.csv' 指定下载的文件名字
response['Content-Disposition'] = "attachment;filename='abc.csv'"
writer = csv.writer(response)
writer.writerow(['username','age','height', 'weight'])
writer.writerow(['zhiliao','18','180','100']) # 在这里并不会指定文件名字。
return response
代码讲解:
- 我们在初始化HttpResponse的时候,指定了Content-Type为text/csv,这将告诉浏览器,这是一个csv格式的文件而不是一个HTML格式的文件,如果用默认值,默认值就是html,那么浏览器将把csv格式的文件按照html格式输出,这肯定不是我们想要的。
- 第二个我们还在response中添加一个Content-Disposition头,这个东西是用来告诉浏览器该如何处理这个文件,我们给这个头的值设置为attachment;,那么浏览器将不会对这个文件进行显示,而是作为附件的形式下载,第二个filename="abc.csv"是用来指定这个csv文件的名字。
- 我们使用csv模块的writer方法,将相应的数据写入到response中。
将csv文件定义成模板:
我们还可以将csv格式的文件定义成模板,然后使用Django内置的模板系统,并给这个模板传入一个Context
对象,这样模板系统就会根据传入的Context
对象,生成具体的csv文件。示例代码如下:
def template_csv_view(request):
response = HttpResponse(content_type='text/csv')
response['Content-Disposition'] = "attachment;filename='abc.csv'"
context = {
'rows':[
['username', 'age', 'height', 'weight'],
['zhiliao', '18', '180', '100']
]
}
template = loader.get_template('abc.txt')
csv_template = template.render(context)
response.content = csv_template
return response
然后我们在templates文件夹下面新建一个abc.txt
的文件,写入一下代码
{% for row in rows %}{{ row.0 }},{{ row.1 }},{{ row.2 }},{{ row.3 }}
{% endfor %}
注意: 这里for后面不能换行,如果换行了之后那么生成的csv文件就会每写入一行数据,就会空一行。
{% endfor %} 必须换行,否则数据将会全部显示在一行。
生成大的CSV文件:
以上的例子是生成的一个小的csv文件,如果想要生成大型的csv文件,那么以上方式将有可能会发生超时的情况(服务器要生成一个大型csv文件,需要的时间可能会超过浏览器默认的超时时间)。这时候我们可以借助另外一个类,叫做StreamingHttpResponse对象,这个对象是将响应的数据作为一个流返回给客户端,而不是作为一个整体返回。示例
def large_csv_view(request):
response = StreamingHttpResponse(content_type='text/csv')
response['Content-Disposition'] = "attachment;filename='abc.csv'"
rows = ("{},{}\n".format(row,row) for row in range(1,100000))
response.streaming_content = rows
# print(type(rows))
# response = HttpResponse('success')
return response
这里我们构建了一个非常大的数据集rows,并且将其变成一个迭代器。然后因为StreamingHttpResponse的第一个参数只能是一个生成器,因此我们使用圆括号("{},{}\n".format(row,row) for row in range(1,100000))。包裹起来。
注意: StreamingHttpResponse会启动一个进程来和客户端保持长连接,所以会很消耗资源。所以如果不是特殊要求,尽量少用这种方法。
关于StreamingHttpResponse:
这个类是专门用来处理流数据的。使得在处理一些大型文件的时候,不会因为服务器处理时间过长而到时连接超时。这个类不是继承自HttpResponse,并且跟HttpResponse对比有以下几点区别:
- 这个类没有属性content,相反是streaming_content。
- 这个类的streaming_content必须是一个可以迭代的对象。
- 这个类没有write方法,如果给这个类的对象写入数据将会报错。