在 Django HttpResponse 响应体中返回 openpyxl 生成的 Excel 文档——源码分析

现在我需要提供一个链接,访问时通过 openpyxl 动态生成一个 Excel 文档,并作为响应体返回。

在这里将动态生成的 Excel 文档保存到服务器,并重定向到静态文件链接显然不是一个合适的做法。

所以我们需要直接将 openpyx 生成的 Excel 文档写入到 Django 的 HttpResponse 对象响应体中。

查阅 openpyxl 的文档以后,并没有找到有用的信息,所以直接从源码入手。

在这篇文章中,我将把源码分析的过程详细的展现出来,并总结出完美的解决方案。

我们先从 openpyxl.workbook.workbook 模块下的 Workbook 类入手,找到平时我们用来保存 Excel 文档的方法。

def save(self, filename):
    """Save the current workbook under the given `filename`.
    Use this function instead of using an `ExcelWriter`.

    .. warning::
    When creating your workbook using `write_only` set to True,
    you will only be able to call this function once. Subsequents attempts to
    modify or save the file will raise an :class:`openpyxl.shared.exc.WorkbookAlreadySaved` exception.
    """
    if self.read_only:
        raise TypeError("""Workbook is read-only""")
    if self.write_only:
        save_dump(self, filename)
    else:
        save_workbook(self, filename)

可以看到在一般情况下调用这个方法时,实际上会调用的是 save_workbook 这个函数,这个函数在 openpyxl.writer.excel 模块中定义。

from openpyxl.writer.excel import save_workbook

那我们就要来看看这个模块里还定义了什么东西。

打开这个文件,突然眼前一亮,这里还定义了一个叫做 save_virtual_workbook 的函数,作者在注释里写到 “Return an in-memory workbook, suitable for a Django response.” ,看来这就是我们要找的东西。

def save_virtual_workbook(workbook,):
    """Return an in-memory workbook, suitable for a Django response."""
    temp_buffer = BytesIO()
    archive = ZipFile(temp_buffer, 'w', ZIP_DEFLATED, allowZip64=True)

    writer = ExcelWriter(workbook, archive)

    try:
        writer.write_data()
    finally:
        archive.close()

    virtual_workbook = temp_buffer.getvalue()
    temp_buffer.close()
    return virtual_workbook

这个函数将 Excel 文档写入到内存,返回一个字节数组。

Django 的 HttpResponse 类构造方法可以接受一个字节数组作为响应体,所以我们可以这样写。

from django.http import HttpResponse
from openpyxl import Workbook
from openpyxl.writer.excel import save_virtual_workbook

workbook = Workbook()

# ......

response = HttpResponse(content=save_virtual_workbook(workbook), content_type='application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')

这样就可以很简单的实现将 Excel 文档写入到响应体中了。

指定中文文件名时遇到问题可以参考我之前的一篇文章 Django 返回流文件时使用中文文件名的问题

但是!还没有结束,我认为还可以有更优雅的解决方案。

查阅 Django 文档,发现在 HttpResponse 类的说明下有这样一句:“you can use response as a file-like object.”,并给了一段示例代码。看来 HttpResponse 对象可以直接作为一个 file-like 对象,像对文件对象一样进行写入操作。

Excel 文档的 .xlsx 文件实际上是一个 ZIP 格式的压缩包,在 openpyxl.writer.excel 模块的 save_workbook 函数中是使用 Python 自带的 zipfile 模块来创建的文件。

archive = ZipFile(filename, 'w', ZIP_DEFLATED, allowZip64=True)

查阅 zipfile 模块文档知道 ZipFile 类构造方法的第一个参数可以接受一个文件路径字符串、path-like 对象或是一个 file-like 对象。

太好了,看来我们可以直接把 Django 的 HttpResponse 对象传入到 ZipFile 的构造方法,让 ZipFile 对象直接往 HttpResponse 的响应体中写入内容。

我们当然可以在调用 openpyxl.writer.excel 模块的 save_workbook 函数时,直接将 HttpResponse 对象传入,就像这样。

from django.http import HttpResponse
from openpyxl import Workbook

workbook = Workbook()

# ......

response = HttpResponse(content_type='application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
workbook.save(response)

但是继续来读 openpyxl 的源码,发现在调用 save_workbook 函数时,创建了一个 ExcelWriter 对象,并调用了它的 save 方法。

def save(self, filename):
    """Write data into the archive."""
    self.write_data()
    self._archive.close()

在 save 方法的最后,调用了我们传入的 HttpResponse 对象的 close 方法,而查阅 Django 源码发现在 HttpResponse 的基类 HttpResponseBase 的 close 方法处注释着,该方法应该由 WSGI 服务器在处理完请求以后调用。

# The WSGI server must call this method upon completion of the request.
# See http://blog.dscpl.com.au/2012/10/obligations-for-calling-close-on.html
def close(self):
    for closable in self._closable_objects:
        try:
            closable.close()
        except Exception:
            pass
    self.closed = True
    signals.request_finished.send(sender=self._handler_class)

所以为了优雅,我们还是把调用 close 方法的工作交还给 WSGI 服务器来做吧。

最终的解决方案

我们来自己实现一个 save_workbook 函数,用于将 openpyxl 的 Workbook 生成 Excel 文档,并写入到 Django 的 HttpResponse 对象响应体中。

from openpyxl.writer.excel import ExcelWriter
from zipfile import ZipFile, ZIP_DEFLATED

def save_workbook_response(workbook, response):
    archive = ZipFile(response, 'w', ZIP_DEFLATED, allowZip64=True)
    writer = ExcelWriter(workbook, archive)
    writer.write_data()

这样,我们只需要在创建 HttpResponse 对象后,调用我们自己实现的 save_workbook_response 函数,将 openpyxl 的 Workbook 对象和 HttpResponse 对象一起传入,就可以生成 Excel 文档并写入到响应体中了。

from django.http import HttpResponse
from openpyxl import Workbook

workbook = Workbook()

# ......

response = HttpResponse(content_type='application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
save_workbook_response(workbook, response)

《在 Django HttpResponse 响应体中返回 openpyxl 生成的 Excel 文档——源码分析》有2个想法

    1. 嗯,是我没写清楚,查看ZipFile类的源码就知道了,ZipFile的close方法中会调用传入的file-like对象的close方法,在这里也就是我们传入的HttpResponse。

发表评论

电子邮件地址不会被公开。