Tar 文件用于将多个文件收集到一个存档中。它们是为磁带录音机开发的,因此提供顺序写入和读取。
使用 Django 可以将文件流式传输到浏览器FileResponse() https://docs.djangoproject.com/en/3.1/ref/request-response/#fileresponse-objects,它可以使用生成器作为参数。
如果我们为它提供一个生成器,将 tar 文件与用户请求的数据组合在一起,那么 tar 文件就会及时生成。然而 python 内置tarfile https://docs.python.org/3/library/tarfile.html-module 不提供这种开箱即用的功能。
然而我们可以利用tarfile
能够传入类似文件的对象来自己处理存档的组装。因此我们可以创建一个BytesIO() https://docs.python.org/3/library/io.htmltarfile 将逐步写入并将其内容刷新到 Django 的对象FileResponse()
方法。为此,我们需要实现一些方法FileResponse()
and tarfile
期望访问。让我们创建一个类FileStream
:
class FileStream:
def __init__(self):
self.buffer = BytesIO()
self.offset = 0
def write(self, s):
self.buffer.write(s)
self.offset += len(s)
def tell(self):
return self.offset
def close(self):
self.buffer.close()
def pop(self):
s = self.buffer.getvalue()
self.buffer.close()
self.buffer = BytesIO()
return s
现在当我们write()
数据到FileStream
的缓冲区和yield FileStream.pop()
Django 会立即将该数据发送给用户。
作为数据,我们现在想要组装该 tar 文件。在里面FileStream
类中我们添加另一个方法:
@classmethod
def yield_tar(cls, file_data_iterable):
stream = FileStream()
tar = tarfile.TarFile.open(mode='w|', fileobj=stream, bufsize=tarfile.BLOCKSIZE)
这创建了一个FileStream
-内存中的实例和文件句柄。文件句柄访问FileStream
- 读取和写入数据的实例,而不是磁盘上的文件。
现在在 tar 文件中我们首先必须添加tarfile.TarInfo()
表示顺序写入数据的标头的对象,其中包含文件名、大小和修改时间等信息。
for file_name, file_size, file_date, file_data in file_data_iterable:
tar_info = tarfile.TarInfo(file_name)
tar_info.size = int(file_size)
tar_info.mtime = file_date
tar.addfile(tar_info)
yield stream.pop()
您还可以查看将任何数据传递给该方法的结构。 file_data_iterable 是包含以下内容的元组列表
((str) file_name, (int/str) file_size, (str) unix_timestamp, (bytes) file_data)
.
发送 TarInfo 后,迭代 file_data。该数据需要是可迭代的。例如你可以使用requests.response
您检索的对象requests.get(url, stream=True)
.
for chunk in (requests.get(url, stream=True).iter_content(chunk_size=cls.RECORDSIZE)):
# you can freely choose that chunk size, but this gives me good performance
tar.fileobj.write(chunk)
yield stream.pop()
注意:这里我使用了变量url
请求文件。你需要通过它而不是file_data
在元组参数内。如果您选择传递可迭代文件,则需要更新此行。
最后,tar 文件需要特殊的格式来指示文件已完成。 Tarfile 由块和记录组成。通常一个块包含512字节,一条记录包含20个块(20*512字节=10240字节)。首先,包含最后一个文件数据块的最后一个块用 NUL(通常是纯零)填充,然后下一个文件的下一个 TarInfo 标头开始。
要结束存档,当前记录将被 NUL 填充,但必须至少有两个块完全被 NUL 填充。这将由tar.close()
。另请参阅此Wiki https://en.wikipedia.org/wiki/Tar_(computing)#File_format.
blocks, remainder = divmod(tar_info.size, tarfile.BLOCKSIZE)
if remainder > 0:
tar.fileobj.write(tarfile.NUL * (tarfile.BLOCKSIZE - remainder))
yield stream.pop()
blocks += 1
tar.offset += blocks * tarfile.BLOCKSIZE
tar.close()
yield stream.pop()
您现在可以使用FileStream
Django 视图中的类:
from django.http import FileResponse
import FileStream
def stream_files(request, files):
file_data_iterable = [(
file.name,
file.size,
file.date.timestamp(),
file.data
) for file in files]
response = FileReponse(
FileStream.yield_tar(file_data_iterable),
content_type="application/x-tar"
)
response["Content-Disposition"] = 'attachment; filename="streamed.tar"'
return response
如果您想传递 tar 文件的大小以便用户可以看到进度条,您可以提前确定未压缩的 tar 文件的大小。在里面FileStream
类添加另一个方法:
def tarsize(cls, sizes):
# Each file is preceeded with a 512 byte long header
header_size = 512
# Each file will be appended to fill up a block
tar_sizes = [ceil((header_size + size) / tarfile.BLOCKSIZE)
* tarfile.BLOCKSIZE for size in sizes]
# the end of the archive is marked by at least two consecutive
# zero filled blocks, and the final record block is filled up with
# zeros.
sum_size = sum(tar_sizes)
remainder = cls.RECORDSIZE - (sum_size % cls.RECORDSIZE)
if remainder < 2 * tarfile.BLOCKSIZE:
sum_size += cls.RECORDSIZE
total_size = sum_size + remainder
assert total_size % cls.RECORDSIZE == 0
return total_size
并使用它来设置响应标头:
tar_size = FileStream.tarsize([file.size for file in files])
...
response["Content-Length"] = tar_size
非常感谢chipx86 https://gist.github.com/chipx86/9598b1e4a9a1a7831054 and allista https://gist.github.com/allista/d3dc1984212d3d033eb29c78914e5887他们的要点对我完成这项任务有很大帮助。