【Python系列】接口下载json文件并指定文件名称

在 Web 开发中，提供文件下载功能是一种常见的需求，尤其是当涉及到导出数据为 JSON 格式时。为了确保文件名的自定义以及避免乱码问题，开发者需要采取一些特定的措施。

文件下载与乱码问题

在 Web 应用中，文件下载通常通过设置 HTTP 响应头中的Content-Disposition来实现。这个响应头告诉浏览器这是一个文件下载，而不是普通的页面内容。然而，如果文件名包含非 ASCII 字符，比如中文、日文或阿拉伯文等，直接设置文件名可能会导致乱码问题。这是因为 HTTP 头默认使用 ASCII 编码，对于非 ASCII 字符，需要进行适当的编码处理。

使用 Python 处理文件下载

在 Python 中，我们可以使用urllib.parse.quote函数来对文件名进行编码，这样可以确保文件名在 HTTP 头中正确传输。此外，为了支持多种浏览器，我们还可以设置filename*参数，使用 RFC 5987 标准来指定文件名的编码。

以下是一个示例代码，展示了如何使用 Python 生成一个带有自定义文件名的 JSON 文件下载响应：

import json
import urllib.parse
from flask import Response

def export_data_as_json(result):
    # 假设result是一个包含数据的字典
    data_ = result['data']
    orig_name = data_['orig_name']

    # 将数据转换为JSON格式的字符串
    json_data = json.dumps(data_)

    # 对原始文件名进行URL编码，避免URL注入攻击
    safe_filename = urllib.parse.quote(orig_name + ".json")

    # 设置HTTP响应头，指定文件名和编码
    headers = {
        "Content-Disposition": f'attachment; filename="{safe_filename}"; filename*=UTF-8\'{safe_filename}'
    }

    # 创建HTTP响应对象
    return Response(
        content=json_data,
        media_type="application/json",
        headers=headers
    )

分析代码实现

在上述代码中，我们首先从result字典中提取出需要导出的数据，并获取原始文件名。然后，我们使用json.dumps将数据转换为 JSON 格式的字符串。

接下来，我们使用urllib.parse.quote函数对原始文件名进行 URL 编码。这一步是必要的，因为它可以防止 URL 注入攻击，并且确保文件名中的特殊字符被正确处理。

在设置 HTTP 响应头时，我们使用了Content-Disposition头，并设置了attachment和filename参数。filename参数指定了文件的默认名称，而filename*参数则使用了 RFC 5987 标准来指定文件名的编码。这样，即使文件名包含非 ASCII 字符，浏览器也能正确解析和显示。

最后，我们创建了一个Response对象，并设置了内容、媒体类型和头部信息，然后返回这个响应对象。当这个响应被发送到客户端时，浏览器会提示用户下载文件，并且文件名会显示为用户自定义的名称，不会出现乱码。

为什么这种方法有效

这种方法有效，因为它遵循了 HTTP 和 Web 浏览器处理文件下载的标准。通过使用filename*参数，我们告诉浏览器文件名的编码方式，这样浏览器就能正确解码并显示文件名。同时，使用urllib.parse.quote函数确保了文件名的安全性和兼容性。