Flask 文件下载：如何优雅应对“文件未准备好”？

python

2024-07-21 11:45:20

Flask 文件下载：优雅地应对“文件未准备好”

在使用 Flask 构建文件下载服务时，我们常常会遇到文件需要一段时间才能准备好的情况。如果用户请求的文件还没准备好，直接返回 503 错误会损害用户体验。

理想情况下，我们希望在返回 503 错误的同时，告诉用户文件预计的等待时间，让他们稍后再试。这时，"Retry-After" 头信息就派上用场了。

解密 "Retry-After"

"Retry-After" 是 HTTP 协议中定义的一个响应头信息，用于告诉客户端应该在多久之后再次尝试请求。它可以接受两种格式的值：

HTTP 日期: 表示具体的日期和时间，例如 "Fri, 31 Dec 1999 23:59:59 GMT"。
秒数: 表示距离下次请求的秒数，例如 "300" 表示 5 分钟后重试。

Flask 中设置 "Retry-After"：两种姿势

在 Flask 中，我们可以通过两种方式设置 "Retry-After" 头信息：

return 语句中直接设置:

from flask import Flask, send_from_directory, Response
import datetime

app = Flask(__name__)

@app.route('/x/<string:file_name>')
def make_file(file_name):
    if creation_of_file(file_name) == 'success':
        return send_from_directory('files', file_name)
    else:
        return 'File not ready. Try again later', 503, {'Retry-After': 300}

这段代码中，我们通过在 return 语句中添加一个字典来设置响应头信息。字典的键值对分别对应头信息名称和值。

借助 flask.Response 对象:

from flask import Flask, send_from_directory, Response
import datetime

app = Flask(__name__)

@app.route('/x/<string:file_name>')
def make_file(file_name):
    if creation_of_file(file_name) == 'success':
        return send_from_directory('files', file_name)
    else:
        response = Response('File not ready. Try again later', 503)
        response.headers['Retry-After'] = 300
        return response

这里，我们先创建一个 flask.Response 对象，然后通过修改其 headers 属性来设置 "Retry-After" 头信息。

两种方法都能实现相同的功能，选择哪种取决于你的代码风格和个人偏好。

进阶技巧：动态计算等待时间

在实际应用中，文件准备时间可能不是固定的。我们可以根据具体情况动态计算等待时间，并将其设置到 "Retry-After" 头信息中。

例如，假设我们有一个异步任务队列，用于处理文件生成请求。我们可以通过查询任务队列获取预计完成时间，并将剩余时间作为 "Retry-After" 的值返回给客户端。

from flask import Flask, Response
from datetime import datetime, timedelta

app = Flask(__name__)

@app.route('/files/<task_id>')
def download_file(task_id):
    task = get_task_from_queue(task_id)
    
    if task.status == 'completed':
        return send_from_directory('files', task.filename)
    elif task.status == 'pending':
        estimated_completion = task.created_at + timedelta(seconds=task.estimated_duration)
        retry_after = int((estimated_completion - datetime.utcnow()).total_seconds())
        return 'File is being prepared. Please try again later.', 503, {'Retry-After': retry_after}
    else:
        return 'Task not found or failed.', 404