解决 Django xhtml2pdf 在 Linux 下渲染 PDF 时静态文件图像连接被拒的问题

Linux

2024-03-03 15:35:09

部署 Django 项目到 Linux 服务器时，经常会遇到静态文件图像无法在使用 xhtml2pdf 渲染 PDF 报告时显示的问题。本文将深入探讨这一问题，分析其潜在原因，并提供有效的解决方案。

问题分析

在 Django 项目中，静态文件通常通过 HTML 中的 <img> 标签引用，如 <img src="/static/logo.png">。然而，在 Linux 服务器上，xhtml2pdf 却无法正确加载这些图像。

影响因素

影响该问题的因素包括：

Apache2 配置：服务器配置可能限制对静态文件的访问。
Django URL 配置：Django URL 设置可能未正确定义静态文件路径。
xhtml2pdf 连接：xhtml2pdf 需要通过网络访问图像 URL，这可能会受到防火墙或代理配置的影响。

解决步骤

1. 检查 Apache2 配置

确保 Apache2 配置允许访问静态文件目录。

sudo nano /etc/apache2/sites-available/000-default.conf

在配置文件中添加以下内容：

Alias /static /path/to/your/static/files
<Directory /path/to/your/static/files>
    Require all granted
</Directory>

然后重启 Apache2 服务：

sudo systemctl restart apache2

2. 验证 Django URL 配置

确认 Django 项目的 settings.py 文件中的静态文件路径配置正确。

# settings.py
STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR, 'static')
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'my_app/static'),
]

3. 检查 xhtml2pdf 连接

确保 xhtml2pdf 能够通过网络访问图像 URL。如果使用了代理，请配置 xhtml2pdf 使用代理。

import xhtml2pdf.pisa as pisa

def render_pdf(html, filename):
    result_file = open(filename, "w+b")
    pisa.CreatePDF(
        html,
        dest=result_file,
        encoding='UTF-8',
    )
    result_file.close()

4. 查看日志文件

检查 xhtml2pdf 和 Django 的日志文件，以获取有关错误的详细信息。

tail -f /var/log/apache2/error.log
tail -f /path/to/your/django/project/logs/django.log

示例代码

以下示例代码展示了如何在 Django 中配置静态文件和 xhtml2pdf：

# Django settings.py
STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR, 'static')
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'my_app/static'),
]

# xhtml2pdf.py
import xhtml2pdf.pisa as pisa

def render_pdf(html, filename):
    result_file = open(filename, "w+b")
    pisa.CreatePDF(
        html,
        dest=result_file,
        encoding='UTF-8',
    )
    result_file.close()