Django 中的 PDF 响应存在错误的编码 – xhtml2pdf

在本文中，我们将介绍 Django 中的一个常见问题 – PDF 响应的编码错误，以及如何使用 xhtml2pdf 解决这个问题。

问题描述

在使用 Django 构建网站时，我们有时需要生成 PDF 文件并将其作为响应发送给用户。这在生成报表、发票、合同等场景中特别有用。Django 提供了多种方法来实现这一目标，其中一个是使用第三方库 xhtml2pdf。但是，在使用 xhtml2pdf 生成 PDF 文件时，有时会遇到编码错误。

具体问题表现为，生成的 PDF 文件中的中文字符显示为乱码或者缺失。这是因为默认的编码方式不支持中文字符。

解决方案

安装依赖项

首先，我们需要安装必要的依赖项。在命令行中运行以下命令：

pip install xhtml2pdf

这将自动安装 xhtml2pdf 及其依赖项。

设置编码

要解决编码问题，我们需要设置正确的编码。在 Django 的设置文件（settings.py）中，找到 TEMPLATES 部分，并在 'OPTIONS' 中添加以下代码：

'OPTIONS': {
    'auto_reload': True,
    'encoding': 'utf-8',
},

这将告诉 Django 使用 UTF-8 编码处理模板文件。

创建 PDF 响应

现在，我们可以创建一个视图来生成 PDF 响应。假设我们有一个视图函数 generate_pdf，它使用 xhtml2pdf 来生成 PDF 文件：

from django.http import HttpResponse
from django.template.loader import get_template
from xhtml2pdf import pisa

def generate_pdf(request):
    # 获取模板文件
    template = get_template('path/to/template.html')

    # 渲染模板
    html = template.render({})

    # 创建 PDF 源文件
    result = StringIO()
    pdf = pisa.pisaDocument(StringIO(html.encode("UTF-8")), result)

    if not pdf.err:
        # 生成 PDF 响应
        response = HttpResponse(result.getvalue(), content_type='application/pdf')
        response['Content-Disposition'] = 'attachment; filename="my_pdf.pdf"'
        return response

    return HttpResponse('Error generating PDF', status=500)

在上述代码中，我们首先获取模板文件并进行渲染。然后，我们使用 xhtml2pdf 的 pisaDocument 函数将 HTML 字符串转换为 PDF，并将结果写入 StringIO 对象中。如果生成 PDF 成功，我们将创建一个带有 PDF 内容的 HttpResponse，并设置正确的 Content-Disposition 头部以允许文件下载。否则，我们返回一个错误响应。

配置静态文件

如果模板文件中引用了静态文件（例如 CSS、JavaScript），我们还需要为这些静态文件配置正确的 URL。在 Django 的设置文件（settings.py）中，找到 STATIC_URL 部分，并添加以下代码：

STATIC_URL = '/static/'

# 配置静态文件处理器
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'static'),
]

这将告诉 Django 在请求中查找静态文件的位置。

使用示例

下面是一个使用 xhtml2pdf 生成 PDF 响应的例子。假设我们有一个简单的模板文件 template.html，其内容如下：

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>My PDF</title>
    <style>
        body {
            font-family: Arial, sans-serif;
        }
    </style>
</head>
<body>
    <h1>Hello, world!</h1>
    <p>This is a sample PDF generated using xhtml2pdf in Django.</p>
</body>
</html>

我们可以创建一个 URL 路由，将 /generate-pdf 映射到视图函数 generate_pdf，然后通过访问该 URL 来生成并下载 PDF 文件：

from django.urls import path
from .views import generate_pdf

urlpatterns = [
    # other URL patterns...
    path('generate-pdf/', generate_pdf, name='generate_pdf')
]

总结

通过使用 xhtml2pdf，我们可以方便地在 Django 中生成 PDF 文件并将其作为响应发送给用户。然而，在生成 PDF 响应时，我们需要注意编码问题，以确保中文字符正确显示。通过设置编码为 UTF-8，并使用 xhtml2pdf 的 pisaDocument 函数来处理编码，我们可以轻松解决编码问题，并生成正确的 PDF 响应。同时，我们还可以配置静态文件处理器，以处理模板中引用的静态文件。希望本文对你在 Django 中处理 PDF 响应的编码问题有所帮助。