如何在 Flask Web 应用中动态生成并安全提供 PDF 报告

如何在 Flask Web 应用中动态生成并安全提供 PDF 报告

本文详解如何使用 flask 接收用户输入、调用 matplotlib 的 pdfpages 生成多页 pdf,并通过 send_from_directory 安全响应下载请求,避免线程阻塞与路径错误。

本文详解如何使用 flask 接收用户输入、调用 matplotlib 的 pdfpages 生成多页 pdf,并通过 send_from_directory 安全响应下载请求,避免线程阻塞与路径错误。

在 Flask 中动态生成并提供 PDF 文件(如由 matplotlib.backends.backend_pdf.PdfPages 创建的报告),关键在于分离用户交互、文件生成与静态资源分发。原始代码中直接使用 input() 会导致主线程阻塞(尤其在 macOS 上触发 NSWindow drag regions 异常),且硬编码路径、未处理 POST 请求、依赖本地终端输入,完全违背 Web 应用无状态、异步响应的设计原则。

以下是推荐的生产就绪型实现方案:

✅ 正确架构:表单提交 → 后端生成 → 临时存储 → 安全下载

from flask import Flask, request, render_template_string, send_from_directory from matplotlib.figure import Figure from matplotlib.backends.backend_pdf import PdfPages import os import tempfile import datetime  app = Flask(__name__)  # 配置 PDF 存储目录(使用 instance_path 更符合 Flask 最佳实践) PLOTS_DIR = os.path.join(app.instance_path, 'plots') os.makedirs(PLOTS_DIR, exist_ok=True)  def plotting_function(output_path: str, param1: str, param2: str):     """模拟你的绘图逻辑:生成多页 PDF 并写入 metadata"""     with PdfPages(output_path) as pdf:         # 示例:生成 3 个子图页         for i in range(1, 4):             fig = Figure(figsize=(8, 6))             ax = fig.subplots()             ax.plot([0, 1, 2, 3], [i, i+1, i-1, i*2], label=f'Plot {i}')             ax.set_title(f'Parameter: {param1}, Variant: {param2} — Page {i}')             ax.legend()             pdf.savefig(fig)             fig.clear()  # 释放内存          # 设置 PDF 元数据(可选但推荐)         info = pdf.infodict()         info['Title'] = f'Report for {param1}'         info['Author'] = 'Flask-PDF Generator'         info['Subject'] = 'Automated Plot Report'         info['Keywords'] = f'{param1} {param2} matplotlib pdf'         info['CreationDate'] = datetime.datetime.now()         info['ModDate'] = datetime.datetime.now()  @app.route('/', methods=['GET', 'POST']) def index():     if request.method == 'POST':         # ✅ 安全获取表单字段(非 input()!)         param1 = request.form.get('param1', '').strip()         param2 = request.form.get('param2', '').strip()          if not (param1 and param2):             return "⚠️ 参数不能为空,请返回重试", 400          # ✅ 使用临时目录确保线程安全 & 自动清理         with tempfile.TemporaryDirectory(dir=PLOTS_DIR) as tmpdir:             filename = f"plots_for_{param1.lower()}.pdf"             filepath = os.path.join(tmpdir, filename)              try:                 plotting_function(filepath, param1, param2)                 # ✅ 直接发送临时文件(Flask 自动处理流式响应)                 return send_from_directory(                     tmpdir,                     filename,                     as_attachment=True,                     download_name=filename  # Flask 2.1+ 推荐用 download_name 替代 deprecated as_attachment=True 的歧义                 )             except Exception as e:                 app.logger.error(f"PDF generation failed: {e}")                 return f"❌ 生成 PDF 失败:{e}", 500      # GET 请求:渲染 HTML 表单     return render_template_string(''' <!DOCTYPE html> <html> <head><title>PDF 报告生成器</title></head> <body>   <h2>配置参数并生成 PDF 报告</h2>   <form method="post">     <div style="margin: 1em 0;">       <label for="param1">参数 1(例如:实验组名):</label>       <input type="text" id="param1" name="param1" required />     </div>     <div style="margin: 1em 0;">       <label for="param2">参数 2(例如:时间范围):</label>       <input type="text" id="param2" name="param2" required />     </div>     <button type="submit" style="padding: 0.5em 1em;">生成 PDF</button>   </form> </body> </html>     ''')  # 可选:添加健康检查或静态文件服务路由 @app.route('/health') def health():     return {"status": "ok", "plots_dir": PLOTS_DIR}

? 关键要点说明

  • 禁止 input():Web 应用无法访问终端 stdin,input() 会挂起主线程并引发平台级异常(如 macOS 的 NSInternalInconsistencyException)。必须改用 HTML 表单 + HTTP POST。
  • 路径安全:send_from_directory 是唯一安全的文件响应方式,它自动校验路径防止目录遍历攻击(如 ../../../etc/passwd)。绝不可用 send_file(open(…)) 或拼接字符串路径
  • 临时文件管理:tempfile.TemporaryDirectory() 确保每次请求独立隔离,退出 with 块后自动删除,避免磁盘泄漏和并发冲突。
  • 错误处理:捕获 plotting_function 异常并返回 HTTP 错误码,便于前端调试;日志记录便于运维排查。
  • 元数据增强:为 PDF 添加 Title/Author 等信息,提升专业性与可追溯性。

? 运行前准备

  1. 创建 Flask 实例目录结构:
    mkdir -p instance/plots
  2. 安装依赖:
    pip install flask matplotlib
  3. 启动应用(开发环境):
    export FLASK_APP=app.py export FLASK_ENV=development flask run --host=127.0.0.1 --port=5000

    访问 http://127.0.0.1:5000 即可测试。

此方案兼顾安全性、可维护性与用户体验,是 Flask 动态 PDF 生成的标准实践。如需支持大文件流式传输或异步生成(Celery),可在本基础之上扩展。