从 Django 服务器一次传输多个文件

Question

我正在运行 Django 服务器来为受保护网络中的另一台服务器提供文件。当用户请求一次访问多个文件时，我希望 Django 服务器将这些文件一次性传输给该用户。

由于在浏览器中一次下载多个文件并不容易，因此需要以某种方式捆绑文件。我不希望我的服务器必须先下载所有文件，然后提供现成的捆绑文件，因为这会增加较大文件的大量时间损失。对于 zips，我的理解是它在组装时无法进行流式传输。

有没有什么方法可以在远程服务器的第一个字节可用时立即开始流式传输容器？

Answer 1

Tar 文件用于将多个文件收集到一个存档中。它们是为磁带录音机开发的，因此提供顺序写入和读取。

使用 Django 可以将文件流式传输到浏览器FileResponse()，它可以将生成器作为参数。

如果我们为它提供一个生成器，将 tar 文件与用户请求的数据组合在一起，那么 tar 文件就会及时生成。然而 python 的内置tarfile模块并不提供这种开箱即用的功能。

然而，我们可以利用 的tarfile功能来传入类似 File 的对象来自己处理存档的组装。因此，我们可以创建一个BytesIO()对象，tarfile 将逐渐写入该对象并将其内容刷新到 Django 的FileResponse()方法。为此，我们需要实现一些FileResponse()需要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我们添加另一个方法：

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

这会FileStream在内存中创建一个实例和一个文件句柄。文件句柄访问FileStream实例来读取和写入数据，而不是磁盘上的文件。

现在，在 tar 文件中，我们首先必须添加一个tarfile.TarInfo()对象，该对象代表顺序写入数据的标头，其中包含文件名、大小和修改时间等信息。

    @classmethod
    def yield_tar(cls, file_data_iterable):
        stream = FileStream()
        tar = tarfile.TarFile.open(mode='w|', fileobj=stream, bufsize=tarfile.BLOCKSIZE)

您还可以查看将任何数据传递给该方法的结构。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 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()

注意：这里我使用变量url来请求文件。您需要传递它而不是file_data在元组参数中传递。如果您选择传递可迭代文件，则需要更新此行。

最后，tar 文件需要特殊的格式来指示文件已完成。Tarfile 由块和记录组成。通常一个块包含512字节，一条记录包含20个块（20*512字节=10240字节）。首先，包含最后一个文件数据块的最后一个块用 NUL（通常是纯零）填充，然后下一个文件的下一个 TarInfo 标头开始。

要结束存档，当前记录将被 NUL 填充，但必须至少有两个块完全被 NUL 填充。这将由 处理tar.close()。另请参阅此Wiki。

            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()

FileStream您现在可以在 Django 视图中使用该类：

            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()

如果您想传递 tar 文件的大小以便用户可以看到进度条，您可以提前确定未压缩的 tar 文件的大小。在FileStream类中添加另一个方法：

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

并使用它来设置响应标头：

    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

非常感谢chipx86和allista，他们的要点对我完成这项任务有很大帮助。