如何在 Django 中为用户提供动态生成的 ZIP 存档?
我正在创建一个站点,用户可以在其中选择可用书籍的任意组合并将它们下载为 ZIP 存档。我担心为每个请求生成这样的档案会减慢我的服务器速度。我还听说 Django 目前没有很好的解决方案来提供动态生成的文件。
解决方法如下。
使用 Python 模块zipfile创建 zip 存档,但作为文件指定StringIO对象(ZipFile 构造函数需要类似文件的对象)。添加要压缩的文件。然后在您的 Django 应用程序中返回 StringIO 对象的内容,并将HttpResponse
mimetype 设置为application/x-zip-compressed
(或至少application/octet-stream
)。如果你愿意,你可以设置content-disposition
标题,但这不应该是真正需要的。
但请注意,在每个请求上创建 zip 存档是个坏主意,这可能会杀死您的服务器(如果存档很大,则不计算超时)。性能方面的方法是将生成的输出缓存在文件系统中的某处,并仅在源文件发生更改时重新生成它。更好的主意是提前准备档案(例如,通过 cron 作业)并让您的 Web 服务器像往常一样为它们提供服务。
这是执行此操作的 Django 视图:
import os
import zipfile
import StringIO
from django.http import HttpResponse
def getfiles(request):
# Files (local path) to put in the .zip
# FIXME: Change this (get paths from DB etc)
filenames = ["/tmp/file1.txt", "/tmp/file2.txt"]
# Folder name in ZIP archive which contains the above files
# E.g [thearchive.zip]/somefiles/file2.txt
# FIXME: Set this to something better
zip_subdir = "somefiles"
zip_filename = "%s.zip" % zip_subdir
# Open StringIO to grab in-memory ZIP contents
s = StringIO.StringIO()
# The zip compressor
zf = zipfile.ZipFile(s, "w")
for fpath in filenames:
# Calculate path for file in zip
fdir, fname = os.path.split(fpath)
zip_path = os.path.join(zip_subdir, fname)
# Add file, at correct path
zf.write(fpath, zip_path)
# Must close zip for all contents to be written
zf.close()
# Grab ZIP file from in-memory, make response with correct MIME-type
resp = HttpResponse(s.getvalue(), mimetype = "application/x-zip-compressed")
# ..and correct content-disposition
resp['Content-Disposition'] = 'attachment; filename=%s' % zip_filename
return resp
这里的许多答案建议使用 aStringIO
或BytesIO
缓冲区。然而,这不是必需的,因为HttpResponse
它已经是一个类似文件的对象:
response = HttpResponse(content_type='application/zip')
zip_file = zipfile.ZipFile(response, 'w')
for filename in filenames:
zip_file.write(filename)
response['Content-Disposition'] = 'attachment; filename={}'.format(zipfile_name)
return response
我使用了 Django 2.0和Python 3.6。
import zipfile
import os
from io import BytesIO
def download_zip_file(request):
filelist = ["path/to/file-11.txt", "path/to/file-22.txt"]
byte_data = BytesIO()
zip_file = zipfile.ZipFile(byte_data, "w")
for file in filelist:
filename = os.path.basename(os.path.normpath(file))
zip_file.write(file, filename)
zip_file.close()
response = HttpResponse(byte_data.getvalue(), content_type='application/zip')
response['Content-Disposition'] = 'attachment; filename=files.zip'
# Print list files in zip_file
zip_file.printdir()
return response
对于 python3,我使用io.ByteIO,因为不推荐使用StringIO来实现这一点。希望能帮助到你。
import io
def my_downloadable_zip(request):
zip_io = io.BytesIO()
with zipfile.ZipFile(zip_io, mode='w', compression=zipfile.ZIP_DEFLATED) as backup_zip:
backup_zip.write('file_name_loc_to_zip') # u can also make use of list of filename location
# and do some iteration over it
response = HttpResponse(zip_io.getvalue(), content_type='application/x-zip-compressed')
response['Content-Disposition'] = 'attachment; filename=%s' % 'your_zipfilename' + ".zip"
response['Content-Length'] = zip_io.tell()
return response
无耻插件:您可以将django-zipview用于相同目的。
之后pip install django-zipview
:
from zipview.views import BaseZipView
from reviews import Review
class CommentsArchiveView(BaseZipView):
"""Download at once all comments for a review."""
def get_files(self):
document_key = self.kwargs.get('document_key')
reviews = Review.objects \
.filter(document__document_key=document_key) \
.exclude(comments__isnull=True)
return [review.comments.file for review in reviews if review.comments.name]
我建议使用单独的模型来存储这些临时 zip 文件。您可以即时创建 zip,使用文件字段保存到模型,最后将 url 发送给用户。
好处:
已经对这个主题做出了很多贡献,但是自从我第一次研究这个问题时遇到了这个线程,我想我会添加我自己的两分钱。
集成您自己的 zip 创建可能不如 Web 服务器级解决方案强大和优化。同时,我们使用的是 Nginx,它没有开箱即用的模块。
但是,您可以使用 mod_zip 模块编译 Nginx(请参阅此处以获取具有最新稳定 Nginx 版本的 docker 映像,以及使其小于默认 Nginx 映像的 alpine 基础)。这增加了 zip 流功能。
然后 Django 只需要提供一个要压缩的文件列表,就完成了!为这个文件列表响应使用一个库更可重用,而 django-zip-stream 提供了这一点。
遗憾的是,它从来没有真正对我有用,所以我开始了一个带有修复和改进的分支。
您可以在几行中使用它:
def download_view(request, name=""):
from django_zip_stream.responses import FolderZipResponse
path = settings.STATIC_ROOT
path = os.path.join(path, name)
return FolderZipResponse(path)
您需要一种方法让 Nginx 为您要归档的所有文件提供服务,但仅此而已。
你不能只写一个“压缩服务器”的链接或诸如此类的东西吗?为什么 zip 存档本身需要从 Django 提供?一个 90 年代的 CGI 脚本生成一个 zip 并将其发送到标准输出是这里真正需要的,至少据我所知。