将 BOM 添加到来自 Django 的 XML 响应之前

Question

我使用 Django 的 render_to_response 返回 XML 文档。这个特定的 XML 文档适用于基于 Flash 的图表库。该库要求 XML 文档以 BOM（字节顺序标记）开头。如何让 Django 将 BOM 添加到响应中？

将 BOM 插入到模板中是可行的，但这很不方便，因为每次编辑文件时 Emacs 都会将其删除。

我尝试按如下方式重写 render_to_response ，但失败了，因为 BOM 是 UTF-8 编码的：

def render_to_response(*args, **kwargs):
    bom = kwargs.pop('bom', False)
    httpresponse_kwargs = {'mimetype': kwargs.pop('mimetype', None)}
    s = django.template.loader.render_to_string(*args, **kwargs)
    if bom:
        s = u'\xef\xbb\xbf' + s
    return HttpResponse(s, **httpresponse_kwargs)

Answer 1

您实际上并不是在谈论 BOM（字节顺序标记），因为 UTF-8 没有 BOM。从您的示例代码来看，由于某些无法解释的原因，该库期望文本前面添加 3 个垃圾字节。

您的代码几乎是正确的，但您必须将字节添加为字节，而不是字符。试试这个：

def render_to_response(*args, **kwargs):
    bom = kwargs.pop('bom', False)
    httpresponse_kwargs = {'mimetype': kwargs.pop('mimetype', None)}
    s = django.template.loader.render_to_string(*args, **kwargs)
    if bom:
        s = '\xef\xbb\xbf' + s.encode("utf-8")
    return HttpResponse(s, **httpresponse_kwargs)

Answer 2

该解决方案基于约翰·米利金答案的先前版本，比我接受的解决方案更复杂，但为了完整性我将其包含在此处。首先，定义一个中间件类：

class AddBOMMiddleware(object):
    def process_response(self, request, response):
        import codecs
        if getattr(response, 'bom', False):
            response.content = codecs.BOM_UTF8 + response.content
        return response

将其名称添加到设置中的 MIDDLEWARE_CLASSES 中。然后重新定义 render_to_response：

def render_to_response(*args, **kwargs):
    bom = kwargs.pop('bom', False)
    httpresponse_kwargs = {'mimetype': kwargs.pop('mimetype', None)}
    rendered = django.template.loader.render_to_string(*args, **kwargs)
    response = django.http.HttpResponse(rendered, **httpresponse_kwargs)
    if bom:
        response.bom = True
    return response

现在，您可以执行 render_to_response("foo.xml", mimetype="text/xml", bom=True) 以便将 BOM 添加到特定的反应。

Answer 3

最简单的事情可能是将 Emacs 配置为不删除 BOM。

但 render_to_response 并不是一个复杂的函数。基本上是：

def render_to_response(*args, **kwargs):
    return HttpResponse(loader.render_to_string(*args, **kwargs))

您可以轻松调用 render_to_string 并在前面添加 BOM。